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