\hypertarget{class_ogre_1_1_composition_pass}{}\section{Ogre\+:\+:Composition\+Pass Class Reference}
\label{class_ogre_1_1_composition_pass}\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}


Object representing one pass or operation in a composition sequence.  




{\ttfamily \#include $<$Ogre\+Composition\+Pass.\+h$>$}



Inheritance diagram for Ogre\+:\+:Composition\+Pass\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=209pt]{class_ogre_1_1_composition_pass__inherit__graph}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{struct_ogre_1_1_composition_pass_1_1_input_tex}{Input\+Tex}
\begin{DoxyCompactList}\small\item\em Inputs (for material used for rendering the quad) \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}{Pass\+Type} \{ \newline
\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaaa7d4ed28ab9cdd43e85a715bd4e068fc}{P\+T\+\_\+\+C\+L\+E\+AR}, 
\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaa43301dad285fba17915d7867665597ab}{P\+T\+\_\+\+S\+T\+E\+N\+C\+IL}, 
\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaac8aa60611671e1b8867c1a30775ba84c}{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+S\+C\+E\+NE}, 
\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaa39b1d2658f5c73b04755e428316ea366}{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+Q\+U\+AD}, 
\newline
\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaaba93db3e2878858fe2fd199354c82af9}{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM}
 \}\begin{DoxyCompactList}\small\item\em Enumeration that enumerates the various composition pass types. \end{DoxyCompactList}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_composition_pass_a5b5540cb8dc10175dc30c3947032013c}{Composition\+Pass} (\hyperlink{class_ogre_1_1_composition_target_pass}{Composition\+Target\+Pass} $\ast$parent)
\item 
\hyperlink{class_ogre_1_1_composition_pass_ab8fc137845790b360d57056621cd1061}{$\sim$\+Composition\+Pass} ()
\item 
bool \hyperlink{class_ogre_1_1_composition_pass_ac0daef1d307ace963959896a3db64d75}{\+\_\+is\+Supported} (void)
\begin{DoxyCompactList}\small\item\em Determine if this target pass is supported on the current rendering device. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a05cbca68fbc408dbf755612cfb72707d}{clear\+All\+Inputs} ()
\begin{DoxyCompactList}\small\item\em Clear all inputs. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_ac4fae76a4f67e1ea70dc270be9b0daed}{get\+Automatic\+Colour} () const
\begin{DoxyCompactList}\small\item\em Retrieves if the clear colour is automatically setted to the background colour of the original viewport. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_composition_pass_a86b647f3dff3e2fc021302c23827b603}{get\+Clear\+Buffers} () const
\begin{DoxyCompactList}\small\item\em Get the viewport clear buffers. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \& \hyperlink{class_ogre_1_1_composition_pass_a548f5811f1b762b2a64257367f564378}{get\+Clear\+Colour} () const
\begin{DoxyCompactList}\small\item\em Get the viewport clear colour (defaults to 0,0,0,0) \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_composition_pass_a3c873101dd6bb94c9cea93fcc2a6e55b}{get\+Clear\+Depth} () const
\begin{DoxyCompactList}\small\item\em Get the viewport clear depth (defaults to 1.\+0) \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_composition_pass_adfa90e05d769083fe4823a6fff4177c0}{get\+Clear\+Stencil} () const
\begin{DoxyCompactList}\small\item\em Get the viewport clear stencil value (defaults to 0) \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_composition_pass_a3efae9c2f40f1f44a148497797c2f8f0}{get\+Custom\+Type} () const
\begin{DoxyCompactList}\small\item\em Get the type name of this custom composition pass. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} \hyperlink{class_ogre_1_1_composition_pass_ab7f667605829412a22d0cccd9c1d7e6c}{get\+First\+Render\+Queue} () const
\begin{DoxyCompactList}\small\item\em Get the first render queue to be rendered in this pass (inclusive) \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_composition_pass_ab60bfaaed2a48057ac8e8e7ead113f60}{get\+Identifier} () const
\begin{DoxyCompactList}\small\item\em Get the identifier for this pass. \end{DoxyCompactList}\item 
const \hyperlink{struct_ogre_1_1_composition_pass_1_1_input_tex}{Input\+Tex} \& \hyperlink{class_ogre_1_1_composition_pass_ae5884df0782f751715d36c0027912760}{get\+Input} (size\+\_\+t id) const
\begin{DoxyCompactList}\small\item\em Get the value of an input. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} \hyperlink{class_ogre_1_1_composition_pass_a1947a2e49e4c78d3fa806933690e6522}{get\+Last\+Render\+Queue} () const
\begin{DoxyCompactList}\small\item\em Get the last render queue to be rendered in this pass (inclusive) \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \& \hyperlink{class_ogre_1_1_composition_pass_a0367e89580ffd67000ce52676866fa43}{get\+Material} () const
\begin{DoxyCompactList}\small\item\em Get the material used by this pass. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_composition_pass_a822bb35bad3ba41e1370c08891428053}{get\+Material\+Scheme} (void) const
\begin{DoxyCompactList}\small\item\em Get the material scheme used by this pass. \end{DoxyCompactList}\item 
size\+\_\+t \hyperlink{class_ogre_1_1_composition_pass_a88aed71c3c005bea6be70c8d58db3232}{get\+Num\+Inputs} () const
\begin{DoxyCompactList}\small\item\em Get the number of inputs used. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_composition_target_pass}{Composition\+Target\+Pass} $\ast$ \hyperlink{class_ogre_1_1_composition_pass_a5815c0e9e598fe58d2c7f76be9167976}{get\+Parent} ()
\begin{DoxyCompactList}\small\item\em Get parent object. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_a0a8e642c52e2b7db79765f93b1cf5730}{get\+Quad\+Corners} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&left, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&top, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&right, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&bottom) const
\begin{DoxyCompactList}\small\item\em Get quad normalised positions \mbox{[}-\/1;1\mbox{]}x\mbox{[}-\/1;1\mbox{]}. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_ae350fcee79e006e23d6de413253568e5}{get\+Quad\+Far\+Corners} () const
\begin{DoxyCompactList}\small\item\em Returns true if camera frustum far corners are provided in the quad. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_a88bc728d5e0497ce4c5dbc052239551d}{get\+Quad\+Far\+Corners\+View\+Space} () const
\begin{DoxyCompactList}\small\item\em Returns true if the far corners provided in the quad are in view space. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_a31e5b47326f6357b7172faca282cb3ea}{get\+Stencil\+Check} () const
\begin{DoxyCompactList}\small\item\em Get stencil check enable. \end{DoxyCompactList}\item 
\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} \hyperlink{class_ogre_1_1_composition_pass_adcd852af123434d7ff154a2569121d27}{get\+Stencil\+Depth\+Fail\+Op} () const
\begin{DoxyCompactList}\small\item\em Get stencil depth fail operation. \end{DoxyCompactList}\item 
\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} \hyperlink{class_ogre_1_1_composition_pass_a354620f0bec90c923b57707019195483}{get\+Stencil\+Fail\+Op} () const
\begin{DoxyCompactList}\small\item\em Get stencil fail operation. \end{DoxyCompactList}\item 
\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function} \hyperlink{class_ogre_1_1_composition_pass_a14fcb5fbfd45871dca725c88de5a83a5}{get\+Stencil\+Func} () const
\begin{DoxyCompactList}\small\item\em Get stencil compare function. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_composition_pass_af347ecd30bdb07219cb1794599b30ec7}{get\+Stencil\+Mask} () const
\begin{DoxyCompactList}\small\item\em Get stencil mask. \end{DoxyCompactList}\item 
\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} \hyperlink{class_ogre_1_1_composition_pass_a6e14a28e603b902ee0794f78912f329f}{get\+Stencil\+Pass\+Op} () const
\begin{DoxyCompactList}\small\item\em Get stencil pass operation. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_ad3b550fd01154eddeaf8cbc7459c75f9}{get\+Stencil\+Read\+Back\+As\+Texture\+Operation} () const
\begin{DoxyCompactList}\small\item\em Get read back stencil-\/depth buffer. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_composition_pass_a2fd6b67d996e8a9c9a7b8443490e997e}{get\+Stencil\+Ref\+Value} () const
\begin{DoxyCompactList}\small\item\em Get stencil reference value. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_composition_pass_a45657514c52a86f22d9d575fa248de0a}{get\+Stencil\+Two\+Sided\+Operation} () const
\begin{DoxyCompactList}\small\item\em Get two sided stencil operation. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}{Pass\+Type} \hyperlink{class_ogre_1_1_composition_pass_a6a51eff0938089a5fc26c1bec5c3778f}{get\+Type} () const
\begin{DoxyCompactList}\small\item\em Get the type of composition pass. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_ad72002d4220edc51b6ac40bbd811cbee}{set\+Automatic\+Colour} (bool val)
\begin{DoxyCompactList}\small\item\em Set the clear colour to be the background colour of the original viewport. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a92187a460af36b8ebe0828cf6d81c277}{set\+Clear\+Buffers} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} val)
\begin{DoxyCompactList}\small\item\em Would be nice to have for R\+E\+N\+D\+E\+R\+S\+C\+E\+NE\+: flags to\+: exclude transparents override material (at least -- color) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a749020e95d4cd6d908983d042b86e429}{set\+Clear\+Colour} (const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&val)
\begin{DoxyCompactList}\small\item\em Set the viewport clear colour (defaults to 0,0,0,0) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a1f0e9945281c6551ab0f21a129270339}{set\+Clear\+Depth} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} depth)
\begin{DoxyCompactList}\small\item\em Set the viewport clear depth (defaults to 1.\+0) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_ad75218db6dbe9993b5486c9c916efc0c}{set\+Clear\+Stencil} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} value)
\begin{DoxyCompactList}\small\item\em Set the viewport clear stencil value (defaults to 0) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a0937b1f59f584797d44383eeb44b30eb}{set\+Custom\+Type} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&custom\+Type)
\begin{DoxyCompactList}\small\item\em Set the type name of this custom composition pass. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a4af9e5a958c5ec3a69f8bd797d4c2563}{set\+First\+Render\+Queue} (\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} id)
\begin{DoxyCompactList}\small\item\em Set the first render queue to be rendered in this pass (inclusive) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a56bb1d899a43195712944398e2d1bc65}{set\+Identifier} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} id)
\begin{DoxyCompactList}\small\item\em Set an identifier for this pass. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_afa546e1e7d46879c3dc6ce5dff470d4d}{set\+Input} (size\+\_\+t id, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&input=\hyperlink{group___general_gad842a4b416bd2f3245d2b44826a0aedc}{B\+L\+A\+N\+K\+S\+T\+R\+I\+NG}, size\+\_\+t mrt\+Index=0)
\begin{DoxyCompactList}\small\item\em Set an input local texture. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a193d54ee08e19d538576ca300c30c006}{set\+Last\+Render\+Queue} (\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} id)
\begin{DoxyCompactList}\small\item\em Set the last render queue to be rendered in this pass (inclusive) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a21721f49c3b10e36560adff1e563740f}{set\+Material} (const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \&mat)
\begin{DoxyCompactList}\small\item\em Set the material used by this pass. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a453231b980fc04dd9af9f330feec5236}{set\+Material\+Name} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name)
\begin{DoxyCompactList}\small\item\em Set the material used by this pass. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_afdc03ddab7dba7ca065345a0ab5351fd}{set\+Material\+Scheme} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&scheme\+Name)
\begin{DoxyCompactList}\small\item\em Set the material scheme used by this pass. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a186b5a3bcb90a3ce1d66f97424cd339c}{set\+Quad\+Corners} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} top, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} right, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} bottom)
\begin{DoxyCompactList}\small\item\em Set quad normalised positions \mbox{[}-\/1;1\mbox{]}x\mbox{[}-\/1;1\mbox{]}. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_ac2831cd42c94887f6e239d1460dc6b5c}{set\+Quad\+Far\+Corners} (bool far\+Corners, bool far\+Corners\+View\+Space)
\begin{DoxyCompactList}\small\item\em Sets the use of camera frustum far corners provided in the quad\textquotesingle{}s normals. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_af0f6a55176e7c69fda820a5d22a50104}{set\+Stencil\+Check} (bool value)
\begin{DoxyCompactList}\small\item\em Set stencil check on or off. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_ae3c196d705b7bf120e0d888b4867dda4}{set\+Stencil\+Depth\+Fail\+Op} (\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} value)
\begin{DoxyCompactList}\small\item\em Set stencil depth fail operation. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_ad7afd96369d5093b5eb2123f2befed58}{set\+Stencil\+Fail\+Op} (\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} value)
\begin{DoxyCompactList}\small\item\em Set stencil fail operation. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a7d60b3d8f6e47891d8e5373bea31d5bd}{set\+Stencil\+Func} (\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function} value)
\begin{DoxyCompactList}\small\item\em Set stencil compare function. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a052e16876215e11e03bcba8657faf917}{set\+Stencil\+Mask} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} value)
\begin{DoxyCompactList}\small\item\em Set stencil mask. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_aff4417885952905fc8230cef47a36756}{set\+Stencil\+Pass\+Op} (\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} value)
\begin{DoxyCompactList}\small\item\em Set stencil pass operation. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a4eb731c1f04905fee30f0317815963f6}{set\+Stencil\+Read\+Back\+As\+Texture\+Operation} (bool value)
\begin{DoxyCompactList}\small\item\em Set read back stencil-\/depth buffer as texture operation. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a1b8cc0c3221bfbc751328cda98c8aff7}{set\+Stencil\+Ref\+Value} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} value)
\begin{DoxyCompactList}\small\item\em Set stencil reference value. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_afa3d6c2f5f8e6ba85b7844d2bf433a5f}{set\+Stencil\+Two\+Sided\+Operation} (bool value)
\begin{DoxyCompactList}\small\item\em Set two sided stencil operation. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_composition_pass_a8b0e3dcfccbdcc9672a96ae6dc2c0123}{set\+Type} (\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}{Pass\+Type} type)
\begin{DoxyCompactList}\small\item\em Set the type of composition pass. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Object representing one pass or operation in a composition sequence. 

This provides a method to conveniently interleave \hyperlink{class_ogre_1_1_render_system}{Render\+System} commands between Render Queues. 

\subsection{Member Enumeration Documentation}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}\label{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!Pass\+Type@{Pass\+Type}}
\index{Pass\+Type@{Pass\+Type}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{Pass\+Type}{PassType}}
{\footnotesize\ttfamily enum \hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}{Ogre\+::\+Composition\+Pass\+::\+Pass\+Type}}



Enumeration that enumerates the various composition pass types. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{P\+T\+\_\+\+C\+L\+E\+AR@{P\+T\+\_\+\+C\+L\+E\+AR}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!P\+T\+\_\+\+C\+L\+E\+AR@{P\+T\+\_\+\+C\+L\+E\+AR}}}\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaaa7d4ed28ab9cdd43e85a715bd4e068fc}\label{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaaa7d4ed28ab9cdd43e85a715bd4e068fc}} 
P\+T\+\_\+\+C\+L\+E\+AR&\\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{P\+T\+\_\+\+S\+T\+E\+N\+C\+IL@{P\+T\+\_\+\+S\+T\+E\+N\+C\+IL}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!P\+T\+\_\+\+S\+T\+E\+N\+C\+IL@{P\+T\+\_\+\+S\+T\+E\+N\+C\+IL}}}\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaa43301dad285fba17915d7867665597ab}\label{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaa43301dad285fba17915d7867665597ab}} 
P\+T\+\_\+\+S\+T\+E\+N\+C\+IL&Clear target to one colour. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+S\+C\+E\+NE@{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+S\+C\+E\+NE}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+S\+C\+E\+NE@{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+S\+C\+E\+NE}}}\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaac8aa60611671e1b8867c1a30775ba84c}\label{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaac8aa60611671e1b8867c1a30775ba84c}} 
P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+S\+C\+E\+NE&Set stencil operation. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+Q\+U\+AD@{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+Q\+U\+AD}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+Q\+U\+AD@{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+Q\+U\+AD}}}\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaa39b1d2658f5c73b04755e428316ea366}\label{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaa39b1d2658f5c73b04755e428316ea366}} 
P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+Q\+U\+AD&Render the scene or part of it. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM@{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM@{P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM}}}\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaaba93db3e2878858fe2fd199354c82af9}\label{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aaaba93db3e2878858fe2fd199354c82af9}} 
P\+T\+\_\+\+R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM&Render a full screen quad. Render a custom sequence \\
\hline

\end{DoxyEnumFields}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a5b5540cb8dc10175dc30c3947032013c}\label{class_ogre_1_1_composition_pass_a5b5540cb8dc10175dc30c3947032013c}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!Composition\+Pass@{Composition\+Pass}}
\index{Composition\+Pass@{Composition\+Pass}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{Composition\+Pass()}{CompositionPass()}}
{\footnotesize\ttfamily Ogre\+::\+Composition\+Pass\+::\+Composition\+Pass (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_composition_target_pass}{Composition\+Target\+Pass} $\ast$}]{parent }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ab8fc137845790b360d57056621cd1061}\label{class_ogre_1_1_composition_pass_ab8fc137845790b360d57056621cd1061}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!````~Composition\+Pass@{$\sim$\+Composition\+Pass}}
\index{````~Composition\+Pass@{$\sim$\+Composition\+Pass}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{$\sim$\+Composition\+Pass()}{~CompositionPass()}}
{\footnotesize\ttfamily Ogre\+::\+Composition\+Pass\+::$\sim$\+Composition\+Pass (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a8b0e3dcfccbdcc9672a96ae6dc2c0123}\label{class_ogre_1_1_composition_pass_a8b0e3dcfccbdcc9672a96ae6dc2c0123}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Type@{set\+Type}}
\index{set\+Type@{set\+Type}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Type()}{setType()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Type (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}{Pass\+Type}}]{type }\end{DoxyParamCaption})}



Set the type of composition pass. 

\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a6a51eff0938089a5fc26c1bec5c3778f}\label{class_ogre_1_1_composition_pass_a6a51eff0938089a5fc26c1bec5c3778f}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Type@{get\+Type}}
\index{get\+Type@{get\+Type}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Type()}{getType()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_composition_pass_aa20bff864069127a799a3593df0146aa}{Pass\+Type} Ogre\+::\+Composition\+Pass\+::get\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the type of composition pass. 

\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a56bb1d899a43195712944398e2d1bc65}\label{class_ogre_1_1_composition_pass_a56bb1d899a43195712944398e2d1bc65}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Identifier@{set\+Identifier}}
\index{set\+Identifier@{set\+Identifier}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Identifier()}{setIdentifier()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Identifier (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{id }\end{DoxyParamCaption})}



Set an identifier for this pass. 

This identifier can be used to \char`\"{}listen in\char`\"{} on this pass with an \hyperlink{class_ogre_1_1_compositor_instance_1_1_listener}{Compositor\+Instance\+::\+Listener}. \mbox{\Hypertarget{class_ogre_1_1_composition_pass_ab60bfaaed2a48057ac8e8e7ead113f60}\label{class_ogre_1_1_composition_pass_ab60bfaaed2a48057ac8e8e7ead113f60}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Identifier@{get\+Identifier}}
\index{get\+Identifier@{get\+Identifier}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Identifier()}{getIdentifier()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Composition\+Pass\+::get\+Identifier (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the identifier for this pass. 

\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a21721f49c3b10e36560adff1e563740f}\label{class_ogre_1_1_composition_pass_a21721f49c3b10e36560adff1e563740f}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Material@{set\+Material}}
\index{set\+Material@{set\+Material}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Material()}{setMaterial()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Material (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \&}]{mat }\end{DoxyParamCaption})}



Set the material used by this pass. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a453231b980fc04dd9af9f330feec5236}\label{class_ogre_1_1_composition_pass_a453231b980fc04dd9af9f330feec5236}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Material\+Name@{set\+Material\+Name}}
\index{set\+Material\+Name@{set\+Material\+Name}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Material\+Name()}{setMaterialName()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Material\+Name (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption})}



Set the material used by this pass. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a0367e89580ffd67000ce52676866fa43}\label{class_ogre_1_1_composition_pass_a0367e89580ffd67000ce52676866fa43}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Material@{get\+Material}}
\index{get\+Material@{get\+Material}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Material()}{getMaterial()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}\& Ogre\+::\+Composition\+Pass\+::get\+Material (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the material used by this pass. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a4af9e5a958c5ec3a69f8bd797d4c2563}\label{class_ogre_1_1_composition_pass_a4af9e5a958c5ec3a69f8bd797d4c2563}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+First\+Render\+Queue@{set\+First\+Render\+Queue}}
\index{set\+First\+Render\+Queue@{set\+First\+Render\+Queue}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+First\+Render\+Queue()}{setFirstRenderQueue()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+First\+Render\+Queue (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}}]{id }\end{DoxyParamCaption})}



Set the first render queue to be rendered in this pass (inclusive) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+S\+C\+E\+NE 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ab7f667605829412a22d0cccd9c1d7e6c}\label{class_ogre_1_1_composition_pass_ab7f667605829412a22d0cccd9c1d7e6c}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+First\+Render\+Queue@{get\+First\+Render\+Queue}}
\index{get\+First\+Render\+Queue@{get\+First\+Render\+Queue}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+First\+Render\+Queue()}{getFirstRenderQueue()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} Ogre\+::\+Composition\+Pass\+::get\+First\+Render\+Queue (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the first render queue to be rendered in this pass (inclusive) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+S\+C\+E\+NE 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a193d54ee08e19d538576ca300c30c006}\label{class_ogre_1_1_composition_pass_a193d54ee08e19d538576ca300c30c006}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Last\+Render\+Queue@{set\+Last\+Render\+Queue}}
\index{set\+Last\+Render\+Queue@{set\+Last\+Render\+Queue}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Last\+Render\+Queue()}{setLastRenderQueue()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Last\+Render\+Queue (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8}}]{id }\end{DoxyParamCaption})}



Set the last render queue to be rendered in this pass (inclusive) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+S\+C\+E\+NE 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a1947a2e49e4c78d3fa806933690e6522}\label{class_ogre_1_1_composition_pass_a1947a2e49e4c78d3fa806933690e6522}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Last\+Render\+Queue@{get\+Last\+Render\+Queue}}
\index{get\+Last\+Render\+Queue@{get\+Last\+Render\+Queue}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Last\+Render\+Queue()}{getLastRenderQueue()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_a119732ea9d1e88bbddc47b4ac0fa21cb}{uint8} Ogre\+::\+Composition\+Pass\+::get\+Last\+Render\+Queue (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the last render queue to be rendered in this pass (inclusive) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+S\+C\+E\+NE 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_afdc03ddab7dba7ca065345a0ab5351fd}\label{class_ogre_1_1_composition_pass_afdc03ddab7dba7ca065345a0ab5351fd}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Material\+Scheme@{set\+Material\+Scheme}}
\index{set\+Material\+Scheme@{set\+Material\+Scheme}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Material\+Scheme()}{setMaterialScheme()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Material\+Scheme (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{scheme\+Name }\end{DoxyParamCaption})}



Set the material scheme used by this pass. 

\begin{DoxyRemark}{Remarks}
Only applicable to passes that render the scene. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
Technique\+::set\+Scheme. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a822bb35bad3ba41e1370c08891428053}\label{class_ogre_1_1_composition_pass_a822bb35bad3ba41e1370c08891428053}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Material\+Scheme@{get\+Material\+Scheme}}
\index{get\+Material\+Scheme@{get\+Material\+Scheme}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Material\+Scheme()}{getMaterialScheme()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Composition\+Pass\+::get\+Material\+Scheme (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Get the material scheme used by this pass. 

\begin{DoxyRemark}{Remarks}
Only applicable to passes that render the scene. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
Technique\+::set\+Scheme. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a92187a460af36b8ebe0828cf6d81c277}\label{class_ogre_1_1_composition_pass_a92187a460af36b8ebe0828cf6d81c277}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Clear\+Buffers@{set\+Clear\+Buffers}}
\index{set\+Clear\+Buffers@{set\+Clear\+Buffers}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Clear\+Buffers()}{setClearBuffers()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Clear\+Buffers (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{val }\end{DoxyParamCaption})}



Would be nice to have for R\+E\+N\+D\+E\+R\+S\+C\+E\+NE\+: flags to\+: exclude transparents override material (at least -- color) 

Set the viewport clear buffers (defaults to F\+B\+T\+\_\+\+C\+O\+L\+O\+U\+R$\vert$\+F\+B\+T\+\_\+\+D\+E\+P\+TH) 
\begin{DoxyParams}{Parameters}
{\em val} & is a combination of F\+B\+T\+\_\+\+C\+O\+L\+O\+UR, F\+B\+T\+\_\+\+D\+E\+P\+TH, F\+B\+T\+\_\+\+S\+T\+E\+N\+C\+IL. \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a86b647f3dff3e2fc021302c23827b603}\label{class_ogre_1_1_composition_pass_a86b647f3dff3e2fc021302c23827b603}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Clear\+Buffers@{get\+Clear\+Buffers}}
\index{get\+Clear\+Buffers@{get\+Clear\+Buffers}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Clear\+Buffers()}{getClearBuffers()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Composition\+Pass\+::get\+Clear\+Buffers (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the viewport clear buffers. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a749020e95d4cd6d908983d042b86e429}\label{class_ogre_1_1_composition_pass_a749020e95d4cd6d908983d042b86e429}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Clear\+Colour@{set\+Clear\+Colour}}
\index{set\+Clear\+Colour@{set\+Clear\+Colour}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Clear\+Colour()}{setClearColour()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Clear\+Colour (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&}]{val }\end{DoxyParamCaption})}



Set the viewport clear colour (defaults to 0,0,0,0) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a548f5811f1b762b2a64257367f564378}\label{class_ogre_1_1_composition_pass_a548f5811f1b762b2a64257367f564378}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Clear\+Colour@{get\+Clear\+Colour}}
\index{get\+Clear\+Colour@{get\+Clear\+Colour}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Clear\+Colour()}{getClearColour()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}\& Ogre\+::\+Composition\+Pass\+::get\+Clear\+Colour (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the viewport clear colour (defaults to 0,0,0,0) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ad72002d4220edc51b6ac40bbd811cbee}\label{class_ogre_1_1_composition_pass_ad72002d4220edc51b6ac40bbd811cbee}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Automatic\+Colour@{set\+Automatic\+Colour}}
\index{set\+Automatic\+Colour@{set\+Automatic\+Colour}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Automatic\+Colour()}{setAutomaticColour()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Automatic\+Colour (\begin{DoxyParamCaption}\item[{bool}]{val }\end{DoxyParamCaption})}



Set the clear colour to be the background colour of the original viewport. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ac4fae76a4f67e1ea70dc270be9b0daed}\label{class_ogre_1_1_composition_pass_ac4fae76a4f67e1ea70dc270be9b0daed}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Automatic\+Colour@{get\+Automatic\+Colour}}
\index{get\+Automatic\+Colour@{get\+Automatic\+Colour}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Automatic\+Colour()}{getAutomaticColour()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Automatic\+Colour (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Retrieves if the clear colour is automatically setted to the background colour of the original viewport. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a1f0e9945281c6551ab0f21a129270339}\label{class_ogre_1_1_composition_pass_a1f0e9945281c6551ab0f21a129270339}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Clear\+Depth@{set\+Clear\+Depth}}
\index{set\+Clear\+Depth@{set\+Clear\+Depth}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Clear\+Depth()}{setClearDepth()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Clear\+Depth (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{depth }\end{DoxyParamCaption})}



Set the viewport clear depth (defaults to 1.\+0) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a3c873101dd6bb94c9cea93fcc2a6e55b}\label{class_ogre_1_1_composition_pass_a3c873101dd6bb94c9cea93fcc2a6e55b}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Clear\+Depth@{get\+Clear\+Depth}}
\index{get\+Clear\+Depth@{get\+Clear\+Depth}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Clear\+Depth()}{getClearDepth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Composition\+Pass\+::get\+Clear\+Depth (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the viewport clear depth (defaults to 1.\+0) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ad75218db6dbe9993b5486c9c916efc0c}\label{class_ogre_1_1_composition_pass_ad75218db6dbe9993b5486c9c916efc0c}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Clear\+Stencil@{set\+Clear\+Stencil}}
\index{set\+Clear\+Stencil@{set\+Clear\+Stencil}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Clear\+Stencil()}{setClearStencil()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Clear\+Stencil (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{value }\end{DoxyParamCaption})}



Set the viewport clear stencil value (defaults to 0) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_adfa90e05d769083fe4823a6fff4177c0}\label{class_ogre_1_1_composition_pass_adfa90e05d769083fe4823a6fff4177c0}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Clear\+Stencil@{get\+Clear\+Stencil}}
\index{get\+Clear\+Stencil@{get\+Clear\+Stencil}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Clear\+Stencil()}{getClearStencil()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Composition\+Pass\+::get\+Clear\+Stencil (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the viewport clear stencil value (defaults to 0) 

\begin{DoxyNote}{Note}
applies when Pass\+Type is C\+L\+E\+AR 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_af0f6a55176e7c69fda820a5d22a50104}\label{class_ogre_1_1_composition_pass_af0f6a55176e7c69fda820a5d22a50104}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Check@{set\+Stencil\+Check}}
\index{set\+Stencil\+Check@{set\+Stencil\+Check}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Check()}{setStencilCheck()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Check (\begin{DoxyParamCaption}\item[{bool}]{value }\end{DoxyParamCaption})}



Set stencil check on or off. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a31e5b47326f6357b7172faca282cb3ea}\label{class_ogre_1_1_composition_pass_a31e5b47326f6357b7172faca282cb3ea}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Check@{get\+Stencil\+Check}}
\index{get\+Stencil\+Check@{get\+Stencil\+Check}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Check()}{getStencilCheck()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Check (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil check enable. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a7d60b3d8f6e47891d8e5373bea31d5bd}\label{class_ogre_1_1_composition_pass_a7d60b3d8f6e47891d8e5373bea31d5bd}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Func@{set\+Stencil\+Func}}
\index{set\+Stencil\+Func@{set\+Stencil\+Func}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Func()}{setStencilFunc()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Func (\begin{DoxyParamCaption}\item[{\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function}}]{value }\end{DoxyParamCaption})}



Set stencil compare function. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a14fcb5fbfd45871dca725c88de5a83a5}\label{class_ogre_1_1_composition_pass_a14fcb5fbfd45871dca725c88de5a83a5}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Func@{get\+Stencil\+Func}}
\index{get\+Stencil\+Func@{get\+Stencil\+Func}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Func()}{getStencilFunc()}}
{\footnotesize\ttfamily \hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function} Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Func (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil compare function. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a1b8cc0c3221bfbc751328cda98c8aff7}\label{class_ogre_1_1_composition_pass_a1b8cc0c3221bfbc751328cda98c8aff7}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Ref\+Value@{set\+Stencil\+Ref\+Value}}
\index{set\+Stencil\+Ref\+Value@{set\+Stencil\+Ref\+Value}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Ref\+Value()}{setStencilRefValue()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Ref\+Value (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{value }\end{DoxyParamCaption})}



Set stencil reference value. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a2fd6b67d996e8a9c9a7b8443490e997e}\label{class_ogre_1_1_composition_pass_a2fd6b67d996e8a9c9a7b8443490e997e}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Ref\+Value@{get\+Stencil\+Ref\+Value}}
\index{get\+Stencil\+Ref\+Value@{get\+Stencil\+Ref\+Value}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Ref\+Value()}{getStencilRefValue()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Ref\+Value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil reference value. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a052e16876215e11e03bcba8657faf917}\label{class_ogre_1_1_composition_pass_a052e16876215e11e03bcba8657faf917}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Mask@{set\+Stencil\+Mask}}
\index{set\+Stencil\+Mask@{set\+Stencil\+Mask}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Mask()}{setStencilMask()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Mask (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{value }\end{DoxyParamCaption})}



Set stencil mask. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_af347ecd30bdb07219cb1794599b30ec7}\label{class_ogre_1_1_composition_pass_af347ecd30bdb07219cb1794599b30ec7}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Mask@{get\+Stencil\+Mask}}
\index{get\+Stencil\+Mask@{get\+Stencil\+Mask}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Mask()}{getStencilMask()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Mask (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil mask. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ad7afd96369d5093b5eb2123f2befed58}\label{class_ogre_1_1_composition_pass_ad7afd96369d5093b5eb2123f2befed58}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Fail\+Op@{set\+Stencil\+Fail\+Op}}
\index{set\+Stencil\+Fail\+Op@{set\+Stencil\+Fail\+Op}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Fail\+Op()}{setStencilFailOp()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Fail\+Op (\begin{DoxyParamCaption}\item[{\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation}}]{value }\end{DoxyParamCaption})}



Set stencil fail operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a354620f0bec90c923b57707019195483}\label{class_ogre_1_1_composition_pass_a354620f0bec90c923b57707019195483}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Fail\+Op@{get\+Stencil\+Fail\+Op}}
\index{get\+Stencil\+Fail\+Op@{get\+Stencil\+Fail\+Op}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Fail\+Op()}{getStencilFailOp()}}
{\footnotesize\ttfamily \hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Fail\+Op (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil fail operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ae3c196d705b7bf120e0d888b4867dda4}\label{class_ogre_1_1_composition_pass_ae3c196d705b7bf120e0d888b4867dda4}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Depth\+Fail\+Op@{set\+Stencil\+Depth\+Fail\+Op}}
\index{set\+Stencil\+Depth\+Fail\+Op@{set\+Stencil\+Depth\+Fail\+Op}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Depth\+Fail\+Op()}{setStencilDepthFailOp()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Depth\+Fail\+Op (\begin{DoxyParamCaption}\item[{\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation}}]{value }\end{DoxyParamCaption})}



Set stencil depth fail operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_adcd852af123434d7ff154a2569121d27}\label{class_ogre_1_1_composition_pass_adcd852af123434d7ff154a2569121d27}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Depth\+Fail\+Op@{get\+Stencil\+Depth\+Fail\+Op}}
\index{get\+Stencil\+Depth\+Fail\+Op@{get\+Stencil\+Depth\+Fail\+Op}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Depth\+Fail\+Op()}{getStencilDepthFailOp()}}
{\footnotesize\ttfamily \hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Depth\+Fail\+Op (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil depth fail operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_aff4417885952905fc8230cef47a36756}\label{class_ogre_1_1_composition_pass_aff4417885952905fc8230cef47a36756}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Pass\+Op@{set\+Stencil\+Pass\+Op}}
\index{set\+Stencil\+Pass\+Op@{set\+Stencil\+Pass\+Op}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Pass\+Op()}{setStencilPassOp()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Pass\+Op (\begin{DoxyParamCaption}\item[{\hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation}}]{value }\end{DoxyParamCaption})}



Set stencil pass operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a6e14a28e603b902ee0794f78912f329f}\label{class_ogre_1_1_composition_pass_a6e14a28e603b902ee0794f78912f329f}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Pass\+Op@{get\+Stencil\+Pass\+Op}}
\index{get\+Stencil\+Pass\+Op@{get\+Stencil\+Pass\+Op}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Pass\+Op()}{getStencilPassOp()}}
{\footnotesize\ttfamily \hyperlink{group___render_system_gae8bb1cb809660de802d1d592ba4adb61}{Stencil\+Operation} Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Pass\+Op (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get stencil pass operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_afa3d6c2f5f8e6ba85b7844d2bf433a5f}\label{class_ogre_1_1_composition_pass_afa3d6c2f5f8e6ba85b7844d2bf433a5f}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Two\+Sided\+Operation@{set\+Stencil\+Two\+Sided\+Operation}}
\index{set\+Stencil\+Two\+Sided\+Operation@{set\+Stencil\+Two\+Sided\+Operation}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Two\+Sided\+Operation()}{setStencilTwoSidedOperation()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Two\+Sided\+Operation (\begin{DoxyParamCaption}\item[{bool}]{value }\end{DoxyParamCaption})}



Set two sided stencil operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a45657514c52a86f22d9d575fa248de0a}\label{class_ogre_1_1_composition_pass_a45657514c52a86f22d9d575fa248de0a}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Two\+Sided\+Operation@{get\+Stencil\+Two\+Sided\+Operation}}
\index{get\+Stencil\+Two\+Sided\+Operation@{get\+Stencil\+Two\+Sided\+Operation}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Two\+Sided\+Operation()}{getStencilTwoSidedOperation()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Two\+Sided\+Operation (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get two sided stencil operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a4eb731c1f04905fee30f0317815963f6}\label{class_ogre_1_1_composition_pass_a4eb731c1f04905fee30f0317815963f6}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Stencil\+Read\+Back\+As\+Texture\+Operation@{set\+Stencil\+Read\+Back\+As\+Texture\+Operation}}
\index{set\+Stencil\+Read\+Back\+As\+Texture\+Operation@{set\+Stencil\+Read\+Back\+As\+Texture\+Operation}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Stencil\+Read\+Back\+As\+Texture\+Operation()}{setStencilReadBackAsTextureOperation()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Stencil\+Read\+Back\+As\+Texture\+Operation (\begin{DoxyParamCaption}\item[{bool}]{value }\end{DoxyParamCaption})}



Set read back stencil-\/depth buffer as texture operation. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ad3b550fd01154eddeaf8cbc7459c75f9}\label{class_ogre_1_1_composition_pass_ad3b550fd01154eddeaf8cbc7459c75f9}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Stencil\+Read\+Back\+As\+Texture\+Operation@{get\+Stencil\+Read\+Back\+As\+Texture\+Operation}}
\index{get\+Stencil\+Read\+Back\+As\+Texture\+Operation@{get\+Stencil\+Read\+Back\+As\+Texture\+Operation}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Stencil\+Read\+Back\+As\+Texture\+Operation()}{getStencilReadBackAsTextureOperation()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Stencil\+Read\+Back\+As\+Texture\+Operation (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get read back stencil-\/depth buffer. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is S\+T\+E\+N\+C\+IL 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_afa546e1e7d46879c3dc6ce5dff470d4d}\label{class_ogre_1_1_composition_pass_afa546e1e7d46879c3dc6ce5dff470d4d}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Input@{set\+Input}}
\index{set\+Input@{set\+Input}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Input()}{setInput()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Input (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{id,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{input = {\ttfamily \hyperlink{group___general_gad842a4b416bd2f3245d2b44826a0aedc}{B\+L\+A\+N\+K\+S\+T\+R\+I\+NG}},  }\item[{size\+\_\+t}]{mrt\+Index = {\ttfamily 0} }\end{DoxyParamCaption})}



Set an input local texture. 

An empty string clears the input. 
\begin{DoxyParams}{Parameters}
{\em id} & Input to set. Must be in 0..O\+G\+R\+E\+\_\+\+M\+A\+X\+\_\+\+T\+E\+X\+T\+U\+R\+E\+\_\+\+L\+A\+Y\+E\+R\+S-\/1 \\
\hline
{\em input} & Which texture to bind to this input. An empty string clears the input. \\
\hline
{\em mrt\+Index} & Which surface of an M\+RT to retrieve \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ae5884df0782f751715d36c0027912760}\label{class_ogre_1_1_composition_pass_ae5884df0782f751715d36c0027912760}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Input@{get\+Input}}
\index{get\+Input@{get\+Input}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Input()}{getInput()}}
{\footnotesize\ttfamily const \hyperlink{struct_ogre_1_1_composition_pass_1_1_input_tex}{Input\+Tex}\& Ogre\+::\+Composition\+Pass\+::get\+Input (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{id }\end{DoxyParamCaption}) const}



Get the value of an input. 


\begin{DoxyParams}{Parameters}
{\em id} & Input to get. Must be in 0..O\+G\+R\+E\+\_\+\+M\+A\+X\+\_\+\+T\+E\+X\+T\+U\+R\+E\+\_\+\+L\+A\+Y\+E\+R\+S-\/1. \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a88aed71c3c005bea6be70c8d58db3232}\label{class_ogre_1_1_composition_pass_a88aed71c3c005bea6be70c8d58db3232}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Num\+Inputs@{get\+Num\+Inputs}}
\index{get\+Num\+Inputs@{get\+Num\+Inputs}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Num\+Inputs()}{getNumInputs()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Composition\+Pass\+::get\+Num\+Inputs (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the number of inputs used. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a05cbca68fbc408dbf755612cfb72707d}\label{class_ogre_1_1_composition_pass_a05cbca68fbc408dbf755612cfb72707d}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!clear\+All\+Inputs@{clear\+All\+Inputs}}
\index{clear\+All\+Inputs@{clear\+All\+Inputs}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{clear\+All\+Inputs()}{clearAllInputs()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::clear\+All\+Inputs (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Clear all inputs. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a5815c0e9e598fe58d2c7f76be9167976}\label{class_ogre_1_1_composition_pass_a5815c0e9e598fe58d2c7f76be9167976}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Parent@{get\+Parent}}
\index{get\+Parent@{get\+Parent}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Parent()}{getParent()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_composition_target_pass}{Composition\+Target\+Pass}$\ast$ Ogre\+::\+Composition\+Pass\+::get\+Parent (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Get parent object. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ac0daef1d307ace963959896a3db64d75}\label{class_ogre_1_1_composition_pass_ac0daef1d307ace963959896a3db64d75}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!\+\_\+is\+Supported@{\+\_\+is\+Supported}}
\index{\+\_\+is\+Supported@{\+\_\+is\+Supported}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{\+\_\+is\+Supported()}{\_isSupported()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::\+\_\+is\+Supported (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Determine if this target pass is supported on the current rendering device. 

\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a186b5a3bcb90a3ce1d66f97424cd339c}\label{class_ogre_1_1_composition_pass_a186b5a3bcb90a3ce1d66f97424cd339c}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Quad\+Corners@{set\+Quad\+Corners}}
\index{set\+Quad\+Corners@{set\+Quad\+Corners}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Quad\+Corners()}{setQuadCorners()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Quad\+Corners (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{top,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{right,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{bottom }\end{DoxyParamCaption})}



Set quad normalised positions \mbox{[}-\/1;1\mbox{]}x\mbox{[}-\/1;1\mbox{]}. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a0a8e642c52e2b7db79765f93b1cf5730}\label{class_ogre_1_1_composition_pass_a0a8e642c52e2b7db79765f93b1cf5730}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Quad\+Corners@{get\+Quad\+Corners}}
\index{get\+Quad\+Corners@{get\+Quad\+Corners}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Quad\+Corners()}{getQuadCorners()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Quad\+Corners (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&}]{left,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&}]{top,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&}]{right,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&}]{bottom }\end{DoxyParamCaption}) const}



Get quad normalised positions \mbox{[}-\/1;1\mbox{]}x\mbox{[}-\/1;1\mbox{]}. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ac2831cd42c94887f6e239d1460dc6b5c}\label{class_ogre_1_1_composition_pass_ac2831cd42c94887f6e239d1460dc6b5c}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Quad\+Far\+Corners@{set\+Quad\+Far\+Corners}}
\index{set\+Quad\+Far\+Corners@{set\+Quad\+Far\+Corners}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Quad\+Far\+Corners()}{setQuadFarCorners()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Quad\+Far\+Corners (\begin{DoxyParamCaption}\item[{bool}]{far\+Corners,  }\item[{bool}]{far\+Corners\+View\+Space }\end{DoxyParamCaption})}



Sets the use of camera frustum far corners provided in the quad\textquotesingle{}s normals. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_ae350fcee79e006e23d6de413253568e5}\label{class_ogre_1_1_composition_pass_ae350fcee79e006e23d6de413253568e5}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Quad\+Far\+Corners@{get\+Quad\+Far\+Corners}}
\index{get\+Quad\+Far\+Corners@{get\+Quad\+Far\+Corners}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Quad\+Far\+Corners()}{getQuadFarCorners()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Quad\+Far\+Corners (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Returns true if camera frustum far corners are provided in the quad. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a88bc728d5e0497ce4c5dbc052239551d}\label{class_ogre_1_1_composition_pass_a88bc728d5e0497ce4c5dbc052239551d}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Quad\+Far\+Corners\+View\+Space@{get\+Quad\+Far\+Corners\+View\+Space}}
\index{get\+Quad\+Far\+Corners\+View\+Space@{get\+Quad\+Far\+Corners\+View\+Space}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Quad\+Far\+Corners\+View\+Space()}{getQuadFarCornersViewSpace()}}
{\footnotesize\ttfamily bool Ogre\+::\+Composition\+Pass\+::get\+Quad\+Far\+Corners\+View\+Space (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Returns true if the far corners provided in the quad are in view space. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+Q\+U\+AD 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a0937b1f59f584797d44383eeb44b30eb}\label{class_ogre_1_1_composition_pass_a0937b1f59f584797d44383eeb44b30eb}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!set\+Custom\+Type@{set\+Custom\+Type}}
\index{set\+Custom\+Type@{set\+Custom\+Type}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{set\+Custom\+Type()}{setCustomType()}}
{\footnotesize\ttfamily void Ogre\+::\+Composition\+Pass\+::set\+Custom\+Type (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{custom\+Type }\end{DoxyParamCaption})}



Set the type name of this custom composition pass. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM 
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_compositor_manager_ae9b8ca4c2a51c0720bb31393d20fe7c9}{Compositor\+Manager\+::register\+Custom\+Composition\+Pass} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_composition_pass_a3efae9c2f40f1f44a148497797c2f8f0}\label{class_ogre_1_1_composition_pass_a3efae9c2f40f1f44a148497797c2f8f0}} 
\index{Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}!get\+Custom\+Type@{get\+Custom\+Type}}
\index{get\+Custom\+Type@{get\+Custom\+Type}!Ogre\+::\+Composition\+Pass@{Ogre\+::\+Composition\+Pass}}
\subsubsection{\texorpdfstring{get\+Custom\+Type()}{getCustomType()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Composition\+Pass\+::get\+Custom\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the type name of this custom composition pass. 

\begin{DoxyNote}{Note}
applies when Pass\+Type is R\+E\+N\+D\+E\+R\+C\+U\+S\+T\+OM 
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_compositor_manager_ae9b8ca4c2a51c0720bb31393d20fe7c9}{Compositor\+Manager\+::register\+Custom\+Composition\+Pass} 
\end{DoxySeeAlso}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_composition_pass_8h}{Ogre\+Composition\+Pass.\+h}\end{DoxyCompactItemize}
