1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::gfx::RenderContext</title> 49 </head> 50 <body> 51 <h1><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/gfx/Overview.html">gfx</a>::RenderContext Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class RenderContext : public <a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a></pre> 55 </div> 56 <h2>Description</h2> 57 <div class="section"> 58 <p>Class that stores information for controlling the render process.</p> 59 </div> 60 <a name="class" id="class"> 61 <h2>Classes</h2> 62 <div class="section"> 63 <table class="members"> 64 <tr> 65 <th> 66 <a href="../../../nw/gfx/RenderContext/Builder/Overview.html"><CODE>nw::gfx::RenderContext::Builder</CODE></a> 67 </th> 68 <td>Class for building render contexts.</td> 69 </tr> </table> 70 </div> 71 </a> <a name="struct" id="struct"> 72 <h2>Structures</h2> 73 <div class="section"> 74 <table class="members"> 75 <tr> 76 <th> 77 <a href="../../../nw/gfx/RenderContext/MaterialHash/Overview.html"><CODE>nw::gfx::RenderContext::MaterialHash</CODE></a> 78 </th> 79 <td> 80 </td> 81 </tr> </table> 82 </div> 83 </a> <a name="enum" id="enum"> 84 <h2>Enumerated Types</h2> 85 <div class="section"> 86 <table class="members"> 87 <tr> 88 <td width="100"> </td> 89 <th> 90 <a href="../../../nw/gfx/RenderContext/RenderMode.html">Render Modes</a> 91 </th> 92 <td>Render mode definition.</td> 93 </tr> 94 <tr> 95 <td width="100"> </td> 96 <th> 97 <a href="../../../nw/gfx/RenderContext/ResetStateMode.html">ResetStateMode</a> 98 </th> 99 <td>Defines states to be reset.</td> 100 </tr> </table> 101 </div> 102 </a> <a name="typedef" id="typedef"> 103 <h2><CODE>typedef</CODE> Definitions</h2> 104 <div class="section"> 105 <table class="members"> 106 <tr> 107 <td width="100" /> 108 <th> 109 <a href="../../../nw/gfx/RenderContext/VertexAttributeArray.html"><CODE>VertexAttributeArray</CODE></a> 110 </th> 111 <td>Array of vertex attributes.</td> 112 </tr> 113 <tr> 114 <td width="100" /> 115 <th> 116 <a href="../../../nw/gfx/RenderContext/AttributeScaleArray.html"><CODE>AttributeScaleArray</CODE></a> 117 </th> 118 <td>Array of scale values for vertex attributes.</td> 119 </tr> </table> 120 </div> 121 </a> <a name="function" id="function"> 122 <h2>Member Functions</h2> 123 <div class="section"> 124 <table class="members"> 125 <tr> 126 <th class="category" colspan="3">Basic drawing functions</th> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131 <a href="../../../nw/gfx/RenderContext/SetRenderTarget.html"><CODE>SetRenderTarget</CODE></a> 132 </th> 133 <td>Sets the render target.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138 <a href="../../../nw/gfx/RenderContext/ResetState.html"><CODE>ResetState</CODE></a> 139 </th> 140 <td>Initializes the rendering environment. We recommended calling this after rendering each frame.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145 <a href="../../../nw/gfx/RenderContext/ClearBuffer.html"><CODE>ClearBuffer</CODE></a> 146 </th> 147 <td>Clears a buffer.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152 <a href="../../../nw/gfx/RenderContext/GetRenderTarget.html"><CODE>GetRenderTarget</CODE></a> 153 </th> 154 <td>Gets a render target.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159 <a href="../../../nw/gfx/RenderContext/ActivateContext.html"><CODE>ActivateContext</CODE></a> 160 </th> 161 <td>Activates a context.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166 <a href="../../../nw/gfx/RenderContext/ActivateParticleContext.html">ActivateParticleContext</a> 167 </th> 168 <td>Enables particle version context. You must call this if particles are enabled.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <a href="../../../nw/gfx/RenderContext/RenderPrimitive.html"><CODE>RenderPrimitive</CODE></a> 174 </th> 175 <td>Renders a primitive.</td> 176 </tr> 177 <tr> 178 <th class="category" colspan="3">Setting/Getting Render Contents</th> 179 </tr> 180 <tr> 181 <td width="100"> </td> 182 <th> 183 <a href="../../../nw/gfx/RenderContext/SetActiveCamera.html"><CODE>SetActiveCamera</CODE></a> 184 </th> 185 <td>Activates the camera with the specified index.</td> 186 </tr> 187 <tr> 188 <td width="100"> </td> 189 <th> 190 <a href="../../../nw/gfx/RenderContext/GetActiveCamera.html"><CODE>GetActiveCamera</CODE></a> 191 </th> 192 <td>Gets the currently active camera.</td> 193 </tr> 194 <tr> 195 <td width="100"> </td> 196 <th> 197 <a href="../../../nw/gfx/RenderContext/GetActiveCameraIndex.html">GetActiveCameraIndex</a> 198 </th> 199 <td>Gets the currently active camera index.</td> 200 </tr> 201 <tr> 202 <td width="100"> </td> 203 <th> 204 <a href="../../../nw/gfx/RenderContext/SetCameraMatrix.html"><CODE>SetCameraMatrix</CODE></a> 205 </th> 206 <td>Sets the camera matrix.</td> 207 </tr> 208 <tr> 209 <td width="100"> </td> 210 <th> 211 <a href="../../../nw/gfx/RenderContext/NW_DEPRECATED_FUNCTION.html">NW_DEPRECATED_FUNCTION</a> 212 </th> 213 <td>Deprecated to help speed processing.</td> 214 </tr> 215 <tr> 216 <td width="100"> </td> 217 <th> 218 <a href="../../../nw/gfx/RenderContext/SetModelMatrixForModel.html">SetModelMatrixForModel</a> 219 </th> 220 <td>Sets the model matrix.</td> 221 </tr> 222 <tr> 223 <td width="100"> </td> 224 <th> 225 <a href="../../../nw/gfx/RenderContext/SetModelMatrixForSkeletalModel.html">SetModelMatrixForSkeletalModel</a> 226 </th> 227 <td>Sets the skeletal model matrix.</td> 228 </tr> 229 <tr> 230 <td width="100"> </td> 231 <th> 232 <a href="../../../nw/gfx/RenderContext/GetModelCache.html"><CODE>GetModelCache</CODE></a> 233 </th> 234 <td>Gets a model cache.</td> 235 </tr> 236 <tr> 237 <td width="100"> </td> 238 <th> 239 <a href="../../../nw/gfx/RenderContext/GetMaterial.html"><CODE>GetMaterial</CODE></a> 240 </th> 241 <td>Gets the material.</td> 242 </tr> 243 <tr> 244 <td width="100"> </td> 245 <th> 246 <a href="../../../nw/gfx/RenderContext/SetMaterial.html"><CODE>SetMaterial</CODE></a> 247 </th> 248 <td>Sets a material.</td> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253 <a href="../../../nw/gfx/RenderContext/GetMaterialCache.html"><CODE>GetMaterialCache</CODE></a> 254 </th> 255 <td>Gets a material cache.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../../nw/gfx/RenderContext/GetShaderProgram.html"><CODE>GetShaderProgram</CODE></a> 261 </th> 262 <td>Gets a shader program.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267 <a href="../../../nw/gfx/RenderContext/GetSceneEnvironment.html"><CODE>GetSceneEnvironment</CODE></a> 268 </th> 269 <td>Gets the environment set for the render context.</td> 270 </tr> 271 <tr> 272 <td width="100"> </td> 273 <th> 274 <a href="../../../nw/gfx/RenderContext/SetMaterialHash.html"><CODE>SetMaterialHash</CODE></a> 275 </th> 276 <td>Gets a material hash.</td> 277 </tr> 278 <tr> 279 <td width="100"> </td> 280 <th> 281 <a href="../../../nw/gfx/RenderContext/GetMaterialHash.html"><CODE>GetMaterialHash</CODE></a> 282 </th> 283 <td>Gets a material hash.</td> 284 </tr> 285 <tr> 286 <td width="100"> </td> 287 <th> 288 <a href="../../../nw/gfx/RenderContext/GetRenderMode.html">GetRenderMode</a> 289 </th> 290 <td>Gets the rendering mode.</td> 291 </tr> 292 <tr> 293 <td width="100"> </td> 294 <th> 295 <a href="../../../nw/gfx/RenderContext/SetRenderMode.html">SetRenderMode</a> 296 </th> 297 <td>Rendering Mode</td> 298 </tr> 299 <tr> 300 <td width="100"> </td> 301 <th> 302 <a href="../../../nw/gfx/RenderContext/IsShaderProgramDirty.html">IsShaderProgramDirty</a> 303 </th> 304 <td>Gets the flag indicating whether the shader program is updated.</td> 305 </tr> 306 <tr> 307 <td width="100"> </td> 308 <th> 309 <a href="../../../nw/gfx/RenderContext/ActivateVertexAttribute.html">ActivateVertexAttribute</a> 310 </th> 311 <td>Sets vertext attribute settings in the GPU.</td> 312 </tr> 313 <tr> 314 <td width="100"> </td> 315 <th> 316 <a href="../../../nw/gfx/RenderContext/DeactivateVertexAttribute.html">DeactivateVertexAttribute</a> 317 </th> 318 <td>Disables GPU vertex attributes.</td> 319 </tr> 320 <tr> 321 <th class="category" colspan="3">Create/Destroy</th> 322 </tr> 323 <tr> 324 <td width="100"> </td> 325 <th> 326 <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a> 327 </th> 328 <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.)</td> 329 </tr> </table> 330 </div> 331 </a> 332 <h2>Class Hierarchy</h2> 333 <div class="section"> 334 <p class="hierarchy"><a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a><br /> <b>nw::gfx::RenderContext</b> 335 </p> 336 </div> 337 <hr><p>CONFIDENTIAL</p></body> 338</html> 339