\hypertarget{class_ogre_1_1_viewport}{}\section{Ogre\+:\+:Viewport Class Reference}
\label{class_ogre_1_1_viewport}\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}


An abstraction of a viewport, i.\+e.  




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



Inheritance diagram for Ogre\+:\+:Viewport\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=169pt]{class_ogre_1_1_viewport__inherit__graph}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \hyperlink{class_ogre_1_1_viewport_1_1_listener}{Listener}
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_viewport_1_1_listener}{Listener} interface so you can be notified of \hyperlink{class_ogre_1_1_viewport}{Viewport} changes. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_viewport_aecd83ce23cc219ed1ba2f9f0b463325b}{Viewport} (\hyperlink{class_ogre_1_1_camera}{Camera} $\ast$camera, \hyperlink{class_ogre_1_1_render_target}{Render\+Target} $\ast$target, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} top, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height, int Z\+Order)
\begin{DoxyCompactList}\small\item\em The usual constructor. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_viewport_a7b76633e02431bd4254f6d4629b7672a}{$\sim$\+Viewport} ()
\begin{DoxyCompactList}\small\item\em Default destructor. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a7998e64f3a79ac014813218f5e7cdd8e}{\+\_\+clear\+Updated\+Flag} (void)
\item 
unsigned int \hyperlink{class_ogre_1_1_viewport_a35036263788bbbe95a05621c39fdd5ef}{\+\_\+get\+Num\+Rendered\+Batches} (void) const
\begin{DoxyCompactList}\small\item\em Gets the number of rendered batches in the last update. \end{DoxyCompactList}\item 
unsigned int \hyperlink{class_ogre_1_1_viewport_add935b437a724d28502ada8f45de4c42}{\+\_\+get\+Num\+Rendered\+Faces} (void) const
\begin{DoxyCompactList}\small\item\em Gets the number of rendered faces in the last update. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_render_queue_invocation_sequence}{Render\+Queue\+Invocation\+Sequence} $\ast$ \hyperlink{class_ogre_1_1_viewport_add9644e3223359c0eb1075de0b1b801b}{\+\_\+get\+Render\+Queue\+Invocation\+Sequence} (void)
\begin{DoxyCompactList}\small\item\em Get the invocation sequence -\/ will return null if using standard. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_viewport_a17077d89f82a12c18bb40858ce302aa0}{\+\_\+is\+Updated} (void) const
\item 
void \hyperlink{class_ogre_1_1_viewport_a23c2b69bbc3d76fd52a4729a71caed08}{\+\_\+update\+Dimensions} (void)
\begin{DoxyCompactList}\small\item\em Notifies the viewport of a possible change in dimensions. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_ac0f6279cc741ced692f2533f280f04d0}{add\+Listener} (\hyperlink{class_ogre_1_1_viewport_1_1_listener}{Listener} $\ast$l)
\begin{DoxyCompactList}\small\item\em Add a listener to this viewport. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_ae7254627ab8d77052bac5813888b4620}{clear} (unsigned int buffers=\hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a37afd2c8cf628f3057c09eac0529a466}{F\+B\+T\+\_\+\+C\+O\+L\+O\+UR}$\vert$\hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a3466d3d0081023a40db64a4cd389fe40}{F\+B\+T\+\_\+\+D\+E\+P\+TH}, const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&colour=\hyperlink{class_ogre_1_1_colour_value_a7f8a06f2a9dd645417c36b560f496c1a}{Colour\+Value\+::\+Black}, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} depth=1.\+0f, unsigned short stencil=0)
\begin{DoxyCompactList}\small\item\em Instructs the viewport to clear itself, without performing an update. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a7fb7b0cdc841b05a89977a50d3336fa3}{get\+Actual\+Dimensions} (int \&left, int \&top, int \&width, int \&height) const
\begin{DoxyCompactList}\small\item\em Access to actual dimensions (based on target size). \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_viewport_ac7313a454230df06a95bef8421c97919}{get\+Actual\+Height} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the actual dimensions of the viewport, a value in pixels. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_viewport_a48a8851cd964559ac62100ef9fda8297}{get\+Actual\+Left} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the actual dimensions of the viewport, a value in pixels. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_viewport_a80f20023a3c8a8abacb4d4d989a52783}{get\+Actual\+Top} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the actual dimensions of the viewport, a value in pixels. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_viewport_a4ee7260b460f6d8305dbb85dea34f8bf}{get\+Actual\+Width} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the actual dimensions of the viewport, a value in pixels. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \& \hyperlink{class_ogre_1_1_viewport_a2a2eceee53085229c733e9801e20e74d}{get\+Background\+Colour} (void) const
\begin{DoxyCompactList}\small\item\em Gets the background colour. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_camera}{Camera} $\ast$ \hyperlink{class_ogre_1_1_viewport_ab47ab0d86f9ca18b23ad7e9d0d7baf0c}{get\+Camera} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a pointer to the camera for this viewport. \end{DoxyCompactList}\item 
unsigned int \hyperlink{class_ogre_1_1_viewport_a4990f072113220a9fd2e14dc78b24638}{get\+Clear\+Buffers} (void) const
\begin{DoxyCompactList}\small\item\em Gets which buffers are to be cleared each frame. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_viewport_aa4d95fd3c06e7bfeee05eda6ffe00bf2}{get\+Clear\+Every\+Frame} (void) const
\begin{DoxyCompactList}\small\item\em Determines if the viewport is cleared before every frame. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_viewport_a5ddbdfc3a15b8e480e3e4958807091c3}{get\+Depth\+Clear} (void) const
\begin{DoxyCompactList}\small\item\em Gets the default depth buffer value to which the viewport is cleared. \end{DoxyCompactList}\item 
\hyperlink{group___general_ga0c187013987552e95dc0276e159911f7}{Colour\+Buffer\+Type} \hyperlink{class_ogre_1_1_viewport_a37c0cea85d6d124a70cf6cd575647638}{get\+Draw\+Buffer} () const
\begin{DoxyCompactList}\small\item\em Returns the current colour buffer type for this viewport. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_viewport_a97dceb1c4bbb5b8d66c2c9fc4af3d0f9}{get\+Height} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_viewport_af3930355304b6a76fd3ed2b3ec1d7e80}{get\+Left} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_viewport_a186af81dbcf5263d600e86a2d11eaa9e}{get\+Material\+Scheme} (void) const
\begin{DoxyCompactList}\small\item\em Get the material scheme which the viewport should use. \end{DoxyCompactList}\item 
\hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode} \hyperlink{class_ogre_1_1_viewport_a9d504d935b3de2f7ff9da03adb272cc3}{get\+Orientation\+Mode} () const
\begin{DoxyCompactList}\small\item\em Get the orientation mode of the viewport. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_viewport_a4982331a28558dcaf4d25822857655f2}{get\+Overlays\+Enabled} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether or not \hyperlink{class_ogre_1_1_overlay}{Overlay} objects (created in the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}) are displayed in this viewport. \end{DoxyCompactList}\item 
virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_viewport_a10cb7bfc804122e7b8f201869477829d}{get\+Render\+Queue\+Invocation\+Sequence\+Name} (void) const
\begin{DoxyCompactList}\small\item\em Gets the name of the render queue invocation sequence for this target. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_viewport_abefe1016cbc08cc395d46822b4e22ade}{get\+Shadows\+Enabled} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether or not shadows (defined in the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}) are displayed in this viewport. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_viewport_a66b9f819dded193d961d505e589da998}{get\+Skies\+Enabled} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether or not skies (created in the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}) are displayed in this viewport. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_render_target}{Render\+Target} $\ast$ \hyperlink{class_ogre_1_1_viewport_ab023724ff78d288c5a0e4ac9c258ea49}{get\+Target} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a pointer to the render target for this viewport. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_viewport_a5c3c4fd4ebe1824c1c9344df7e59b936}{get\+Top} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} \hyperlink{class_ogre_1_1_viewport_a48fec9ee9f90672adbc37dca7ef55a64}{get\+Visibility\+Mask} (void) const
\begin{DoxyCompactList}\small\item\em Gets a per-\/viewport visibility mask. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_viewport_a47c74dbd53a4d1fb7db8024285adc50c}{get\+Width} (void) const
\begin{DoxyCompactList}\small\item\em Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_viewport_adef304662a6b751004a801d64e3cbcbe}{get\+Z\+Order} (void) const
\begin{DoxyCompactList}\small\item\em Gets the Z-\/\+Order of this viewport. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_viewport_a4236ea24b392c4b45a8233911ec9291d}{is\+Auto\+Updated} () const
\begin{DoxyCompactList}\small\item\em Gets whether this viewport is automatically updated if \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s rendering loop or \hyperlink{class_ogre_1_1_render_target_a5f78714e152067e10b381f9d262bcacb}{Render\+Target\+::update} is being used. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a40e29f3225c47bea22822274d4d021eb}{point\+Oriented\+To\+Screen} (const \hyperlink{class_ogre_1_1_vector2}{Vector2} \&v, int orientation\+Mode, \hyperlink{class_ogre_1_1_vector2}{Vector2} \&outv)
\begin{DoxyCompactList}\small\item\em Convert oriented input point coordinates to screen coordinates. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a4e34363fb51b8b3380981694b42c77e7}{point\+Oriented\+To\+Screen} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} orientedX, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} orientedY, int orientation\+Mode, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&screenX, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&screenY)
\item 
void \hyperlink{class_ogre_1_1_viewport_a931d07d2aea40d67f5f6addc5a33feaf}{remove\+Listener} (\hyperlink{class_ogre_1_1_viewport_1_1_listener}{Listener} $\ast$l)
\begin{DoxyCompactList}\small\item\em Remove a listener to this viewport. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a6fa1ca3a866134b2e8ef06749cbddba8}{set\+Auto\+Updated} (bool autoupdate)
\begin{DoxyCompactList}\small\item\em Sets whether this viewport should be automatically updated if \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s rendering loop or \hyperlink{class_ogre_1_1_render_target_a5f78714e152067e10b381f9d262bcacb}{Render\+Target\+::update} is being used. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a3770973e7626d75592a79d0670b862d9}{set\+Background\+Colour} (const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&colour)
\begin{DoxyCompactList}\small\item\em Sets the initial background colour of the viewport (before rendering). \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a20aa22b47f03e523aaeb0d54e094fbf3}{set\+Camera} (\hyperlink{class_ogre_1_1_camera}{Camera} $\ast$cam)
\begin{DoxyCompactList}\small\item\em Sets the camera to use for rendering to this viewport. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_ad9c172c23b0dcccd929f31d4416f9683}{set\+Clear\+Every\+Frame} (bool \hyperlink{class_ogre_1_1_viewport_ae7254627ab8d77052bac5813888b4620}{clear}, unsigned int buffers=\hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a37afd2c8cf628f3057c09eac0529a466}{F\+B\+T\+\_\+\+C\+O\+L\+O\+UR}$\vert$\hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a3466d3d0081023a40db64a4cd389fe40}{F\+B\+T\+\_\+\+D\+E\+P\+TH})
\begin{DoxyCompactList}\small\item\em Determines whether to clear the viewport before rendering. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a34d3e019f408096594a2e43dab6ca579}{set\+Depth\+Clear} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} depth)
\begin{DoxyCompactList}\small\item\em Sets the initial depth buffer value of the viewport (before rendering). \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_aed7bc69a7ca7a787d79832dbccff9e27}{set\+Dimensions} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} left, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} top, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height)
\begin{DoxyCompactList}\small\item\em Sets the dimensions (after creation). \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a7d96a62ee1b17926cebda70f96adc72f}{set\+Draw\+Buffer} (\hyperlink{group___general_ga0c187013987552e95dc0276e159911f7}{Colour\+Buffer\+Type} colour\+Buffer)
\begin{DoxyCompactList}\small\item\em Sets the draw buffer type for the next frame. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a8e8577fd81c45b05de880106f364a281}{set\+Material\+Scheme} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&scheme\+Name)
\begin{DoxyCompactList}\small\item\em Set the material scheme which the viewport should use. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a10c41ba5b52fce35e3c2df7b6b38477b}{set\+Orientation\+Mode} (\hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode} orientation\+Mode, bool set\+Default=true)
\begin{DoxyCompactList}\small\item\em Set the orientation mode of the viewport. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a598f5bd68b1c88cd3ae5a50343965afd}{set\+Overlays\+Enabled} (bool enabled)
\begin{DoxyCompactList}\small\item\em Tells this viewport whether it should display \hyperlink{class_ogre_1_1_overlay}{Overlay} objects. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_viewport_a145439ce2c54216d8d65d3066bbedbdd}{set\+Render\+Queue\+Invocation\+Sequence\+Name} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&sequence\+Name)
\begin{DoxyCompactList}\small\item\em Sets the use of a custom \hyperlink{class_ogre_1_1_render_queue_invocation_sequence}{Render\+Queue\+Invocation\+Sequence} for rendering this target. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_ab71a4790d66e3cddd3b36b3c1b4fd23c}{set\+Shadows\+Enabled} (bool enabled)
\begin{DoxyCompactList}\small\item\em Tells this viewport whether it should display shadows. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_a176a24ccbb9881c4fc61f3f1aaba3c12}{set\+Skies\+Enabled} (bool enabled)
\begin{DoxyCompactList}\small\item\em Tells this viewport whether it should display skies. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_ad5a4fe00ee05861c157bf63e78e1c2b0}{set\+Visibility\+Mask} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} mask)
\begin{DoxyCompactList}\small\item\em Sets a per-\/viewport visibility mask. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_viewport_ab281517fd8070ab1617f126b752bb025}{update} (void)
\begin{DoxyCompactList}\small\item\em Instructs the viewport to updates its contents. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode} \hyperlink{class_ogre_1_1_viewport_ae7d0d74c7a7c17a7b94e44b3fb481030}{get\+Default\+Orientation\+Mode} ()
\begin{DoxyCompactList}\small\item\em Get the initial orientation mode of viewports. \end{DoxyCompactList}\item 
static void \hyperlink{class_ogre_1_1_viewport_a05cec59a7c2ee14e97ad468f42d21661}{set\+Default\+Orientation\+Mode} (\hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode} orientation\+Mode)
\begin{DoxyCompactList}\small\item\em Set the initial orientation mode of viewports. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
An abstraction of a viewport, i.\+e. 

a rendering region on a render target. \begin{DoxyRemark}{Remarks}
A viewport is the meeting of a camera and a rendering surface -\/ the camera renders the scene from a viewpoint, and places its results into some subset of a rendering target, which may be the whole surface or just a part of the surface. Each viewport has a single camera as source and a single target as destination. A camera only has 1 viewport, but a render target may have several. A viewport also has a Z-\/order, i.\+e. if there is more than one viewport on a single render target and they overlap, one must obscure the other in some predetermined way. 
\end{DoxyRemark}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_viewport_aecd83ce23cc219ed1ba2f9f0b463325b}\label{class_ogre_1_1_viewport_aecd83ce23cc219ed1ba2f9f0b463325b}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!Viewport@{Viewport}}
\index{Viewport@{Viewport}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{Viewport()}{Viewport()}}
{\footnotesize\ttfamily Ogre\+::\+Viewport\+::\+Viewport (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_camera}{Camera} $\ast$}]{camera,  }\item[{\hyperlink{class_ogre_1_1_render_target}{Render\+Target} $\ast$}]{target,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{top,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height,  }\item[{int}]{Z\+Order }\end{DoxyParamCaption})}



The usual constructor. 


\begin{DoxyParams}{Parameters}
{\em camera} & Pointer to a camera to be the source for the image. \\
\hline
{\em target} & Pointer to the render target to be the destination for the rendering. \\
\hline
{\em left,top,width,height} & Dimensions of the viewport, expressed as a value between 0 and 1. This allows the dimensions to apply irrespective of changes in the target\textquotesingle{}s size\+: e.\+g. to fill the whole area, values of 0,0,1,1 are appropriate. \\
\hline
{\em Z\+Order} & Relative Z-\/order on the target. Lower = further to the front. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a7b76633e02431bd4254f6d4629b7672a}\label{class_ogre_1_1_viewport_a7b76633e02431bd4254f6d4629b7672a}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!````~Viewport@{$\sim$\+Viewport}}
\index{````~Viewport@{$\sim$\+Viewport}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{$\sim$\+Viewport()}{~Viewport()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Viewport\+::$\sim$\+Viewport (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Default destructor. 



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a23c2b69bbc3d76fd52a4729a71caed08}\label{class_ogre_1_1_viewport_a23c2b69bbc3d76fd52a4729a71caed08}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!\+\_\+update\+Dimensions@{\+\_\+update\+Dimensions}}
\index{\+\_\+update\+Dimensions@{\+\_\+update\+Dimensions}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{\+\_\+update\+Dimensions()}{\_updateDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::\+\_\+update\+Dimensions (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Notifies the viewport of a possible change in dimensions. 

\begin{DoxyRemark}{Remarks}
Used by the target to update the viewport\textquotesingle{}s dimensions (usually the result of a change in target size). 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
Internal use by \hyperlink{namespace_ogre}{Ogre} only. 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_viewport_ab281517fd8070ab1617f126b752bb025}\label{class_ogre_1_1_viewport_ab281517fd8070ab1617f126b752bb025}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!update@{update}}
\index{update@{update}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{update()}{update()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::update (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Instructs the viewport to updates its contents. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ae7254627ab8d77052bac5813888b4620}\label{class_ogre_1_1_viewport_ae7254627ab8d77052bac5813888b4620}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!clear@{clear}}
\index{clear@{clear}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{clear()}{clear()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::clear (\begin{DoxyParamCaption}\item[{unsigned int}]{buffers = {\ttfamily \hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a37afd2c8cf628f3057c09eac0529a466}{F\+B\+T\+\_\+\+C\+O\+L\+O\+UR}$\vert$\hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a3466d3d0081023a40db64a4cd389fe40}{F\+B\+T\+\_\+\+D\+E\+P\+TH}},  }\item[{const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&}]{colour = {\ttfamily \hyperlink{class_ogre_1_1_colour_value_a7f8a06f2a9dd645417c36b560f496c1a}{Colour\+Value\+::\+Black}},  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{depth = {\ttfamily 1.0f},  }\item[{unsigned short}]{stencil = {\ttfamily 0} }\end{DoxyParamCaption})}



Instructs the viewport to clear itself, without performing an update. 

\begin{DoxyRemark}{Remarks}
You would not normally call this method when updating the viewport, since the viewport usually clears itself when updating anyway (
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_viewport_ad9c172c23b0dcccd929f31d4416f9683}{Viewport\+::set\+Clear\+Every\+Frame}). However, if you wish you have the option of manually clearing the frame buffer (or elements of it) using this method. 
\end{DoxySeeAlso}

\begin{DoxyParams}{Parameters}
{\em buffers} & Bitmask identifying which buffer elements to clear \\
\hline
{\em colour} & The colour value to clear to, if F\+B\+T\+\_\+\+C\+O\+L\+O\+UR is included \\
\hline
{\em depth} & The depth value to clear to, if F\+B\+T\+\_\+\+D\+E\+P\+TH is included \\
\hline
{\em stencil} & The stencil value to clear to, if F\+B\+T\+\_\+\+S\+T\+E\+N\+C\+IL is included \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_ab023724ff78d288c5a0e4ac9c258ea49}\label{class_ogre_1_1_viewport_ab023724ff78d288c5a0e4ac9c258ea49}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Target@{get\+Target}}
\index{get\+Target@{get\+Target}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Target()}{getTarget()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_render_target}{Render\+Target}$\ast$ Ogre\+::\+Viewport\+::get\+Target (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Retrieves a pointer to the render target for this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ab47ab0d86f9ca18b23ad7e9d0d7baf0c}\label{class_ogre_1_1_viewport_ab47ab0d86f9ca18b23ad7e9d0d7baf0c}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Camera@{get\+Camera}}
\index{get\+Camera@{get\+Camera}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Camera()}{getCamera()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_camera}{Camera}$\ast$ Ogre\+::\+Viewport\+::get\+Camera (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Retrieves a pointer to the camera for this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a20aa22b47f03e523aaeb0d54e094fbf3}\label{class_ogre_1_1_viewport_a20aa22b47f03e523aaeb0d54e094fbf3}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Camera@{set\+Camera}}
\index{set\+Camera@{set\+Camera}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Camera()}{setCamera()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Camera (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_camera}{Camera} $\ast$}]{cam }\end{DoxyParamCaption})}



Sets the camera to use for rendering to this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_adef304662a6b751004a801d64e3cbcbe}\label{class_ogre_1_1_viewport_adef304662a6b751004a801d64e3cbcbe}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Z\+Order@{get\+Z\+Order}}
\index{get\+Z\+Order@{get\+Z\+Order}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Z\+Order()}{getZOrder()}}
{\footnotesize\ttfamily int Ogre\+::\+Viewport\+::get\+Z\+Order (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the Z-\/\+Order of this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_af3930355304b6a76fd3ed2b3ec1d7e80}\label{class_ogre_1_1_viewport_af3930355304b6a76fd3ed2b3ec1d7e80}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Left@{get\+Left}}
\index{get\+Left@{get\+Left}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Left()}{getLeft()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Viewport\+::get\+Left (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a5c3c4fd4ebe1824c1c9344df7e59b936}\label{class_ogre_1_1_viewport_a5c3c4fd4ebe1824c1c9344df7e59b936}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Top@{get\+Top}}
\index{get\+Top@{get\+Top}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Top()}{getTop()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Viewport\+::get\+Top (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a47c74dbd53a4d1fb7db8024285adc50c}\label{class_ogre_1_1_viewport_a47c74dbd53a4d1fb7db8024285adc50c}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Width@{get\+Width}}
\index{get\+Width@{get\+Width}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Width()}{getWidth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Viewport\+::get\+Width (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a97dceb1c4bbb5b8d66c2c9fc4af3d0f9}\label{class_ogre_1_1_viewport_a97dceb1c4bbb5b8d66c2c9fc4af3d0f9}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Height@{get\+Height}}
\index{get\+Height@{get\+Height}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Height()}{getHeight()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Viewport\+::get\+Height (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the relative dimensions of the viewport, a value between 0.\+0 and 1.\+0. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a48a8851cd964559ac62100ef9fda8297}\label{class_ogre_1_1_viewport_a48a8851cd964559ac62100ef9fda8297}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Actual\+Left@{get\+Actual\+Left}}
\index{get\+Actual\+Left@{get\+Actual\+Left}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Actual\+Left()}{getActualLeft()}}
{\footnotesize\ttfamily int Ogre\+::\+Viewport\+::get\+Actual\+Left (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the actual dimensions of the viewport, a value in pixels. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a80f20023a3c8a8abacb4d4d989a52783}\label{class_ogre_1_1_viewport_a80f20023a3c8a8abacb4d4d989a52783}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Actual\+Top@{get\+Actual\+Top}}
\index{get\+Actual\+Top@{get\+Actual\+Top}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Actual\+Top()}{getActualTop()}}
{\footnotesize\ttfamily int Ogre\+::\+Viewport\+::get\+Actual\+Top (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the actual dimensions of the viewport, a value in pixels. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a4ee7260b460f6d8305dbb85dea34f8bf}\label{class_ogre_1_1_viewport_a4ee7260b460f6d8305dbb85dea34f8bf}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Actual\+Width@{get\+Actual\+Width}}
\index{get\+Actual\+Width@{get\+Actual\+Width}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Actual\+Width()}{getActualWidth()}}
{\footnotesize\ttfamily int Ogre\+::\+Viewport\+::get\+Actual\+Width (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the actual dimensions of the viewport, a value in pixels. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ac7313a454230df06a95bef8421c97919}\label{class_ogre_1_1_viewport_ac7313a454230df06a95bef8421c97919}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Actual\+Height@{get\+Actual\+Height}}
\index{get\+Actual\+Height@{get\+Actual\+Height}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Actual\+Height()}{getActualHeight()}}
{\footnotesize\ttfamily int Ogre\+::\+Viewport\+::get\+Actual\+Height (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets one of the actual dimensions of the viewport, a value in pixels. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_aed7bc69a7ca7a787d79832dbccff9e27}\label{class_ogre_1_1_viewport_aed7bc69a7ca7a787d79832dbccff9e27}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Dimensions@{set\+Dimensions}}
\index{set\+Dimensions@{set\+Dimensions}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Dimensions()}{setDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Dimensions (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{left,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{top,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height }\end{DoxyParamCaption})}



Sets the dimensions (after creation). 


\begin{DoxyParams}{Parameters}
{\em left} & Left point of viewport. \\
\hline
{\em top} & Top point of the viewport. \\
\hline
{\em width} & Width of the viewport. \\
\hline
{\em height} & Height of the viewport. \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Dimensions relative to the size of the target, represented as real values between 0 and 1. i.\+e. the full target area is 0, 0, 1, 1. 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a10c41ba5b52fce35e3c2df7b6b38477b}\label{class_ogre_1_1_viewport_a10c41ba5b52fce35e3c2df7b6b38477b}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Orientation\+Mode@{set\+Orientation\+Mode}}
\index{set\+Orientation\+Mode@{set\+Orientation\+Mode}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Orientation\+Mode()}{setOrientationMode()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Orientation\+Mode (\begin{DoxyParamCaption}\item[{\hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode}}]{orientation\+Mode,  }\item[{bool}]{set\+Default = {\ttfamily true} }\end{DoxyParamCaption})}



Set the orientation mode of the viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a9d504d935b3de2f7ff9da03adb272cc3}\label{class_ogre_1_1_viewport_a9d504d935b3de2f7ff9da03adb272cc3}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Orientation\+Mode@{get\+Orientation\+Mode}}
\index{get\+Orientation\+Mode@{get\+Orientation\+Mode}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Orientation\+Mode()}{getOrientationMode()}}
{\footnotesize\ttfamily \hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode} Ogre\+::\+Viewport\+::get\+Orientation\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the orientation mode of the viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a05cec59a7c2ee14e97ad468f42d21661}\label{class_ogre_1_1_viewport_a05cec59a7c2ee14e97ad468f42d21661}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Default\+Orientation\+Mode@{set\+Default\+Orientation\+Mode}}
\index{set\+Default\+Orientation\+Mode@{set\+Default\+Orientation\+Mode}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Default\+Orientation\+Mode()}{setDefaultOrientationMode()}}
{\footnotesize\ttfamily static void Ogre\+::\+Viewport\+::set\+Default\+Orientation\+Mode (\begin{DoxyParamCaption}\item[{\hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode}}]{orientation\+Mode }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Set the initial orientation mode of viewports. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ae7d0d74c7a7c17a7b94e44b3fb481030}\label{class_ogre_1_1_viewport_ae7d0d74c7a7c17a7b94e44b3fb481030}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Default\+Orientation\+Mode@{get\+Default\+Orientation\+Mode}}
\index{get\+Default\+Orientation\+Mode@{get\+Default\+Orientation\+Mode}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Default\+Orientation\+Mode()}{getDefaultOrientationMode()}}
{\footnotesize\ttfamily static \hyperlink{group___math_ga86b4672dfa02cea53b10a52bd6344305}{Orientation\+Mode} Ogre\+::\+Viewport\+::get\+Default\+Orientation\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Get the initial orientation mode of viewports. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a3770973e7626d75592a79d0670b862d9}\label{class_ogre_1_1_viewport_a3770973e7626d75592a79d0670b862d9}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Background\+Colour@{set\+Background\+Colour}}
\index{set\+Background\+Colour@{set\+Background\+Colour}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Background\+Colour()}{setBackgroundColour()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Background\+Colour (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&}]{colour }\end{DoxyParamCaption})}



Sets the initial background colour of the viewport (before rendering). 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a2a2eceee53085229c733e9801e20e74d}\label{class_ogre_1_1_viewport_a2a2eceee53085229c733e9801e20e74d}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Background\+Colour@{get\+Background\+Colour}}
\index{get\+Background\+Colour@{get\+Background\+Colour}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Background\+Colour()}{getBackgroundColour()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}\& Ogre\+::\+Viewport\+::get\+Background\+Colour (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the background colour. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a34d3e019f408096594a2e43dab6ca579}\label{class_ogre_1_1_viewport_a34d3e019f408096594a2e43dab6ca579}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Depth\+Clear@{set\+Depth\+Clear}}
\index{set\+Depth\+Clear@{set\+Depth\+Clear}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Depth\+Clear()}{setDepthClear()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Depth\+Clear (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{depth }\end{DoxyParamCaption})}



Sets the initial depth buffer value of the viewport (before rendering). 

Default is 1 \mbox{\Hypertarget{class_ogre_1_1_viewport_a5ddbdfc3a15b8e480e3e4958807091c3}\label{class_ogre_1_1_viewport_a5ddbdfc3a15b8e480e3e4958807091c3}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Depth\+Clear@{get\+Depth\+Clear}}
\index{get\+Depth\+Clear@{get\+Depth\+Clear}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Depth\+Clear()}{getDepthClear()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Viewport\+::get\+Depth\+Clear (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the default depth buffer value to which the viewport is cleared. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ad9c172c23b0dcccd929f31d4416f9683}\label{class_ogre_1_1_viewport_ad9c172c23b0dcccd929f31d4416f9683}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Clear\+Every\+Frame@{set\+Clear\+Every\+Frame}}
\index{set\+Clear\+Every\+Frame@{set\+Clear\+Every\+Frame}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Clear\+Every\+Frame()}{setClearEveryFrame()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Clear\+Every\+Frame (\begin{DoxyParamCaption}\item[{bool}]{clear,  }\item[{unsigned int}]{buffers = {\ttfamily \hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a37afd2c8cf628f3057c09eac0529a466}{F\+B\+T\+\_\+\+C\+O\+L\+O\+UR}$\vert$\hyperlink{group___general_gga0206520b2d2647504c13017f2aaf4741a3466d3d0081023a40db64a4cd389fe40}{F\+B\+T\+\_\+\+D\+E\+P\+TH}} }\end{DoxyParamCaption})}



Determines whether to clear the viewport before rendering. 

\begin{DoxyRemark}{Remarks}
You can use this method to set which buffers are cleared (if any) before rendering every frame. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em clear} & Whether or not to clear any buffers \\
\hline
{\em buffers} & One or more values from Frame\+Buffer\+Type denoting which buffers to clear, if clear is set to true. Note you should not clear the stencil buffer here unless you know what you\textquotesingle{}re doing. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_aa4d95fd3c06e7bfeee05eda6ffe00bf2}\label{class_ogre_1_1_viewport_aa4d95fd3c06e7bfeee05eda6ffe00bf2}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Clear\+Every\+Frame@{get\+Clear\+Every\+Frame}}
\index{get\+Clear\+Every\+Frame@{get\+Clear\+Every\+Frame}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Clear\+Every\+Frame()}{getClearEveryFrame()}}
{\footnotesize\ttfamily bool Ogre\+::\+Viewport\+::get\+Clear\+Every\+Frame (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Determines if the viewport is cleared before every frame. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a4990f072113220a9fd2e14dc78b24638}\label{class_ogre_1_1_viewport_a4990f072113220a9fd2e14dc78b24638}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Clear\+Buffers@{get\+Clear\+Buffers}}
\index{get\+Clear\+Buffers@{get\+Clear\+Buffers}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Clear\+Buffers()}{getClearBuffers()}}
{\footnotesize\ttfamily unsigned int Ogre\+::\+Viewport\+::get\+Clear\+Buffers (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets which buffers are to be cleared each frame. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a6fa1ca3a866134b2e8ef06749cbddba8}\label{class_ogre_1_1_viewport_a6fa1ca3a866134b2e8ef06749cbddba8}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Auto\+Updated@{set\+Auto\+Updated}}
\index{set\+Auto\+Updated@{set\+Auto\+Updated}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Auto\+Updated()}{setAutoUpdated()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Auto\+Updated (\begin{DoxyParamCaption}\item[{bool}]{autoupdate }\end{DoxyParamCaption})}



Sets whether this viewport should be automatically updated if \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s rendering loop or \hyperlink{class_ogre_1_1_render_target_a5f78714e152067e10b381f9d262bcacb}{Render\+Target\+::update} is being used. 

\begin{DoxyRemark}{Remarks}
By default, if you use \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s own rendering loop (\hyperlink{class_ogre_1_1_root_a8eda253befda1255cbfd3b298f62449e}{Root\+::start\+Rendering}) or call \hyperlink{class_ogre_1_1_render_target_a5f78714e152067e10b381f9d262bcacb}{Render\+Target\+::update}, all viewports are updated automatically. This method allows you to control that behaviour, if for example you have a viewport which you only want to update periodically. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em autoupdate} & If true, the viewport is updated during the automatic render loop or when \hyperlink{class_ogre_1_1_render_target_a5f78714e152067e10b381f9d262bcacb}{Render\+Target\+::update()} is called. If false, the viewport is only updated when its \hyperlink{class_ogre_1_1_viewport_ab281517fd8070ab1617f126b752bb025}{update()} method is called explicitly. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a4236ea24b392c4b45a8233911ec9291d}\label{class_ogre_1_1_viewport_a4236ea24b392c4b45a8233911ec9291d}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!is\+Auto\+Updated@{is\+Auto\+Updated}}
\index{is\+Auto\+Updated@{is\+Auto\+Updated}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{is\+Auto\+Updated()}{isAutoUpdated()}}
{\footnotesize\ttfamily bool Ogre\+::\+Viewport\+::is\+Auto\+Updated (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Gets whether this viewport is automatically updated if \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s rendering loop or \hyperlink{class_ogre_1_1_render_target_a5f78714e152067e10b381f9d262bcacb}{Render\+Target\+::update} is being used. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a8e8577fd81c45b05de880106f364a281}\label{class_ogre_1_1_viewport_a8e8577fd81c45b05de880106f364a281}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Material\+Scheme@{set\+Material\+Scheme}}
\index{set\+Material\+Scheme@{set\+Material\+Scheme}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Material\+Scheme()}{setMaterialScheme()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Material\+Scheme (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{scheme\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Set the material scheme which the viewport should use. 

\begin{DoxyRemark}{Remarks}
This allows you to tell the system to use a particular material scheme when rendering this viewport, which can involve using different techniques to render your materials. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_technique_a43b6c4e9e48c4e56f96633b916ee90a3}{Technique\+::set\+Scheme\+Name} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a186af81dbcf5263d600e86a2d11eaa9e}\label{class_ogre_1_1_viewport_a186af81dbcf5263d600e86a2d11eaa9e}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Material\+Scheme@{get\+Material\+Scheme}}
\index{get\+Material\+Scheme@{get\+Material\+Scheme}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Material\+Scheme()}{getMaterialScheme()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Viewport\+::get\+Material\+Scheme (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the material scheme which the viewport should use. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a7fb7b0cdc841b05a89977a50d3336fa3}\label{class_ogre_1_1_viewport_a7fb7b0cdc841b05a89977a50d3336fa3}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Actual\+Dimensions@{get\+Actual\+Dimensions}}
\index{get\+Actual\+Dimensions@{get\+Actual\+Dimensions}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Actual\+Dimensions()}{getActualDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::get\+Actual\+Dimensions (\begin{DoxyParamCaption}\item[{int \&}]{left,  }\item[{int \&}]{top,  }\item[{int \&}]{width,  }\item[{int \&}]{height }\end{DoxyParamCaption}) const}



Access to actual dimensions (based on target size). 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a17077d89f82a12c18bb40858ce302aa0}\label{class_ogre_1_1_viewport_a17077d89f82a12c18bb40858ce302aa0}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!\+\_\+is\+Updated@{\+\_\+is\+Updated}}
\index{\+\_\+is\+Updated@{\+\_\+is\+Updated}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{\+\_\+is\+Updated()}{\_isUpdated()}}
{\footnotesize\ttfamily bool Ogre\+::\+Viewport\+::\+\_\+is\+Updated (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}

\mbox{\Hypertarget{class_ogre_1_1_viewport_a7998e64f3a79ac014813218f5e7cdd8e}\label{class_ogre_1_1_viewport_a7998e64f3a79ac014813218f5e7cdd8e}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!\+\_\+clear\+Updated\+Flag@{\+\_\+clear\+Updated\+Flag}}
\index{\+\_\+clear\+Updated\+Flag@{\+\_\+clear\+Updated\+Flag}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{\+\_\+clear\+Updated\+Flag()}{\_clearUpdatedFlag()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::\+\_\+clear\+Updated\+Flag (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_viewport_add935b437a724d28502ada8f45de4c42}\label{class_ogre_1_1_viewport_add935b437a724d28502ada8f45de4c42}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!\+\_\+get\+Num\+Rendered\+Faces@{\+\_\+get\+Num\+Rendered\+Faces}}
\index{\+\_\+get\+Num\+Rendered\+Faces@{\+\_\+get\+Num\+Rendered\+Faces}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{\+\_\+get\+Num\+Rendered\+Faces()}{\_getNumRenderedFaces()}}
{\footnotesize\ttfamily unsigned int Ogre\+::\+Viewport\+::\+\_\+get\+Num\+Rendered\+Faces (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the number of rendered faces in the last update. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a35036263788bbbe95a05621c39fdd5ef}\label{class_ogre_1_1_viewport_a35036263788bbbe95a05621c39fdd5ef}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!\+\_\+get\+Num\+Rendered\+Batches@{\+\_\+get\+Num\+Rendered\+Batches}}
\index{\+\_\+get\+Num\+Rendered\+Batches@{\+\_\+get\+Num\+Rendered\+Batches}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{\+\_\+get\+Num\+Rendered\+Batches()}{\_getNumRenderedBatches()}}
{\footnotesize\ttfamily unsigned int Ogre\+::\+Viewport\+::\+\_\+get\+Num\+Rendered\+Batches (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the number of rendered batches in the last update. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a598f5bd68b1c88cd3ae5a50343965afd}\label{class_ogre_1_1_viewport_a598f5bd68b1c88cd3ae5a50343965afd}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Overlays\+Enabled@{set\+Overlays\+Enabled}}
\index{set\+Overlays\+Enabled@{set\+Overlays\+Enabled}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Overlays\+Enabled()}{setOverlaysEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Overlays\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})}



Tells this viewport whether it should display \hyperlink{class_ogre_1_1_overlay}{Overlay} objects. 

\begin{DoxyRemark}{Remarks}
\hyperlink{class_ogre_1_1_overlay}{Overlay} objects are layers which appear on top of the scene. They are created via Scene\+Manager\+::create\+Overlay and every viewport displays these by default. However, you probably don\textquotesingle{}t want this if you\textquotesingle{}re using multiple viewports, because one of them is probably a picture-\/in-\/picture which is not supposed to have overlays of it\textquotesingle{}s own. In this case you can turn off overlays on this viewport by calling this method. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em enabled} & If true, any overlays are displayed, if false they are not. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a4982331a28558dcaf4d25822857655f2}\label{class_ogre_1_1_viewport_a4982331a28558dcaf4d25822857655f2}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Overlays\+Enabled@{get\+Overlays\+Enabled}}
\index{get\+Overlays\+Enabled@{get\+Overlays\+Enabled}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Overlays\+Enabled()}{getOverlaysEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Viewport\+::get\+Overlays\+Enabled (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns whether or not \hyperlink{class_ogre_1_1_overlay}{Overlay} objects (created in the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}) are displayed in this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a176a24ccbb9881c4fc61f3f1aaba3c12}\label{class_ogre_1_1_viewport_a176a24ccbb9881c4fc61f3f1aaba3c12}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Skies\+Enabled@{set\+Skies\+Enabled}}
\index{set\+Skies\+Enabled@{set\+Skies\+Enabled}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Skies\+Enabled()}{setSkiesEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Skies\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})}



Tells this viewport whether it should display skies. 

\begin{DoxyRemark}{Remarks}
Skies are layers which appear on background of the scene. They are created via \hyperlink{class_ogre_1_1_scene_manager_a370c23fff9cc351b150632c707a46700}{Scene\+Manager\+::set\+Sky\+Box}, \hyperlink{class_ogre_1_1_scene_manager_aebb644c23f059b8bfa3702356d19c6be}{Scene\+Manager\+::set\+Sky\+Plane} and \hyperlink{class_ogre_1_1_scene_manager_ac1c49622909068c8c7551d5a896ada43}{Scene\+Manager\+::set\+Sky\+Dome} and every viewport displays these by default. However, you probably don\textquotesingle{}t want this if you\textquotesingle{}re using multiple viewports, because one of them is probably a picture-\/in-\/picture which is not supposed to have skies of it\textquotesingle{}s own. In this case you can turn off skies on this viewport by calling this method. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em enabled} & If true, any skies are displayed, if false they are not. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a66b9f819dded193d961d505e589da998}\label{class_ogre_1_1_viewport_a66b9f819dded193d961d505e589da998}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Skies\+Enabled@{get\+Skies\+Enabled}}
\index{get\+Skies\+Enabled@{get\+Skies\+Enabled}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Skies\+Enabled()}{getSkiesEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Viewport\+::get\+Skies\+Enabled (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns whether or not skies (created in the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}) are displayed in this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ab71a4790d66e3cddd3b36b3c1b4fd23c}\label{class_ogre_1_1_viewport_ab71a4790d66e3cddd3b36b3c1b4fd23c}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Shadows\+Enabled@{set\+Shadows\+Enabled}}
\index{set\+Shadows\+Enabled@{set\+Shadows\+Enabled}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Shadows\+Enabled()}{setShadowsEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Shadows\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})}



Tells this viewport whether it should display shadows. 

\begin{DoxyRemark}{Remarks}
This setting enables you to disable shadow rendering for a given viewport. The global shadow technique set on \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} still controls the type and nature of shadows, but this flag can override the setting so that no shadows are rendered for a given viewport to save processing time where they are not required. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em enabled} & If true, any shadows are displayed, if false they are not. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_abefe1016cbc08cc395d46822b4e22ade}\label{class_ogre_1_1_viewport_abefe1016cbc08cc395d46822b4e22ade}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Shadows\+Enabled@{get\+Shadows\+Enabled}}
\index{get\+Shadows\+Enabled@{get\+Shadows\+Enabled}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Shadows\+Enabled()}{getShadowsEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Viewport\+::get\+Shadows\+Enabled (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns whether or not shadows (defined in the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}) are displayed in this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_ad5a4fe00ee05861c157bf63e78e1c2b0}\label{class_ogre_1_1_viewport_ad5a4fe00ee05861c157bf63e78e1c2b0}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Visibility\+Mask@{set\+Visibility\+Mask}}
\index{set\+Visibility\+Mask@{set\+Visibility\+Mask}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Visibility\+Mask()}{setVisibilityMask()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Visibility\+Mask (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{mask }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets a per-\/viewport visibility mask. 

\begin{DoxyRemark}{Remarks}
The visibility mask is a way to exclude objects from rendering for a given viewport. For each object in the frustum, a check is made between this mask and the objects visibility flags (
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_movable_object_a28b12f8d0fd7c9da7fcd1e9806dd8064}{Movable\+Object\+::set\+Visibility\+Flags}), and if a binary \textquotesingle{}and\textquotesingle{} returns zero, the object will not be rendered. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a48fec9ee9f90672adbc37dca7ef55a64}\label{class_ogre_1_1_viewport_a48fec9ee9f90672adbc37dca7ef55a64}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Visibility\+Mask@{get\+Visibility\+Mask}}
\index{get\+Visibility\+Mask@{get\+Visibility\+Mask}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Visibility\+Mask()}{getVisibilityMask()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} Ogre\+::\+Viewport\+::get\+Visibility\+Mask (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets a per-\/viewport visibility mask. 

\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_viewport_ad5a4fe00ee05861c157bf63e78e1c2b0}{Viewport\+::set\+Visibility\+Mask} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a145439ce2c54216d8d65d3066bbedbdd}\label{class_ogre_1_1_viewport_a145439ce2c54216d8d65d3066bbedbdd}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Render\+Queue\+Invocation\+Sequence\+Name@{set\+Render\+Queue\+Invocation\+Sequence\+Name}}
\index{set\+Render\+Queue\+Invocation\+Sequence\+Name@{set\+Render\+Queue\+Invocation\+Sequence\+Name}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Render\+Queue\+Invocation\+Sequence\+Name()}{setRenderQueueInvocationSequenceName()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Viewport\+::set\+Render\+Queue\+Invocation\+Sequence\+Name (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{sequence\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Sets the use of a custom \hyperlink{class_ogre_1_1_render_queue_invocation_sequence}{Render\+Queue\+Invocation\+Sequence} for rendering this target. 

\begin{DoxyRemark}{Remarks}
\hyperlink{class_ogre_1_1_render_queue_invocation_sequence}{Render\+Queue\+Invocation\+Sequence} instances are managed through \hyperlink{class_ogre_1_1_root}{Root}. By setting this, you are indicating that you wish this \hyperlink{class_ogre_1_1_render_target}{Render\+Target} to be updated using a custom sequence of render queue invocations, with potentially customised ordering and render state options. You should create the named sequence through \hyperlink{class_ogre_1_1_root}{Root} first, then set the name here. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em sequence\+Name} & The name of the \hyperlink{class_ogre_1_1_render_queue_invocation_sequence}{Render\+Queue\+Invocation\+Sequence} to use. If you specify a blank string, behaviour will return to the default render queue management. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a10cb7bfc804122e7b8f201869477829d}\label{class_ogre_1_1_viewport_a10cb7bfc804122e7b8f201869477829d}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Render\+Queue\+Invocation\+Sequence\+Name@{get\+Render\+Queue\+Invocation\+Sequence\+Name}}
\index{get\+Render\+Queue\+Invocation\+Sequence\+Name@{get\+Render\+Queue\+Invocation\+Sequence\+Name}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Render\+Queue\+Invocation\+Sequence\+Name()}{getRenderQueueInvocationSequenceName()}}
{\footnotesize\ttfamily virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Viewport\+::get\+Render\+Queue\+Invocation\+Sequence\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Gets the name of the render queue invocation sequence for this target. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_add9644e3223359c0eb1075de0b1b801b}\label{class_ogre_1_1_viewport_add9644e3223359c0eb1075de0b1b801b}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!\+\_\+get\+Render\+Queue\+Invocation\+Sequence@{\+\_\+get\+Render\+Queue\+Invocation\+Sequence}}
\index{\+\_\+get\+Render\+Queue\+Invocation\+Sequence@{\+\_\+get\+Render\+Queue\+Invocation\+Sequence}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{\+\_\+get\+Render\+Queue\+Invocation\+Sequence()}{\_getRenderQueueInvocationSequence()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_render_queue_invocation_sequence}{Render\+Queue\+Invocation\+Sequence}$\ast$ Ogre\+::\+Viewport\+::\+\_\+get\+Render\+Queue\+Invocation\+Sequence (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Get the invocation sequence -\/ will return null if using standard. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a40e29f3225c47bea22822274d4d021eb}\label{class_ogre_1_1_viewport_a40e29f3225c47bea22822274d4d021eb}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!point\+Oriented\+To\+Screen@{point\+Oriented\+To\+Screen}}
\index{point\+Oriented\+To\+Screen@{point\+Oriented\+To\+Screen}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{point\+Oriented\+To\+Screen()}{pointOrientedToScreen()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::point\+Oriented\+To\+Screen (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector2}{Vector2} \&}]{v,  }\item[{int}]{orientation\+Mode,  }\item[{\hyperlink{class_ogre_1_1_vector2}{Vector2} \&}]{outv }\end{DoxyParamCaption})}



Convert oriented input point coordinates to screen coordinates. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a4e34363fb51b8b3380981694b42c77e7}\label{class_ogre_1_1_viewport_a4e34363fb51b8b3380981694b42c77e7}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!point\+Oriented\+To\+Screen@{point\+Oriented\+To\+Screen}}
\index{point\+Oriented\+To\+Screen@{point\+Oriented\+To\+Screen}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{point\+Oriented\+To\+Screen()}{pointOrientedToScreen()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::point\+Oriented\+To\+Screen (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{orientedX,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{orientedY,  }\item[{int}]{orientation\+Mode,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&}]{screenX,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \&}]{screenY }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_viewport_ac0f6279cc741ced692f2533f280f04d0}\label{class_ogre_1_1_viewport_ac0f6279cc741ced692f2533f280f04d0}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!add\+Listener@{add\+Listener}}
\index{add\+Listener@{add\+Listener}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{add\+Listener()}{addListener()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::add\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_viewport_1_1_listener}{Listener} $\ast$}]{l }\end{DoxyParamCaption})}



Add a listener to this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a931d07d2aea40d67f5f6addc5a33feaf}\label{class_ogre_1_1_viewport_a931d07d2aea40d67f5f6addc5a33feaf}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!remove\+Listener@{remove\+Listener}}
\index{remove\+Listener@{remove\+Listener}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{remove\+Listener()}{removeListener()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::remove\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_viewport_1_1_listener}{Listener} $\ast$}]{l }\end{DoxyParamCaption})}



Remove a listener to this viewport. 

\mbox{\Hypertarget{class_ogre_1_1_viewport_a7d96a62ee1b17926cebda70f96adc72f}\label{class_ogre_1_1_viewport_a7d96a62ee1b17926cebda70f96adc72f}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!set\+Draw\+Buffer@{set\+Draw\+Buffer}}
\index{set\+Draw\+Buffer@{set\+Draw\+Buffer}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{set\+Draw\+Buffer()}{setDrawBuffer()}}
{\footnotesize\ttfamily void Ogre\+::\+Viewport\+::set\+Draw\+Buffer (\begin{DoxyParamCaption}\item[{\hyperlink{group___general_ga0c187013987552e95dc0276e159911f7}{Colour\+Buffer\+Type}}]{colour\+Buffer }\end{DoxyParamCaption})}



Sets the draw buffer type for the next frame. 

\begin{DoxyRemark}{Remarks}
Specifies the particular buffer that will be targeted by the render target. Should be used if the render target supports quad buffer stereo. If the render target does not support stereo (ie. left and right), then only back and front will be used. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em colour\+Buffer} & Specifies the particular buffer that will be targeted by the render target. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_viewport_a37c0cea85d6d124a70cf6cd575647638}\label{class_ogre_1_1_viewport_a37c0cea85d6d124a70cf6cd575647638}} 
\index{Ogre\+::\+Viewport@{Ogre\+::\+Viewport}!get\+Draw\+Buffer@{get\+Draw\+Buffer}}
\index{get\+Draw\+Buffer@{get\+Draw\+Buffer}!Ogre\+::\+Viewport@{Ogre\+::\+Viewport}}
\subsubsection{\texorpdfstring{get\+Draw\+Buffer()}{getDrawBuffer()}}
{\footnotesize\ttfamily \hyperlink{group___general_ga0c187013987552e95dc0276e159911f7}{Colour\+Buffer\+Type} Ogre\+::\+Viewport\+::get\+Draw\+Buffer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Returns the current colour buffer type for this viewport. 



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