1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::Viewport class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
4 | <link type="text/css" rel="stylesheet" href="style.css"> |
---|
5 | </head> |
---|
6 | |
---|
7 | <body> |
---|
8 | <!-- Generated by Doxygen 1.3.6 --> |
---|
9 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>Ogre::Viewport Class Reference</h1>An abstraction of a viewport, i.e. |
---|
11 | <a href="#_details">More...</a> |
---|
12 | <p> |
---|
13 | <code>#include <<a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>></code> |
---|
14 | <p> |
---|
15 | <a href="classOgre_1_1Viewport-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
---|
16 | <tr><td></td></tr> |
---|
17 | <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
---|
18 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta0">Viewport</a> (<a class="el" href="classOgre_1_1Camera.html">Camera</a> *camera, <a class="el" href="classOgre_1_1RenderTarget.html">RenderTarget</a> *target, <a class="el" href="namespaceOgre.html#a420">Real</a> left, <a class="el" href="namespaceOgre.html#a420">Real</a> top, <a class="el" href="namespaceOgre.html#a420">Real</a> width, <a class="el" href="namespaceOgre.html#a420">Real</a> height, int ZOrder)</td></tr> |
---|
19 | |
---|
20 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The usual constructor. <a href="#Ogre_1_1Viewporta0"></a><br><br></td></tr> |
---|
21 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta1">~Viewport</a> ()</td></tr> |
---|
22 | |
---|
23 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#Ogre_1_1Viewporta1"></a><br><br></td></tr> |
---|
24 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta2">_updateDimensions</a> (void)</td></tr> |
---|
25 | |
---|
26 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Notifies the viewport of a possible change in dimensions. <a href="#Ogre_1_1Viewporta2"></a><br><br></td></tr> |
---|
27 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta3">update</a> (void)</td></tr> |
---|
28 | |
---|
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Instructs the viewport to updates its contents. <a href="#Ogre_1_1Viewporta3"></a><br><br></td></tr> |
---|
30 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderTarget.html">RenderTarget</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta4">getTarget</a> (void) const </td></tr> |
---|
31 | |
---|
32 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a pointer to the render target for this viewport. <a href="#Ogre_1_1Viewporta4"></a><br><br></td></tr> |
---|
33 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Camera.html">Camera</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta5">getCamera</a> (void) const </td></tr> |
---|
34 | |
---|
35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a pointer to the camera for this viewport. <a href="#Ogre_1_1Viewporta5"></a><br><br></td></tr> |
---|
36 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta6">setCamera</a> (<a class="el" href="classOgre_1_1Camera.html">Camera</a> *cam)</td></tr> |
---|
37 | |
---|
38 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the camera to use for rendering to this viewport. <a href="#Ogre_1_1Viewporta6"></a><br><br></td></tr> |
---|
39 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta7">getZOrder</a> (void) const </td></tr> |
---|
40 | |
---|
41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the Z-Order of this viewport. <a href="#Ogre_1_1Viewporta7"></a><br><br></td></tr> |
---|
42 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta8">getLeft</a> (void) const </td></tr> |
---|
43 | |
---|
44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. <a href="#Ogre_1_1Viewporta8"></a><br><br></td></tr> |
---|
45 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta9">getTop</a> (void) const </td></tr> |
---|
46 | |
---|
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. <a href="#Ogre_1_1Viewporta9"></a><br><br></td></tr> |
---|
48 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta10">getWidth</a> (void) const </td></tr> |
---|
49 | |
---|
50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. <a href="#Ogre_1_1Viewporta10"></a><br><br></td></tr> |
---|
51 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta11">getHeight</a> (void) const </td></tr> |
---|
52 | |
---|
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. <a href="#Ogre_1_1Viewporta11"></a><br><br></td></tr> |
---|
54 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta12">getActualLeft</a> (void) const </td></tr> |
---|
55 | |
---|
56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the actual dimensions of the viewport, a value in pixels. <a href="#Ogre_1_1Viewporta12"></a><br><br></td></tr> |
---|
57 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta13">getActualTop</a> (void) const </td></tr> |
---|
58 | |
---|
59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the actual dimensions of the viewport, a value in pixels. <a href="#Ogre_1_1Viewporta13"></a><br><br></td></tr> |
---|
60 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta14">getActualWidth</a> (void) const </td></tr> |
---|
61 | |
---|
62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the actual dimensions of the viewport, a value in pixels. <a href="#Ogre_1_1Viewporta14"></a><br><br></td></tr> |
---|
63 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta15">getActualHeight</a> (void) const </td></tr> |
---|
64 | |
---|
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets one of the actual dimensions of the viewport, a value in pixels. <a href="#Ogre_1_1Viewporta15"></a><br><br></td></tr> |
---|
66 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta16">setDimensions</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> left, <a class="el" href="namespaceOgre.html#a420">Real</a> top, <a class="el" href="namespaceOgre.html#a420">Real</a> width, <a class="el" href="namespaceOgre.html#a420">Real</a> height)</td></tr> |
---|
67 | |
---|
68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the dimensions (after creation). <a href="#Ogre_1_1Viewporta16"></a><br><br></td></tr> |
---|
69 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta17">setBackgroundColour</a> (const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> &colour)</td></tr> |
---|
70 | |
---|
71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the initial background colour of the viewport (before rendering). <a href="#Ogre_1_1Viewporta17"></a><br><br></td></tr> |
---|
72 | <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta18">getBackgroundColour</a> (void) const </td></tr> |
---|
73 | |
---|
74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the background colour. <a href="#Ogre_1_1Viewporta18"></a><br><br></td></tr> |
---|
75 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta19">setClearEveryFrame</a> (bool clear)</td></tr> |
---|
76 | |
---|
77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether to clear the viewport before rendering. <a href="#Ogre_1_1Viewporta19"></a><br><br></td></tr> |
---|
78 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta20">getClearEveryFrame</a> (void) const </td></tr> |
---|
79 | |
---|
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if the viewport is cleared before every frame. <a href="#Ogre_1_1Viewporta20"></a><br><br></td></tr> |
---|
81 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta21">getActualDimensions</a> (int &left, int &top, int &width, int &height) const </td></tr> |
---|
82 | |
---|
83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Access to actual dimensions (based on target size). <a href="#Ogre_1_1Viewporta21"></a><br><br></td></tr> |
---|
84 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta22">_isUpdated</a> (void) const </td></tr> |
---|
85 | |
---|
86 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta23">_clearUpdatedFlag</a> (void)</td></tr> |
---|
87 | |
---|
88 | <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta24">_getNumRenderedFaces</a> (void) const </td></tr> |
---|
89 | |
---|
90 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of rendered faces in the last update. <a href="#Ogre_1_1Viewporta24"></a><br><br></td></tr> |
---|
91 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta25">setOverlaysEnabled</a> (bool enabled)</td></tr> |
---|
92 | |
---|
93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Tells this viewport whether it should display <a class="el" href="classOgre_1_1Overlay.html">Overlay</a> objects. <a href="#Ogre_1_1Viewporta25"></a><br><br></td></tr> |
---|
94 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewporta26">getOverlaysEnabled</a> (void) const </td></tr> |
---|
95 | |
---|
96 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not <a class="el" href="classOgre_1_1Overlay.html">Overlay</a> objects (created in the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>) are displayed in this viewport. <a href="#Ogre_1_1Viewporta26"></a><br><br></td></tr> |
---|
97 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
98 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Camera.html">Camera</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp0">mCamera</a></td></tr> |
---|
99 | |
---|
100 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderTarget.html">RenderTarget</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp1">mTarget</a></td></tr> |
---|
101 | |
---|
102 | <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp2">mRelLeft</a></td></tr> |
---|
103 | |
---|
104 | <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp3">mRelTop</a></td></tr> |
---|
105 | |
---|
106 | <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp4">mRelWidth</a></td></tr> |
---|
107 | |
---|
108 | <tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp5">mRelHeight</a></td></tr> |
---|
109 | |
---|
110 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp6">mActLeft</a></td></tr> |
---|
111 | |
---|
112 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp7">mActTop</a></td></tr> |
---|
113 | |
---|
114 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp8">mActWidth</a></td></tr> |
---|
115 | |
---|
116 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp9">mActHeight</a></td></tr> |
---|
117 | |
---|
118 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp10">mZOrder</a></td></tr> |
---|
119 | |
---|
120 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ZOrder. <a href="#Ogre_1_1Viewportp10"></a><br><br></td></tr> |
---|
121 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp11">mBackColour</a></td></tr> |
---|
122 | |
---|
123 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Background options. <a href="#Ogre_1_1Viewportp11"></a><br><br></td></tr> |
---|
124 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp12">mClearEveryFrame</a></td></tr> |
---|
125 | |
---|
126 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp13">mUpdated</a></td></tr> |
---|
127 | |
---|
128 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp14">mShowOverlays</a></td></tr> |
---|
129 | |
---|
130 | </table> |
---|
131 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
132 | An abstraction of a viewport, i.e. |
---|
133 | <p> |
---|
134 | a rendering region on a render target. <dl compact><dt><b>Remarks:</b></dt><dd>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. </dd></dl> |
---|
135 | |
---|
136 | <p> |
---|
137 | |
---|
138 | <p> |
---|
139 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00046">46</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> |
---|
140 | <a class="anchor" name="Ogre_1_1Viewporta0" doxytag="Ogre::Viewport::Viewport" ></a><p> |
---|
141 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
142 | <tr> |
---|
143 | <td class="mdRow"> |
---|
144 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
145 | <tr> |
---|
146 | <td class="md" nowrap valign="top"> Ogre::Viewport::Viewport </td> |
---|
147 | <td class="md" valign="top">( </td> |
---|
148 | <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Camera.html">Camera</a> * </td> |
---|
149 | <td class="mdname" nowrap> <em>camera</em>, </td> |
---|
150 | </tr> |
---|
151 | <tr> |
---|
152 | <td class="md" nowrap align="right"></td> |
---|
153 | <td></td> |
---|
154 | <td class="md" nowrap><a class="el" href="classOgre_1_1RenderTarget.html">RenderTarget</a> * </td> |
---|
155 | <td class="mdname" nowrap> <em>target</em>, </td> |
---|
156 | </tr> |
---|
157 | <tr> |
---|
158 | <td class="md" nowrap align="right"></td> |
---|
159 | <td></td> |
---|
160 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
161 | <td class="mdname" nowrap> <em>left</em>, </td> |
---|
162 | </tr> |
---|
163 | <tr> |
---|
164 | <td class="md" nowrap align="right"></td> |
---|
165 | <td></td> |
---|
166 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
167 | <td class="mdname" nowrap> <em>top</em>, </td> |
---|
168 | </tr> |
---|
169 | <tr> |
---|
170 | <td class="md" nowrap align="right"></td> |
---|
171 | <td></td> |
---|
172 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
173 | <td class="mdname" nowrap> <em>width</em>, </td> |
---|
174 | </tr> |
---|
175 | <tr> |
---|
176 | <td class="md" nowrap align="right"></td> |
---|
177 | <td></td> |
---|
178 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
179 | <td class="mdname" nowrap> <em>height</em>, </td> |
---|
180 | </tr> |
---|
181 | <tr> |
---|
182 | <td class="md" nowrap align="right"></td> |
---|
183 | <td></td> |
---|
184 | <td class="md" nowrap>int </td> |
---|
185 | <td class="mdname" nowrap> <em>ZOrder</em></td> |
---|
186 | </tr> |
---|
187 | <tr> |
---|
188 | <td></td> |
---|
189 | <td class="md">) </td> |
---|
190 | <td class="md" colspan="2"></td> |
---|
191 | </tr> |
---|
192 | |
---|
193 | </table> |
---|
194 | </td> |
---|
195 | </tr> |
---|
196 | </table> |
---|
197 | <table cellspacing=5 cellpadding=0 border=0> |
---|
198 | <tr> |
---|
199 | <td> |
---|
200 | |
---|
201 | </td> |
---|
202 | <td> |
---|
203 | |
---|
204 | <p> |
---|
205 | The usual constructor. |
---|
206 | <p> |
---|
207 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
208 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
209 | <tr><td valign=top><em>cam</em> </td><td>Pointer to a camera to be the source for the image. </td></tr> |
---|
210 | <tr><td valign=top><em>target</em> </td><td>Pointer to the render target to be the destination for the rendering. </td></tr> |
---|
211 | <tr><td valign=top><em>left</em> </td><td></td></tr> |
---|
212 | <tr><td valign=top><em>top</em> </td><td></td></tr> |
---|
213 | <tr><td valign=top><em>width</em> </td><td></td></tr> |
---|
214 | <tr><td valign=top><em>height</em> </td><td>Dimensions of the viewport, expressed as a value between 0 and 1. This allows the dimensions to apply irrespective of changes in the target's size: e.g. to fill the whole area, values of 0,0,1,1 are appropriate. </td></tr> |
---|
215 | <tr><td valign=top><em>ZOrder</em> </td><td>Relative Z-order on the target. Lower = further to the front. </td></tr> |
---|
216 | </table> |
---|
217 | </dl> |
---|
218 | </td> |
---|
219 | </tr> |
---|
220 | </table> |
---|
221 | <a class="anchor" name="Ogre_1_1Viewporta1" doxytag="Ogre::Viewport::~Viewport" ></a><p> |
---|
222 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
223 | <tr> |
---|
224 | <td class="mdRow"> |
---|
225 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
226 | <tr> |
---|
227 | <td class="md" nowrap valign="top"> Ogre::Viewport::~<a class="el" href="classOgre_1_1Viewport.html">Viewport</a> </td> |
---|
228 | <td class="md" valign="top">( </td> |
---|
229 | <td class="mdname1" valign="top" nowrap> </td> |
---|
230 | <td class="md" valign="top"> ) </td> |
---|
231 | <td class="md" nowrap></td> |
---|
232 | </tr> |
---|
233 | |
---|
234 | </table> |
---|
235 | </td> |
---|
236 | </tr> |
---|
237 | </table> |
---|
238 | <table cellspacing=5 cellpadding=0 border=0> |
---|
239 | <tr> |
---|
240 | <td> |
---|
241 | |
---|
242 | </td> |
---|
243 | <td> |
---|
244 | |
---|
245 | <p> |
---|
246 | Default destructor. |
---|
247 | <p> |
---|
248 | </td> |
---|
249 | </tr> |
---|
250 | </table> |
---|
251 | <hr><h2>Member Function Documentation</h2> |
---|
252 | <a class="anchor" name="Ogre_1_1Viewporta23" doxytag="Ogre::Viewport::_clearUpdatedFlag" ></a><p> |
---|
253 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
254 | <tr> |
---|
255 | <td class="mdRow"> |
---|
256 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
257 | <tr> |
---|
258 | <td class="md" nowrap valign="top"> void Ogre::Viewport::_clearUpdatedFlag </td> |
---|
259 | <td class="md" valign="top">( </td> |
---|
260 | <td class="md" nowrap valign="top">void </td> |
---|
261 | <td class="mdname1" valign="top" nowrap> </td> |
---|
262 | <td class="md" valign="top"> ) </td> |
---|
263 | <td class="md" nowrap></td> |
---|
264 | </tr> |
---|
265 | |
---|
266 | </table> |
---|
267 | </td> |
---|
268 | </tr> |
---|
269 | </table> |
---|
270 | <table cellspacing=5 cellpadding=0 border=0> |
---|
271 | <tr> |
---|
272 | <td> |
---|
273 | |
---|
274 | </td> |
---|
275 | <td> |
---|
276 | |
---|
277 | <p> |
---|
278 | </td> |
---|
279 | </tr> |
---|
280 | </table> |
---|
281 | <a class="anchor" name="Ogre_1_1Viewporta24" doxytag="Ogre::Viewport::_getNumRenderedFaces" ></a><p> |
---|
282 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
283 | <tr> |
---|
284 | <td class="mdRow"> |
---|
285 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
286 | <tr> |
---|
287 | <td class="md" nowrap valign="top"> unsigned int Ogre::Viewport::_getNumRenderedFaces </td> |
---|
288 | <td class="md" valign="top">( </td> |
---|
289 | <td class="md" nowrap valign="top">void </td> |
---|
290 | <td class="mdname1" valign="top" nowrap> </td> |
---|
291 | <td class="md" valign="top"> ) </td> |
---|
292 | <td class="md" nowrap> const</td> |
---|
293 | </tr> |
---|
294 | |
---|
295 | </table> |
---|
296 | </td> |
---|
297 | </tr> |
---|
298 | </table> |
---|
299 | <table cellspacing=5 cellpadding=0 border=0> |
---|
300 | <tr> |
---|
301 | <td> |
---|
302 | |
---|
303 | </td> |
---|
304 | <td> |
---|
305 | |
---|
306 | <p> |
---|
307 | Gets the number of rendered faces in the last update. |
---|
308 | <p> |
---|
309 | </td> |
---|
310 | </tr> |
---|
311 | </table> |
---|
312 | <a class="anchor" name="Ogre_1_1Viewporta22" doxytag="Ogre::Viewport::_isUpdated" ></a><p> |
---|
313 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
314 | <tr> |
---|
315 | <td class="mdRow"> |
---|
316 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
317 | <tr> |
---|
318 | <td class="md" nowrap valign="top"> bool Ogre::Viewport::_isUpdated </td> |
---|
319 | <td class="md" valign="top">( </td> |
---|
320 | <td class="md" nowrap valign="top">void </td> |
---|
321 | <td class="mdname1" valign="top" nowrap> </td> |
---|
322 | <td class="md" valign="top"> ) </td> |
---|
323 | <td class="md" nowrap> const</td> |
---|
324 | </tr> |
---|
325 | |
---|
326 | </table> |
---|
327 | </td> |
---|
328 | </tr> |
---|
329 | </table> |
---|
330 | <table cellspacing=5 cellpadding=0 border=0> |
---|
331 | <tr> |
---|
332 | <td> |
---|
333 | |
---|
334 | </td> |
---|
335 | <td> |
---|
336 | |
---|
337 | <p> |
---|
338 | </td> |
---|
339 | </tr> |
---|
340 | </table> |
---|
341 | <a class="anchor" name="Ogre_1_1Viewporta2" doxytag="Ogre::Viewport::_updateDimensions" ></a><p> |
---|
342 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
343 | <tr> |
---|
344 | <td class="mdRow"> |
---|
345 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
346 | <tr> |
---|
347 | <td class="md" nowrap valign="top"> void Ogre::Viewport::_updateDimensions </td> |
---|
348 | <td class="md" valign="top">( </td> |
---|
349 | <td class="md" nowrap valign="top">void </td> |
---|
350 | <td class="mdname1" valign="top" nowrap> </td> |
---|
351 | <td class="md" valign="top"> ) </td> |
---|
352 | <td class="md" nowrap></td> |
---|
353 | </tr> |
---|
354 | |
---|
355 | </table> |
---|
356 | </td> |
---|
357 | </tr> |
---|
358 | </table> |
---|
359 | <table cellspacing=5 cellpadding=0 border=0> |
---|
360 | <tr> |
---|
361 | <td> |
---|
362 | |
---|
363 | </td> |
---|
364 | <td> |
---|
365 | |
---|
366 | <p> |
---|
367 | Notifies the viewport of a possible change in dimensions. |
---|
368 | <p> |
---|
369 | <dl compact><dt><b>Remarks:</b></dt><dd>Used by the target to update the viewport's dimensions (usually the result of a change in target size). </dd></dl> |
---|
370 | <dl compact><dt><b>Note:</b></dt><dd>Internal use by <a class="el" href="namespaceOgre.html">Ogre</a> only. </dd></dl> |
---|
371 | </td> |
---|
372 | </tr> |
---|
373 | </table> |
---|
374 | <a class="anchor" name="Ogre_1_1Viewporta21" doxytag="Ogre::Viewport::getActualDimensions" ></a><p> |
---|
375 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
376 | <tr> |
---|
377 | <td class="mdRow"> |
---|
378 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
379 | <tr> |
---|
380 | <td class="md" nowrap valign="top"> void Ogre::Viewport::getActualDimensions </td> |
---|
381 | <td class="md" valign="top">( </td> |
---|
382 | <td class="md" nowrap valign="top">int & </td> |
---|
383 | <td class="mdname" nowrap> <em>left</em>, </td> |
---|
384 | </tr> |
---|
385 | <tr> |
---|
386 | <td class="md" nowrap align="right"></td> |
---|
387 | <td></td> |
---|
388 | <td class="md" nowrap>int & </td> |
---|
389 | <td class="mdname" nowrap> <em>top</em>, </td> |
---|
390 | </tr> |
---|
391 | <tr> |
---|
392 | <td class="md" nowrap align="right"></td> |
---|
393 | <td></td> |
---|
394 | <td class="md" nowrap>int & </td> |
---|
395 | <td class="mdname" nowrap> <em>width</em>, </td> |
---|
396 | </tr> |
---|
397 | <tr> |
---|
398 | <td class="md" nowrap align="right"></td> |
---|
399 | <td></td> |
---|
400 | <td class="md" nowrap>int & </td> |
---|
401 | <td class="mdname" nowrap> <em>height</em></td> |
---|
402 | </tr> |
---|
403 | <tr> |
---|
404 | <td></td> |
---|
405 | <td class="md">) </td> |
---|
406 | <td class="md" colspan="2"> const</td> |
---|
407 | </tr> |
---|
408 | |
---|
409 | </table> |
---|
410 | </td> |
---|
411 | </tr> |
---|
412 | </table> |
---|
413 | <table cellspacing=5 cellpadding=0 border=0> |
---|
414 | <tr> |
---|
415 | <td> |
---|
416 | |
---|
417 | </td> |
---|
418 | <td> |
---|
419 | |
---|
420 | <p> |
---|
421 | Access to actual dimensions (based on target size). |
---|
422 | <p> |
---|
423 | </td> |
---|
424 | </tr> |
---|
425 | </table> |
---|
426 | <a class="anchor" name="Ogre_1_1Viewporta15" doxytag="Ogre::Viewport::getActualHeight" ></a><p> |
---|
427 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
428 | <tr> |
---|
429 | <td class="mdRow"> |
---|
430 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
431 | <tr> |
---|
432 | <td class="md" nowrap valign="top"> int Ogre::Viewport::getActualHeight </td> |
---|
433 | <td class="md" valign="top">( </td> |
---|
434 | <td class="md" nowrap valign="top">void </td> |
---|
435 | <td class="mdname1" valign="top" nowrap> </td> |
---|
436 | <td class="md" valign="top"> ) </td> |
---|
437 | <td class="md" nowrap> const</td> |
---|
438 | </tr> |
---|
439 | |
---|
440 | </table> |
---|
441 | </td> |
---|
442 | </tr> |
---|
443 | </table> |
---|
444 | <table cellspacing=5 cellpadding=0 border=0> |
---|
445 | <tr> |
---|
446 | <td> |
---|
447 | |
---|
448 | </td> |
---|
449 | <td> |
---|
450 | |
---|
451 | <p> |
---|
452 | Gets one of the actual dimensions of the viewport, a value in pixels. |
---|
453 | <p> |
---|
454 | </td> |
---|
455 | </tr> |
---|
456 | </table> |
---|
457 | <a class="anchor" name="Ogre_1_1Viewporta12" doxytag="Ogre::Viewport::getActualLeft" ></a><p> |
---|
458 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
459 | <tr> |
---|
460 | <td class="mdRow"> |
---|
461 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
462 | <tr> |
---|
463 | <td class="md" nowrap valign="top"> int Ogre::Viewport::getActualLeft </td> |
---|
464 | <td class="md" valign="top">( </td> |
---|
465 | <td class="md" nowrap valign="top">void </td> |
---|
466 | <td class="mdname1" valign="top" nowrap> </td> |
---|
467 | <td class="md" valign="top"> ) </td> |
---|
468 | <td class="md" nowrap> const</td> |
---|
469 | </tr> |
---|
470 | |
---|
471 | </table> |
---|
472 | </td> |
---|
473 | </tr> |
---|
474 | </table> |
---|
475 | <table cellspacing=5 cellpadding=0 border=0> |
---|
476 | <tr> |
---|
477 | <td> |
---|
478 | |
---|
479 | </td> |
---|
480 | <td> |
---|
481 | |
---|
482 | <p> |
---|
483 | Gets one of the actual dimensions of the viewport, a value in pixels. |
---|
484 | <p> |
---|
485 | </td> |
---|
486 | </tr> |
---|
487 | </table> |
---|
488 | <a class="anchor" name="Ogre_1_1Viewporta13" doxytag="Ogre::Viewport::getActualTop" ></a><p> |
---|
489 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
490 | <tr> |
---|
491 | <td class="mdRow"> |
---|
492 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
493 | <tr> |
---|
494 | <td class="md" nowrap valign="top"> int Ogre::Viewport::getActualTop </td> |
---|
495 | <td class="md" valign="top">( </td> |
---|
496 | <td class="md" nowrap valign="top">void </td> |
---|
497 | <td class="mdname1" valign="top" nowrap> </td> |
---|
498 | <td class="md" valign="top"> ) </td> |
---|
499 | <td class="md" nowrap> const</td> |
---|
500 | </tr> |
---|
501 | |
---|
502 | </table> |
---|
503 | </td> |
---|
504 | </tr> |
---|
505 | </table> |
---|
506 | <table cellspacing=5 cellpadding=0 border=0> |
---|
507 | <tr> |
---|
508 | <td> |
---|
509 | |
---|
510 | </td> |
---|
511 | <td> |
---|
512 | |
---|
513 | <p> |
---|
514 | Gets one of the actual dimensions of the viewport, a value in pixels. |
---|
515 | <p> |
---|
516 | </td> |
---|
517 | </tr> |
---|
518 | </table> |
---|
519 | <a class="anchor" name="Ogre_1_1Viewporta14" doxytag="Ogre::Viewport::getActualWidth" ></a><p> |
---|
520 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
521 | <tr> |
---|
522 | <td class="mdRow"> |
---|
523 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
524 | <tr> |
---|
525 | <td class="md" nowrap valign="top"> int Ogre::Viewport::getActualWidth </td> |
---|
526 | <td class="md" valign="top">( </td> |
---|
527 | <td class="md" nowrap valign="top">void </td> |
---|
528 | <td class="mdname1" valign="top" nowrap> </td> |
---|
529 | <td class="md" valign="top"> ) </td> |
---|
530 | <td class="md" nowrap> const</td> |
---|
531 | </tr> |
---|
532 | |
---|
533 | </table> |
---|
534 | </td> |
---|
535 | </tr> |
---|
536 | </table> |
---|
537 | <table cellspacing=5 cellpadding=0 border=0> |
---|
538 | <tr> |
---|
539 | <td> |
---|
540 | |
---|
541 | </td> |
---|
542 | <td> |
---|
543 | |
---|
544 | <p> |
---|
545 | Gets one of the actual dimensions of the viewport, a value in pixels. |
---|
546 | <p> |
---|
547 | </td> |
---|
548 | </tr> |
---|
549 | </table> |
---|
550 | <a class="anchor" name="Ogre_1_1Viewporta18" doxytag="Ogre::Viewport::getBackgroundColour" ></a><p> |
---|
551 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
552 | <tr> |
---|
553 | <td class="mdRow"> |
---|
554 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
555 | <tr> |
---|
556 | <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>& Ogre::Viewport::getBackgroundColour </td> |
---|
557 | <td class="md" valign="top">( </td> |
---|
558 | <td class="md" nowrap valign="top">void </td> |
---|
559 | <td class="mdname1" valign="top" nowrap> </td> |
---|
560 | <td class="md" valign="top"> ) </td> |
---|
561 | <td class="md" nowrap> const</td> |
---|
562 | </tr> |
---|
563 | |
---|
564 | </table> |
---|
565 | </td> |
---|
566 | </tr> |
---|
567 | </table> |
---|
568 | <table cellspacing=5 cellpadding=0 border=0> |
---|
569 | <tr> |
---|
570 | <td> |
---|
571 | |
---|
572 | </td> |
---|
573 | <td> |
---|
574 | |
---|
575 | <p> |
---|
576 | Gets the background colour. |
---|
577 | <p> |
---|
578 | </td> |
---|
579 | </tr> |
---|
580 | </table> |
---|
581 | <a class="anchor" name="Ogre_1_1Viewporta5" doxytag="Ogre::Viewport::getCamera" ></a><p> |
---|
582 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
583 | <tr> |
---|
584 | <td class="mdRow"> |
---|
585 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
586 | <tr> |
---|
587 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Camera.html">Camera</a>* Ogre::Viewport::getCamera </td> |
---|
588 | <td class="md" valign="top">( </td> |
---|
589 | <td class="md" nowrap valign="top">void </td> |
---|
590 | <td class="mdname1" valign="top" nowrap> </td> |
---|
591 | <td class="md" valign="top"> ) </td> |
---|
592 | <td class="md" nowrap> const</td> |
---|
593 | </tr> |
---|
594 | |
---|
595 | </table> |
---|
596 | </td> |
---|
597 | </tr> |
---|
598 | </table> |
---|
599 | <table cellspacing=5 cellpadding=0 border=0> |
---|
600 | <tr> |
---|
601 | <td> |
---|
602 | |
---|
603 | </td> |
---|
604 | <td> |
---|
605 | |
---|
606 | <p> |
---|
607 | Retrieves a pointer to the camera for this viewport. |
---|
608 | <p> |
---|
609 | </td> |
---|
610 | </tr> |
---|
611 | </table> |
---|
612 | <a class="anchor" name="Ogre_1_1Viewporta20" doxytag="Ogre::Viewport::getClearEveryFrame" ></a><p> |
---|
613 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
614 | <tr> |
---|
615 | <td class="mdRow"> |
---|
616 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
617 | <tr> |
---|
618 | <td class="md" nowrap valign="top"> bool Ogre::Viewport::getClearEveryFrame </td> |
---|
619 | <td class="md" valign="top">( </td> |
---|
620 | <td class="md" nowrap valign="top">void </td> |
---|
621 | <td class="mdname1" valign="top" nowrap> </td> |
---|
622 | <td class="md" valign="top"> ) </td> |
---|
623 | <td class="md" nowrap> const</td> |
---|
624 | </tr> |
---|
625 | |
---|
626 | </table> |
---|
627 | </td> |
---|
628 | </tr> |
---|
629 | </table> |
---|
630 | <table cellspacing=5 cellpadding=0 border=0> |
---|
631 | <tr> |
---|
632 | <td> |
---|
633 | |
---|
634 | </td> |
---|
635 | <td> |
---|
636 | |
---|
637 | <p> |
---|
638 | Determines if the viewport is cleared before every frame. |
---|
639 | <p> |
---|
640 | </td> |
---|
641 | </tr> |
---|
642 | </table> |
---|
643 | <a class="anchor" name="Ogre_1_1Viewporta11" doxytag="Ogre::Viewport::getHeight" ></a><p> |
---|
644 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
645 | <tr> |
---|
646 | <td class="mdRow"> |
---|
647 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
648 | <tr> |
---|
649 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::Viewport::getHeight </td> |
---|
650 | <td class="md" valign="top">( </td> |
---|
651 | <td class="md" nowrap valign="top">void </td> |
---|
652 | <td class="mdname1" valign="top" nowrap> </td> |
---|
653 | <td class="md" valign="top"> ) </td> |
---|
654 | <td class="md" nowrap> const</td> |
---|
655 | </tr> |
---|
656 | |
---|
657 | </table> |
---|
658 | </td> |
---|
659 | </tr> |
---|
660 | </table> |
---|
661 | <table cellspacing=5 cellpadding=0 border=0> |
---|
662 | <tr> |
---|
663 | <td> |
---|
664 | |
---|
665 | </td> |
---|
666 | <td> |
---|
667 | |
---|
668 | <p> |
---|
669 | Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. |
---|
670 | <p> |
---|
671 | </td> |
---|
672 | </tr> |
---|
673 | </table> |
---|
674 | <a class="anchor" name="Ogre_1_1Viewporta8" doxytag="Ogre::Viewport::getLeft" ></a><p> |
---|
675 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
676 | <tr> |
---|
677 | <td class="mdRow"> |
---|
678 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
679 | <tr> |
---|
680 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::Viewport::getLeft </td> |
---|
681 | <td class="md" valign="top">( </td> |
---|
682 | <td class="md" nowrap valign="top">void </td> |
---|
683 | <td class="mdname1" valign="top" nowrap> </td> |
---|
684 | <td class="md" valign="top"> ) </td> |
---|
685 | <td class="md" nowrap> const</td> |
---|
686 | </tr> |
---|
687 | |
---|
688 | </table> |
---|
689 | </td> |
---|
690 | </tr> |
---|
691 | </table> |
---|
692 | <table cellspacing=5 cellpadding=0 border=0> |
---|
693 | <tr> |
---|
694 | <td> |
---|
695 | |
---|
696 | </td> |
---|
697 | <td> |
---|
698 | |
---|
699 | <p> |
---|
700 | Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. |
---|
701 | <p> |
---|
702 | </td> |
---|
703 | </tr> |
---|
704 | </table> |
---|
705 | <a class="anchor" name="Ogre_1_1Viewporta26" doxytag="Ogre::Viewport::getOverlaysEnabled" ></a><p> |
---|
706 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
707 | <tr> |
---|
708 | <td class="mdRow"> |
---|
709 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
710 | <tr> |
---|
711 | <td class="md" nowrap valign="top"> bool Ogre::Viewport::getOverlaysEnabled </td> |
---|
712 | <td class="md" valign="top">( </td> |
---|
713 | <td class="md" nowrap valign="top">void </td> |
---|
714 | <td class="mdname1" valign="top" nowrap> </td> |
---|
715 | <td class="md" valign="top"> ) </td> |
---|
716 | <td class="md" nowrap> const</td> |
---|
717 | </tr> |
---|
718 | |
---|
719 | </table> |
---|
720 | </td> |
---|
721 | </tr> |
---|
722 | </table> |
---|
723 | <table cellspacing=5 cellpadding=0 border=0> |
---|
724 | <tr> |
---|
725 | <td> |
---|
726 | |
---|
727 | </td> |
---|
728 | <td> |
---|
729 | |
---|
730 | <p> |
---|
731 | Returns whether or not <a class="el" href="classOgre_1_1Overlay.html">Overlay</a> objects (created in the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>) are displayed in this viewport. |
---|
732 | <p> |
---|
733 | </td> |
---|
734 | </tr> |
---|
735 | </table> |
---|
736 | <a class="anchor" name="Ogre_1_1Viewporta4" doxytag="Ogre::Viewport::getTarget" ></a><p> |
---|
737 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
738 | <tr> |
---|
739 | <td class="mdRow"> |
---|
740 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
741 | <tr> |
---|
742 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* Ogre::Viewport::getTarget </td> |
---|
743 | <td class="md" valign="top">( </td> |
---|
744 | <td class="md" nowrap valign="top">void </td> |
---|
745 | <td class="mdname1" valign="top" nowrap> </td> |
---|
746 | <td class="md" valign="top"> ) </td> |
---|
747 | <td class="md" nowrap> const</td> |
---|
748 | </tr> |
---|
749 | |
---|
750 | </table> |
---|
751 | </td> |
---|
752 | </tr> |
---|
753 | </table> |
---|
754 | <table cellspacing=5 cellpadding=0 border=0> |
---|
755 | <tr> |
---|
756 | <td> |
---|
757 | |
---|
758 | </td> |
---|
759 | <td> |
---|
760 | |
---|
761 | <p> |
---|
762 | Retrieves a pointer to the render target for this viewport. |
---|
763 | <p> |
---|
764 | </td> |
---|
765 | </tr> |
---|
766 | </table> |
---|
767 | <a class="anchor" name="Ogre_1_1Viewporta9" doxytag="Ogre::Viewport::getTop" ></a><p> |
---|
768 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
769 | <tr> |
---|
770 | <td class="mdRow"> |
---|
771 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
772 | <tr> |
---|
773 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::Viewport::getTop </td> |
---|
774 | <td class="md" valign="top">( </td> |
---|
775 | <td class="md" nowrap valign="top">void </td> |
---|
776 | <td class="mdname1" valign="top" nowrap> </td> |
---|
777 | <td class="md" valign="top"> ) </td> |
---|
778 | <td class="md" nowrap> const</td> |
---|
779 | </tr> |
---|
780 | |
---|
781 | </table> |
---|
782 | </td> |
---|
783 | </tr> |
---|
784 | </table> |
---|
785 | <table cellspacing=5 cellpadding=0 border=0> |
---|
786 | <tr> |
---|
787 | <td> |
---|
788 | |
---|
789 | </td> |
---|
790 | <td> |
---|
791 | |
---|
792 | <p> |
---|
793 | Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. |
---|
794 | <p> |
---|
795 | </td> |
---|
796 | </tr> |
---|
797 | </table> |
---|
798 | <a class="anchor" name="Ogre_1_1Viewporta10" doxytag="Ogre::Viewport::getWidth" ></a><p> |
---|
799 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
800 | <tr> |
---|
801 | <td class="mdRow"> |
---|
802 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
803 | <tr> |
---|
804 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::Viewport::getWidth </td> |
---|
805 | <td class="md" valign="top">( </td> |
---|
806 | <td class="md" nowrap valign="top">void </td> |
---|
807 | <td class="mdname1" valign="top" nowrap> </td> |
---|
808 | <td class="md" valign="top"> ) </td> |
---|
809 | <td class="md" nowrap> const</td> |
---|
810 | </tr> |
---|
811 | |
---|
812 | </table> |
---|
813 | </td> |
---|
814 | </tr> |
---|
815 | </table> |
---|
816 | <table cellspacing=5 cellpadding=0 border=0> |
---|
817 | <tr> |
---|
818 | <td> |
---|
819 | |
---|
820 | </td> |
---|
821 | <td> |
---|
822 | |
---|
823 | <p> |
---|
824 | Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0. |
---|
825 | <p> |
---|
826 | </td> |
---|
827 | </tr> |
---|
828 | </table> |
---|
829 | <a class="anchor" name="Ogre_1_1Viewporta7" doxytag="Ogre::Viewport::getZOrder" ></a><p> |
---|
830 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
831 | <tr> |
---|
832 | <td class="mdRow"> |
---|
833 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
834 | <tr> |
---|
835 | <td class="md" nowrap valign="top"> int Ogre::Viewport::getZOrder </td> |
---|
836 | <td class="md" valign="top">( </td> |
---|
837 | <td class="md" nowrap valign="top">void </td> |
---|
838 | <td class="mdname1" valign="top" nowrap> </td> |
---|
839 | <td class="md" valign="top"> ) </td> |
---|
840 | <td class="md" nowrap> const</td> |
---|
841 | </tr> |
---|
842 | |
---|
843 | </table> |
---|
844 | </td> |
---|
845 | </tr> |
---|
846 | </table> |
---|
847 | <table cellspacing=5 cellpadding=0 border=0> |
---|
848 | <tr> |
---|
849 | <td> |
---|
850 | |
---|
851 | </td> |
---|
852 | <td> |
---|
853 | |
---|
854 | <p> |
---|
855 | Gets the Z-Order of this viewport. |
---|
856 | <p> |
---|
857 | </td> |
---|
858 | </tr> |
---|
859 | </table> |
---|
860 | <a class="anchor" name="Ogre_1_1Viewporta17" doxytag="Ogre::Viewport::setBackgroundColour" ></a><p> |
---|
861 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
862 | <tr> |
---|
863 | <td class="mdRow"> |
---|
864 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
865 | <tr> |
---|
866 | <td class="md" nowrap valign="top"> void Ogre::Viewport::setBackgroundColour </td> |
---|
867 | <td class="md" valign="top">( </td> |
---|
868 | <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> & </td> |
---|
869 | <td class="mdname1" valign="top" nowrap> <em>colour</em> </td> |
---|
870 | <td class="md" valign="top"> ) </td> |
---|
871 | <td class="md" nowrap></td> |
---|
872 | </tr> |
---|
873 | |
---|
874 | </table> |
---|
875 | </td> |
---|
876 | </tr> |
---|
877 | </table> |
---|
878 | <table cellspacing=5 cellpadding=0 border=0> |
---|
879 | <tr> |
---|
880 | <td> |
---|
881 | |
---|
882 | </td> |
---|
883 | <td> |
---|
884 | |
---|
885 | <p> |
---|
886 | Sets the initial background colour of the viewport (before rendering). |
---|
887 | <p> |
---|
888 | </td> |
---|
889 | </tr> |
---|
890 | </table> |
---|
891 | <a class="anchor" name="Ogre_1_1Viewporta6" doxytag="Ogre::Viewport::setCamera" ></a><p> |
---|
892 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
893 | <tr> |
---|
894 | <td class="mdRow"> |
---|
895 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
896 | <tr> |
---|
897 | <td class="md" nowrap valign="top"> void Ogre::Viewport::setCamera </td> |
---|
898 | <td class="md" valign="top">( </td> |
---|
899 | <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Camera.html">Camera</a> * </td> |
---|
900 | <td class="mdname1" valign="top" nowrap> <em>cam</em> </td> |
---|
901 | <td class="md" valign="top"> ) </td> |
---|
902 | <td class="md" nowrap></td> |
---|
903 | </tr> |
---|
904 | |
---|
905 | </table> |
---|
906 | </td> |
---|
907 | </tr> |
---|
908 | </table> |
---|
909 | <table cellspacing=5 cellpadding=0 border=0> |
---|
910 | <tr> |
---|
911 | <td> |
---|
912 | |
---|
913 | </td> |
---|
914 | <td> |
---|
915 | |
---|
916 | <p> |
---|
917 | Sets the camera to use for rendering to this viewport. |
---|
918 | <p> |
---|
919 | </td> |
---|
920 | </tr> |
---|
921 | </table> |
---|
922 | <a class="anchor" name="Ogre_1_1Viewporta19" doxytag="Ogre::Viewport::setClearEveryFrame" ></a><p> |
---|
923 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
924 | <tr> |
---|
925 | <td class="mdRow"> |
---|
926 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
927 | <tr> |
---|
928 | <td class="md" nowrap valign="top"> void Ogre::Viewport::setClearEveryFrame </td> |
---|
929 | <td class="md" valign="top">( </td> |
---|
930 | <td class="md" nowrap valign="top">bool </td> |
---|
931 | <td class="mdname1" valign="top" nowrap> <em>clear</em> </td> |
---|
932 | <td class="md" valign="top"> ) </td> |
---|
933 | <td class="md" nowrap></td> |
---|
934 | </tr> |
---|
935 | |
---|
936 | </table> |
---|
937 | </td> |
---|
938 | </tr> |
---|
939 | </table> |
---|
940 | <table cellspacing=5 cellpadding=0 border=0> |
---|
941 | <tr> |
---|
942 | <td> |
---|
943 | |
---|
944 | </td> |
---|
945 | <td> |
---|
946 | |
---|
947 | <p> |
---|
948 | Determines whether to clear the viewport before rendering. |
---|
949 | <p> |
---|
950 | <dl compact><dt><b>Remarks:</b></dt><dd>If you expecting every pixel on the viewport to be redrawn every frame, you can save a little time by not clearing the viewport before every frame. Do so by passing 'false' to this method (the default is to clear every frame). </dd></dl> |
---|
951 | </td> |
---|
952 | </tr> |
---|
953 | </table> |
---|
954 | <a class="anchor" name="Ogre_1_1Viewporta16" doxytag="Ogre::Viewport::setDimensions" ></a><p> |
---|
955 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
956 | <tr> |
---|
957 | <td class="mdRow"> |
---|
958 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
959 | <tr> |
---|
960 | <td class="md" nowrap valign="top"> void Ogre::Viewport::setDimensions </td> |
---|
961 | <td class="md" valign="top">( </td> |
---|
962 | <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
963 | <td class="mdname" nowrap> <em>left</em>, </td> |
---|
964 | </tr> |
---|
965 | <tr> |
---|
966 | <td class="md" nowrap align="right"></td> |
---|
967 | <td></td> |
---|
968 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
969 | <td class="mdname" nowrap> <em>top</em>, </td> |
---|
970 | </tr> |
---|
971 | <tr> |
---|
972 | <td class="md" nowrap align="right"></td> |
---|
973 | <td></td> |
---|
974 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
975 | <td class="mdname" nowrap> <em>width</em>, </td> |
---|
976 | </tr> |
---|
977 | <tr> |
---|
978 | <td class="md" nowrap align="right"></td> |
---|
979 | <td></td> |
---|
980 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
981 | <td class="mdname" nowrap> <em>height</em></td> |
---|
982 | </tr> |
---|
983 | <tr> |
---|
984 | <td></td> |
---|
985 | <td class="md">) </td> |
---|
986 | <td class="md" colspan="2"></td> |
---|
987 | </tr> |
---|
988 | |
---|
989 | </table> |
---|
990 | </td> |
---|
991 | </tr> |
---|
992 | </table> |
---|
993 | <table cellspacing=5 cellpadding=0 border=0> |
---|
994 | <tr> |
---|
995 | <td> |
---|
996 | |
---|
997 | </td> |
---|
998 | <td> |
---|
999 | |
---|
1000 | <p> |
---|
1001 | Sets the dimensions (after creation). |
---|
1002 | <p> |
---|
1003 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1004 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1005 | <tr><td valign=top><em>left</em> </td><td></td></tr> |
---|
1006 | <tr><td valign=top><em>top</em> </td><td></td></tr> |
---|
1007 | <tr><td valign=top><em>width</em> </td><td></td></tr> |
---|
1008 | <tr><td valign=top><em>height</em> </td><td>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. </td></tr> |
---|
1009 | </table> |
---|
1010 | </dl> |
---|
1011 | </td> |
---|
1012 | </tr> |
---|
1013 | </table> |
---|
1014 | <a class="anchor" name="Ogre_1_1Viewporta25" doxytag="Ogre::Viewport::setOverlaysEnabled" ></a><p> |
---|
1015 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1016 | <tr> |
---|
1017 | <td class="mdRow"> |
---|
1018 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1019 | <tr> |
---|
1020 | <td class="md" nowrap valign="top"> void Ogre::Viewport::setOverlaysEnabled </td> |
---|
1021 | <td class="md" valign="top">( </td> |
---|
1022 | <td class="md" nowrap valign="top">bool </td> |
---|
1023 | <td class="mdname1" valign="top" nowrap> <em>enabled</em> </td> |
---|
1024 | <td class="md" valign="top"> ) </td> |
---|
1025 | <td class="md" nowrap></td> |
---|
1026 | </tr> |
---|
1027 | |
---|
1028 | </table> |
---|
1029 | </td> |
---|
1030 | </tr> |
---|
1031 | </table> |
---|
1032 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1033 | <tr> |
---|
1034 | <td> |
---|
1035 | |
---|
1036 | </td> |
---|
1037 | <td> |
---|
1038 | |
---|
1039 | <p> |
---|
1040 | Tells this viewport whether it should display <a class="el" href="classOgre_1_1Overlay.html">Overlay</a> objects. |
---|
1041 | <p> |
---|
1042 | <dl compact><dt><b>Remarks:</b></dt><dd><a class="el" href="classOgre_1_1Overlay.html">Overlay</a> objects are layers which appear on top of the scene. They are created via SceneManager::createOverlay and every viewport displays these by default. However, you probably don't want this if you're using multiple viewports, because one of them is probably a picture-in-picture which is not supposed to have overlays of it's own. In this case you can turn off overlays on this viewport by calling this method. </dd></dl> |
---|
1043 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1044 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1045 | <tr><td valign=top><em>enabled</em> </td><td>If true, any overlays are displayed, if false they are not. </td></tr> |
---|
1046 | </table> |
---|
1047 | </dl> |
---|
1048 | </td> |
---|
1049 | </tr> |
---|
1050 | </table> |
---|
1051 | <a class="anchor" name="Ogre_1_1Viewporta3" doxytag="Ogre::Viewport::update" ></a><p> |
---|
1052 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1053 | <tr> |
---|
1054 | <td class="mdRow"> |
---|
1055 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1056 | <tr> |
---|
1057 | <td class="md" nowrap valign="top"> void Ogre::Viewport::update </td> |
---|
1058 | <td class="md" valign="top">( </td> |
---|
1059 | <td class="md" nowrap valign="top">void </td> |
---|
1060 | <td class="mdname1" valign="top" nowrap> </td> |
---|
1061 | <td class="md" valign="top"> ) </td> |
---|
1062 | <td class="md" nowrap></td> |
---|
1063 | </tr> |
---|
1064 | |
---|
1065 | </table> |
---|
1066 | </td> |
---|
1067 | </tr> |
---|
1068 | </table> |
---|
1069 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1070 | <tr> |
---|
1071 | <td> |
---|
1072 | |
---|
1073 | </td> |
---|
1074 | <td> |
---|
1075 | |
---|
1076 | <p> |
---|
1077 | Instructs the viewport to updates its contents. |
---|
1078 | <p> |
---|
1079 | </td> |
---|
1080 | </tr> |
---|
1081 | </table> |
---|
1082 | <hr><h2>Member Data Documentation</h2> |
---|
1083 | <a class="anchor" name="Ogre_1_1Viewportp9" doxytag="Ogre::Viewport::mActHeight" ></a><p> |
---|
1084 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1085 | <tr> |
---|
1086 | <td class="mdRow"> |
---|
1087 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1088 | <tr> |
---|
1089 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp9">Ogre::Viewport::mActHeight</a><code> [protected]</code> |
---|
1090 | </table> |
---|
1091 | </td> |
---|
1092 | </tr> |
---|
1093 | </table> |
---|
1094 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1095 | <tr> |
---|
1096 | <td> |
---|
1097 | |
---|
1098 | </td> |
---|
1099 | <td> |
---|
1100 | |
---|
1101 | <p> |
---|
1102 | |
---|
1103 | <p> |
---|
1104 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00219">219</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1105 | </tr> |
---|
1106 | </table> |
---|
1107 | <a class="anchor" name="Ogre_1_1Viewportp6" doxytag="Ogre::Viewport::mActLeft" ></a><p> |
---|
1108 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1109 | <tr> |
---|
1110 | <td class="mdRow"> |
---|
1111 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1112 | <tr> |
---|
1113 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp6">Ogre::Viewport::mActLeft</a><code> [protected]</code> |
---|
1114 | </table> |
---|
1115 | </td> |
---|
1116 | </tr> |
---|
1117 | </table> |
---|
1118 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1119 | <tr> |
---|
1120 | <td> |
---|
1121 | |
---|
1122 | </td> |
---|
1123 | <td> |
---|
1124 | |
---|
1125 | <p> |
---|
1126 | |
---|
1127 | <p> |
---|
1128 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00219">219</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1129 | </tr> |
---|
1130 | </table> |
---|
1131 | <a class="anchor" name="Ogre_1_1Viewportp7" doxytag="Ogre::Viewport::mActTop" ></a><p> |
---|
1132 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1133 | <tr> |
---|
1134 | <td class="mdRow"> |
---|
1135 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1136 | <tr> |
---|
1137 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp7">Ogre::Viewport::mActTop</a><code> [protected]</code> |
---|
1138 | </table> |
---|
1139 | </td> |
---|
1140 | </tr> |
---|
1141 | </table> |
---|
1142 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1143 | <tr> |
---|
1144 | <td> |
---|
1145 | |
---|
1146 | </td> |
---|
1147 | <td> |
---|
1148 | |
---|
1149 | <p> |
---|
1150 | |
---|
1151 | <p> |
---|
1152 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00219">219</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1153 | </tr> |
---|
1154 | </table> |
---|
1155 | <a class="anchor" name="Ogre_1_1Viewportp8" doxytag="Ogre::Viewport::mActWidth" ></a><p> |
---|
1156 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1157 | <tr> |
---|
1158 | <td class="mdRow"> |
---|
1159 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1160 | <tr> |
---|
1161 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp8">Ogre::Viewport::mActWidth</a><code> [protected]</code> |
---|
1162 | </table> |
---|
1163 | </td> |
---|
1164 | </tr> |
---|
1165 | </table> |
---|
1166 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1167 | <tr> |
---|
1168 | <td> |
---|
1169 | |
---|
1170 | </td> |
---|
1171 | <td> |
---|
1172 | |
---|
1173 | <p> |
---|
1174 | |
---|
1175 | <p> |
---|
1176 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00219">219</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1177 | </tr> |
---|
1178 | </table> |
---|
1179 | <a class="anchor" name="Ogre_1_1Viewportp11" doxytag="Ogre::Viewport::mBackColour" ></a><p> |
---|
1180 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1181 | <tr> |
---|
1182 | <td class="mdRow"> |
---|
1183 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1184 | <tr> |
---|
1185 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp11">Ogre::Viewport::mBackColour</a><code> [protected]</code> |
---|
1186 | </table> |
---|
1187 | </td> |
---|
1188 | </tr> |
---|
1189 | </table> |
---|
1190 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1191 | <tr> |
---|
1192 | <td> |
---|
1193 | |
---|
1194 | </td> |
---|
1195 | <td> |
---|
1196 | |
---|
1197 | <p> |
---|
1198 | Background options. |
---|
1199 | <p> |
---|
1200 | |
---|
1201 | <p> |
---|
1202 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00223">223</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1203 | </tr> |
---|
1204 | </table> |
---|
1205 | <a class="anchor" name="Ogre_1_1Viewportp0" doxytag="Ogre::Viewport::mCamera" ></a><p> |
---|
1206 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1207 | <tr> |
---|
1208 | <td class="mdRow"> |
---|
1209 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1210 | <tr> |
---|
1211 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Camera.html">Camera</a>* <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp0">Ogre::Viewport::mCamera</a><code> [protected]</code> |
---|
1212 | </table> |
---|
1213 | </td> |
---|
1214 | </tr> |
---|
1215 | </table> |
---|
1216 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1217 | <tr> |
---|
1218 | <td> |
---|
1219 | |
---|
1220 | </td> |
---|
1221 | <td> |
---|
1222 | |
---|
1223 | <p> |
---|
1224 | |
---|
1225 | <p> |
---|
1226 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00214">214</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1227 | </tr> |
---|
1228 | </table> |
---|
1229 | <a class="anchor" name="Ogre_1_1Viewportp12" doxytag="Ogre::Viewport::mClearEveryFrame" ></a><p> |
---|
1230 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1231 | <tr> |
---|
1232 | <td class="mdRow"> |
---|
1233 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1234 | <tr> |
---|
1235 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp12">Ogre::Viewport::mClearEveryFrame</a><code> [protected]</code> |
---|
1236 | </table> |
---|
1237 | </td> |
---|
1238 | </tr> |
---|
1239 | </table> |
---|
1240 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1241 | <tr> |
---|
1242 | <td> |
---|
1243 | |
---|
1244 | </td> |
---|
1245 | <td> |
---|
1246 | |
---|
1247 | <p> |
---|
1248 | |
---|
1249 | <p> |
---|
1250 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00224">224</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1251 | </tr> |
---|
1252 | </table> |
---|
1253 | <a class="anchor" name="Ogre_1_1Viewportp5" doxytag="Ogre::Viewport::mRelHeight" ></a><p> |
---|
1254 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1255 | <tr> |
---|
1256 | <td class="mdRow"> |
---|
1257 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1258 | <tr> |
---|
1259 | <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp5">Ogre::Viewport::mRelHeight</a><code> [protected]</code> |
---|
1260 | </table> |
---|
1261 | </td> |
---|
1262 | </tr> |
---|
1263 | </table> |
---|
1264 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1265 | <tr> |
---|
1266 | <td> |
---|
1267 | |
---|
1268 | </td> |
---|
1269 | <td> |
---|
1270 | |
---|
1271 | <p> |
---|
1272 | |
---|
1273 | <p> |
---|
1274 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00217">217</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1275 | </tr> |
---|
1276 | </table> |
---|
1277 | <a class="anchor" name="Ogre_1_1Viewportp2" doxytag="Ogre::Viewport::mRelLeft" ></a><p> |
---|
1278 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1279 | <tr> |
---|
1280 | <td class="mdRow"> |
---|
1281 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1282 | <tr> |
---|
1283 | <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp2">Ogre::Viewport::mRelLeft</a><code> [protected]</code> |
---|
1284 | </table> |
---|
1285 | </td> |
---|
1286 | </tr> |
---|
1287 | </table> |
---|
1288 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1289 | <tr> |
---|
1290 | <td> |
---|
1291 | |
---|
1292 | </td> |
---|
1293 | <td> |
---|
1294 | |
---|
1295 | <p> |
---|
1296 | |
---|
1297 | <p> |
---|
1298 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00217">217</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1299 | </tr> |
---|
1300 | </table> |
---|
1301 | <a class="anchor" name="Ogre_1_1Viewportp3" doxytag="Ogre::Viewport::mRelTop" ></a><p> |
---|
1302 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1303 | <tr> |
---|
1304 | <td class="mdRow"> |
---|
1305 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1306 | <tr> |
---|
1307 | <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp3">Ogre::Viewport::mRelTop</a><code> [protected]</code> |
---|
1308 | </table> |
---|
1309 | </td> |
---|
1310 | </tr> |
---|
1311 | </table> |
---|
1312 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1313 | <tr> |
---|
1314 | <td> |
---|
1315 | |
---|
1316 | </td> |
---|
1317 | <td> |
---|
1318 | |
---|
1319 | <p> |
---|
1320 | |
---|
1321 | <p> |
---|
1322 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00217">217</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1323 | </tr> |
---|
1324 | </table> |
---|
1325 | <a class="anchor" name="Ogre_1_1Viewportp4" doxytag="Ogre::Viewport::mRelWidth" ></a><p> |
---|
1326 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1327 | <tr> |
---|
1328 | <td class="mdRow"> |
---|
1329 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1330 | <tr> |
---|
1331 | <td class="md" nowrap valign="top"> float <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp4">Ogre::Viewport::mRelWidth</a><code> [protected]</code> |
---|
1332 | </table> |
---|
1333 | </td> |
---|
1334 | </tr> |
---|
1335 | </table> |
---|
1336 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1337 | <tr> |
---|
1338 | <td> |
---|
1339 | |
---|
1340 | </td> |
---|
1341 | <td> |
---|
1342 | |
---|
1343 | <p> |
---|
1344 | |
---|
1345 | <p> |
---|
1346 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00217">217</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1347 | </tr> |
---|
1348 | </table> |
---|
1349 | <a class="anchor" name="Ogre_1_1Viewportp14" doxytag="Ogre::Viewport::mShowOverlays" ></a><p> |
---|
1350 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1351 | <tr> |
---|
1352 | <td class="mdRow"> |
---|
1353 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1354 | <tr> |
---|
1355 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp14">Ogre::Viewport::mShowOverlays</a><code> [protected]</code> |
---|
1356 | </table> |
---|
1357 | </td> |
---|
1358 | </tr> |
---|
1359 | </table> |
---|
1360 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1361 | <tr> |
---|
1362 | <td> |
---|
1363 | |
---|
1364 | </td> |
---|
1365 | <td> |
---|
1366 | |
---|
1367 | <p> |
---|
1368 | |
---|
1369 | <p> |
---|
1370 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00226">226</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1371 | </tr> |
---|
1372 | </table> |
---|
1373 | <a class="anchor" name="Ogre_1_1Viewportp1" doxytag="Ogre::Viewport::mTarget" ></a><p> |
---|
1374 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1375 | <tr> |
---|
1376 | <td class="mdRow"> |
---|
1377 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1378 | <tr> |
---|
1379 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp1">Ogre::Viewport::mTarget</a><code> [protected]</code> |
---|
1380 | </table> |
---|
1381 | </td> |
---|
1382 | </tr> |
---|
1383 | </table> |
---|
1384 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1385 | <tr> |
---|
1386 | <td> |
---|
1387 | |
---|
1388 | </td> |
---|
1389 | <td> |
---|
1390 | |
---|
1391 | <p> |
---|
1392 | |
---|
1393 | <p> |
---|
1394 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00215">215</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1395 | </tr> |
---|
1396 | </table> |
---|
1397 | <a class="anchor" name="Ogre_1_1Viewportp13" doxytag="Ogre::Viewport::mUpdated" ></a><p> |
---|
1398 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1399 | <tr> |
---|
1400 | <td class="mdRow"> |
---|
1401 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1402 | <tr> |
---|
1403 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp13">Ogre::Viewport::mUpdated</a><code> [protected]</code> |
---|
1404 | </table> |
---|
1405 | </td> |
---|
1406 | </tr> |
---|
1407 | </table> |
---|
1408 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1409 | <tr> |
---|
1410 | <td> |
---|
1411 | |
---|
1412 | </td> |
---|
1413 | <td> |
---|
1414 | |
---|
1415 | <p> |
---|
1416 | |
---|
1417 | <p> |
---|
1418 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00225">225</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1419 | </tr> |
---|
1420 | </table> |
---|
1421 | <a class="anchor" name="Ogre_1_1Viewportp10" doxytag="Ogre::Viewport::mZOrder" ></a><p> |
---|
1422 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
1423 | <tr> |
---|
1424 | <td class="mdRow"> |
---|
1425 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1426 | <tr> |
---|
1427 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp10">Ogre::Viewport::mZOrder</a><code> [protected]</code> |
---|
1428 | </table> |
---|
1429 | </td> |
---|
1430 | </tr> |
---|
1431 | </table> |
---|
1432 | <table cellspacing=5 cellpadding=0 border=0> |
---|
1433 | <tr> |
---|
1434 | <td> |
---|
1435 | |
---|
1436 | </td> |
---|
1437 | <td> |
---|
1438 | |
---|
1439 | <p> |
---|
1440 | ZOrder. |
---|
1441 | <p> |
---|
1442 | |
---|
1443 | <p> |
---|
1444 | Definition at line <a class="el" href="OgreViewport_8h-source.html#l00221">221</a> of file <a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a>. </td> |
---|
1445 | </tr> |
---|
1446 | </table> |
---|
1447 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
1448 | <li><a class="el" href="OgreViewport_8h-source.html">OgreViewport.h</a></ul> |
---|
1449 | <hr> |
---|
1450 | <p> |
---|
1451 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
1452 | <!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/> |
---|
1453 | This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/> |
---|
1454 | <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> |
---|
1455 | <Work rdf:about=""> |
---|
1456 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
1457 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
1458 | </Work> |
---|
1459 | <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> --> |
---|
1460 | |
---|
1461 | Last modified Sun Feb 12 13:04:59 2006 |
---|
1462 | </p> |
---|
1463 | </body> |
---|
1464 | </html> |
---|