source: OGRE/trunk/ogrenew/Docs/manual/manual_23.html @ 692

Revision 692, 6.8 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<HTML>
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3<!-- Created on , 12 2006 by texi2html 1.64 -->
4<!--
5Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
6            Karl Berry  <karl@freefriends.org>
7            Olaf Bachmann <obachman@mathematik.uni-kl.de>
8            and many others.
9Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
10Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
11 
12-->
13<HEAD>
14<TITLE>OGRE Manual v1.2.0 ('Dagon'): Compositor Target Passes</TITLE>
15
16<META NAME="description" CONTENT="OGRE Manual v1.2.0 ('Dagon'): Compositor Target Passes">
17<META NAME="keywords" CONTENT="OGRE Manual v1.2.0 ('Dagon'): Compositor Target Passes">
18<META NAME="resource-type" CONTENT="document">
19<META NAME="distribution" CONTENT="global">
20<META NAME="Generator" CONTENT="texi2html 1.64">
21<LINK TYPE="text/css" rel="stylesheet" href="../style.css"> 
22</HEAD>
23
24<BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
25
26<A NAME="SEC117"></A>
27<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
28<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_22.html#SEC115"> &lt; </A>]</TD>
29<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC111"> Up </A>]</TD>
30<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_24.html#SEC124"> &gt; </A>]</TD>
31<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
32<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
33<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
34<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
35</TR></TABLE>
36<HR SIZE=1>
37<H3> 3.2.2 Target Passes </H3>
38<!--docid::SEC117::-->
39<P>
40
41A target pass is the action of rendering to a given target, either a render texture or the final output. You can update the same render texture multiple times by adding more than one target pass to your compositor script - this is very useful for 'ping pong' renders between a couple of render textures to perform complex convolutions that cannot be done in a single render, such as blurring.<BR><BR>
42</P><P>
43
44There are two types of target pass, the sort that updates a render texture:<BR><BR>
45Format: target &#60;Name&#62; { }<BR><BR>
46... and the sort that defines the final output render:<BR><BR>
47Format: target_output { }<BR><BR>
48</P><P>
49
50The contents of both are identical, the only real difference is that you can only have a single target_output entry, whilst you can have many target entries. Here are the attributes you can use in a 'target' or 'target_output' section of a .compositor script:
51</P><P>
52
53<UL>
54<LI>
55<A HREF="manual_23.html#compositor_target_input">input</A>
56<LI>
57<A HREF="manual_23.html#SEC120">only_initial</A>
58<LI>
59<A HREF="manual_23.html#SEC121">visibility_mask</A>
60<LI>
61<A HREF="manual_23.html#compositor_lod_bias">lod_bias</A>
62<LI>
63<A HREF="manual_23.html#SEC123">material_scheme</A>
64<LI>
65<A HREF="manual_24.html#SEC124">pass</A>
66</UL>
67<P>
68
69<A NAME="SEC118"></A>
70<H2> Attribute Descriptions   </H2>
71<!--docid::SEC118::-->
72<A NAME="compositor_target_input"></A>
73<A NAME="SEC119"></A>
74<H3> input </H3>
75<!--docid::SEC119::-->
76Sets input mode of the target, which tells the target pass what is pulled in before any of its own passes are rendered.<BR><BR>
77Format: input (none | previous)<BR><BR>
78Default: input none<BR><BR>
79<DL COMPACT>
80<DT>none
81<DD>The target will have nothing as input, all the contents of the target must be generated using its own passes. Note this does not mean the target will be empty, just no data will be pulled in. For it to truly be blank you'd need a 'clear' pass within this target.
82<DT>previous
83<DD>The target will pull in the previous contents of the viewport. This will be either the original scene if this is the first compositor in the chain, or it will be the output from the previous compositor in the chain if the viewport has multiple compositors enabled.
84</DL>
85<P>
86
87<A NAME="only_initial"></A>
88<A NAME="SEC120"></A>
89<H3> only_initial </H3>
90<!--docid::SEC120::-->
91If set to on, this target pass will only execute once initially after the effect has been enabled. This could be useful to perform once-off renders, after which the static contents are used by the rest of the compositor.<BR><BR>
92Format: only_initial (on | off)<BR><BR>
93Default: only_initial off<BR><BR>
94<P>
95
96<A NAME="visibility_mask"></A>
97<A NAME="SEC121"></A>
98<H3> visibility_mask </H3>
99<!--docid::SEC121::-->
100Sets the visibility mask for any render_scene passes performed in this target pass. This is a bitmask (although it must be specified as decimal, not hex) and maps to SceneManager::setVisibilityMask.
101Format: visibility_mask &#60;mask&#62;<BR><BR>
102Default: visibility_mask 4294967295<BR><BR>
103<P>
104
105<A NAME="compositor_lod_bias"></A>
106<A NAME="SEC122"></A>
107<H3> lod_bias </H3>
108<!--docid::SEC122::-->
109Set the scene LOD bias for any render_scene passes performed in this target pass. The default is 1.0, everything below that means lower quality, higher means higher quality.<BR><BR>
110Format: lod_bias &#60;lodbias&#62;<BR><BR>
111Default: lod_bias 1.0<BR><BR>
112<P>
113
114<A NAME="material_scheme"></A>
115<A NAME="SEC123"></A>
116<H3> material_scheme </H3>
117<!--docid::SEC123::-->
118Set the material scheme for any render_scene passes performed in this target pass. Material schemes allow you to select alternative rendering paths for all objects in the scene.<BR><BR>
119Format: material_scheme &#60;Name&#62;<BR><BR>
120Default: material_scheme Default<BR><BR>
121<P>
122
123<A NAME="Compositor Passes"></A>
124<HR SIZE=1>
125<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
126<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_22.html#SEC115"> &lt; </A>]</TD>
127<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_21.html#SEC111"> Up </A>]</TD>
128<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_24.html#SEC124"> &gt; </A>]</TD>
129<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
130<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
131<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
132<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
133</TR></TABLE>
134<BR> 
135<FONT SIZE="-1">
136This document was generated
137by <I>Steve Streeting</I> on <I>, 12 2006</I>
138using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
139"><I>texi2html</I></A>
140
141</BODY>
142</HTML>
Note: See TracBrowser for help on using the repository browser.