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>nn::gd::CTR</title> 51 </head> 52 <body> 53 <h1><CODE>nn::gd::CTR</CODE> Namespace</h1> 54 <h2>Description</h2> 55 <div class="section"> 56 <p>The namespace for the CTR's GD (graphics) API. <br />(This can also be written without the <CODE>::CTR</CODE> portion.)</p><!-- write here --></div> 57 <a name="class" id="class"> 58 <h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th class="category" colspan="2"><CODE>CombinerStage</CODE></th> 63 </tr> 64 <tr> 65 <th> 66 <a href="../../../nn/gd/CTR/CombinerStage/Overview.html"><CODE>nn::gd::CTR::CombinerStage</CODE></a> 67 </th> 68 <td>The texture combiner pipeline stage.</td> 69 </tr> 70 <tr> 71 <th> 72 <a href="../../../nn/gd/CTR/CombinerUnitDescription/Overview.html"><CODE>nn::gd::CTR::CombinerUnitDescription</CODE></a> 73 </th> 74 <td>Definition for the <CODE>CombinerUnitDescription</CODE> structure.</td> 75 </tr> 76 <tr> 77 <th> 78 <a href="../../../nn/gd/CTR/CombinerDescription/Overview.html"><CODE>nn::gd::CTR::CombinerDescription</CODE></a> 79 </th> 80 <td>The <CODE>CombinerDescription</CODE> class creates a <CODE>CombinerState</CODE>.</td> 81 </tr> 82 <tr> 83 <th class="category" colspan="2"><CODE>FogStage</CODE></th> 84 </tr> 85 <tr> 86 <th> 87 <a href="../../../nn/gd/CTR/FogStage/Overview.html"><CODE>nn::gd::CTR::FogStage</CODE></a> 88 </th> 89 <td>The fog and gas stage.</td> 90 </tr> 91 <tr> 92 <th class="category" colspan="2"><CODE>LightingStage</CODE></th> 93 </tr> 94 <tr> 95 <th> 96 <a href="../../../nn/gd/CTR/Light/Overview.html"><CODE>nn::gd::CTR::Light</CODE></a> 97 </th> 98 <td>This class manages settings for each of eight light sources.</td> 99 </tr> 100 <tr> 101 <th> 102 <a href="../../../nn/gd/CTR/LightingStage/Overview.html"><CODE>nn::gd::CTR::LightingStage</CODE></a> 103 </th> 104 <td>The fragment light stage sets the overall environment for lighting.</td> 105 </tr> 106 <tr> 107 <th class="category" colspan="2"><CODE>MemoryOperation</CODE></th> 108 </tr> 109 <tr> 110 <th> 111 <a href="../../../nn/gd/CTR/Memory/Overview.html"><CODE>nn::gd::CTR::Memory</CODE></a> 112 </th> 113 <td>Memory operations generally involve copying memory (layout conversion block image <-> linear image, filtering) and filling memory. </td> 114 </tr> 115 <tr> 116 <th class="category" colspan="2"><CODE>OutputStage</CODE></th> 117 </tr> 118 <tr> 119 <th> 120 <a href="../../../nn/gd/CTR/OutputStage/Overview.html"><CODE>nn::gd::CTR::OutputStage</CODE></a> 121 </th> 122 <td>The frame buffer operation stage.</td> 123 </tr> 124 <tr> 125 <th> 126 <a href="../../../nn/gd/CTR/RenderTargetDescription/Overview.html"><CODE>nn::gd::CTR::RenderTargetDescription</CODE></a> 127 </th> 128 <td>The descriptor when creating render target objects.</td> 129 </tr> 130 <tr> 131 <th> 132 <a href="../../../nn/gd/CTR/DepthStencilTargetDescription/Overview.html"><CODE>nn::gd::CTR::DepthStencilTargetDescription</CODE></a> 133 </th> 134 <td>The descriptor when creating depth stencil target objects.</td> 135 </tr> 136 <tr> 137 <th> 138 <a href="../../../nn/gd/CTR/TargetProperties/Overview.html"><CODE>nn::gd::CTR::TargetProperties</CODE></a> 139 </th> 140 <td>Detailed information about target objects. (Render targets and depth stencil targets.)</td> 141 </tr> 142 <tr> 143 <th> 144 <a href="../../../nn/gd/CTR/BlendStateDescription/Overview.html"><CODE>nn::gd::CTR::BlendStateDescription</CODE></a> 145 </th> 146 <td>The descriptor for creating blend state objects.</td> 147 </tr> 148 <tr> 149 <th> 150 <a href="../../../nn/gd/CTR/DepthStencilStateDescription/Overview.html"><CODE>nn::gd::CTR::DepthStencilStateDescription</CODE></a> 151 </th> 152 <td>The descriptor for creating depth stencil state objects.</td> 153 </tr> 154 <tr> 155 <th class="category" colspan="2"><CODE>RasterizerStage</CODE></th> 156 </tr> 157 <tr> 158 <th> 159 <a href="../../../nn/gd/CTR/Viewport/Overview.html"><CODE>nn::gd::CTR::Viewport</CODE></a> 160 </th> 161 <td>The viewport settings.</td> 162 </tr> 163 <tr> 164 <th> 165 <a href="../../../nn/gd/CTR/RasterizerStage/Overview.html"><CODE>nn::gd::CTR::RasterizerStage</CODE></a> 166 </th> 167 <td>The rasterizer stage.</td> 168 </tr> 169 <tr> 170 <th class="category" colspan="2"><CODE>Resource</CODE></th> 171 </tr> 172 <tr> 173 <th> 174 <a href="../../../nn/gd/CTR/Resource/Overview.html"><CODE>nn::gd::CTR::Resource</CODE></a> 175 </th> 176 <td>A resource function.</td> 177 </tr> 178 <tr> 179 <th> 180 <a href="../../../nn/gd/CTR/Texture2DResourceDescription/Overview.html"><CODE>nn::gd::CTR::Texture2DResourceDescription</CODE></a> 181 </th> 182 <td>The descriptor for texture 2D resources.</td> 183 </tr> 184 <tr> 185 <th> 186 <a href="../../../nn/gd/CTR/MipmapResourceInfo/Overview.html"><CODE>nn::gd::CTR::MipmapResourceInfo</CODE></a> 187 </th> 188 <td>Detailed information about the mipmap levels of a resource.</td> 189 </tr> 190 <tr> 191 <th> 192 <a href="../../../nn/gd/CTR/Texture2DResourceProperties/Overview.html"><CODE>nn::gd::CTR::Texture2DResourceProperties</CODE></a> 193 </th> 194 <td>Detailed information about texture 2D resources.</td> 195 </tr> 196 <tr> 197 <th> 198 <a href="../../../nn/gd/CTR/VertexBufferResourceDescription/Overview.html"><CODE>nn::gd::CTR::VertexBufferResourceDescription</CODE></a> 199 </th> 200 <td>The descriptor for creating a vertex buffer.</td> 201 </tr> 202 <tr> 203 <th> 204 <a href="../../../nn/gd/CTR/VertexBufferResourceProperties/Overview.html"><CODE>nn::gd::CTR::VertexBufferResourceProperties</CODE></a> 205 </th> 206 <td>Detailed information about <CODE>VertexBuffer</CODE> objects.</td> 207 </tr> 208 <tr> 209 <th class="category" colspan="2"><CODE>ShaderStage</CODE></th> 210 </tr> 211 <tr> 212 <th> 213 <a href="../../../nn/gd/CTR/UniformLocation/Overview.html"><CODE>nn::gd::CTR::UniformLocation</CODE></a> 214 </th> 215 <td>The uniform location.</td> 216 </tr> 217 <tr> 218 <th> 219 <a href="../../../nn/gd/CTR/ShaderStage/Overview.html"><CODE>nn::gd::CTR::ShaderStage</CODE></a> 220 </th> 221 <td>The vertex and geometry shader stage.</td> 222 </tr> 223 <tr> 224 <th> 225 <a href="../../../nn/gd/CTR/UnmanagedRegistersInterval/Overview.html"><CODE>nn::gd::CTR::UnmanagedRegistersInterval</CODE></a> 226 </th> 227 <td>The range of registers for direct output.</td> 228 </tr> 229 <tr> 230 <th> 231 <a href="../../../nn/gd/CTR/ShaderPipelineUnmanagedRegisters/Overview.html"><CODE>nn::gd::CTR::ShaderPipelineUnmanagedRegisters</CODE></a> 232 </th> 233 <td>The array for setting the range of registers for direct output.</td> 234 </tr> 235 <tr> 236 <th class="category" colspan="2"><CODE>System</CODE></th> 237 </tr> 238 <tr> 239 <th> 240 <a href="../../../nn/gd/CTR/System/Overview.html"><CODE>nn::gd::CTR::System</CODE></a> 241 </th> 242 <td>The system function includes features related to pipeline stages for all 3D rendering.</td> 243 </tr> 244 <tr> 245 <th class="category" colspan="2"><CODE>TextureStage</CODE></th> 246 </tr> 247 <tr> 248 <th> 249 <a href="../../../nn/gd/CTR/TextureStage/Overview.html"><CODE>nn::gd::CTR::TextureStage</CODE></a> 250 </th> 251 <td>The texture stage.</td> 252 </tr> 253 <tr> 254 <th> 255 <a href="../../../nn/gd/CTR/ProceduralTextureStage/Overview.html"><CODE>nn::gd::CTR::ProceduralTextureStage</CODE></a> 256 </th> 257 <td>The procedural texture stage.</td> 258 </tr> 259 <tr> 260 <th> 261 <a href="../../../nn/gd/CTR/Texture2DDescription/Overview.html"><CODE>nn::gd::CTR::Texture2DDescription</CODE></a> 262 </th> 263 <td>The descriptor when creating 2D textures.</td> 264 </tr> 265 <tr> 266 <th> 267 <a href="../../../nn/gd/CTR/Texture2DProperties/Overview.html"><CODE>nn::gd::CTR::Texture2DProperties</CODE></a> 268 </th> 269 <td>Detailed information about 2D textures.</td> 270 </tr> 271 <tr> 272 <th> 273 <a href="../../../nn/gd/CTR/TextureCubeDescription/Overview.html"><CODE>nn::gd::CTR::TextureCubeDescription</CODE></a> 274 </th> 275 <td>The descriptor when creating texture cubes.</td> 276 </tr> 277 <tr> 278 <th> 279 <a href="../../../nn/gd/CTR/TextureCubeProperties/Overview.html"><CODE>nn::gd::CTR::TextureCubeProperties</CODE></a> 280 </th> 281 <td>Detailed information about texture cubes.</td> 282 </tr> 283 <tr> 284 <th> 285 <a href="../../../nn/gd/CTR/SamplerStateDescription/Overview.html"><CODE>nn::gd::CTR::SamplerStateDescription</CODE></a> 286 </th> 287 <td>The descriptor when creating sampler states.</td> 288 </tr> 289 <tr> 290 <th class="category" colspan="2"><CODE>Utility</CODE></th> 291 </tr> 292 <tr> 293 <th> 294 <a href="../../../nn/gd/CTR/Utils/Overview.html"><CODE>nn::gd::CTR::Utils</CODE></a> 295 </th> 296 <td>A module that includes several utilities (for example, to convert data to different hardware formats).</td> 297 </tr> 298 <tr> 299 <th class="category" colspan="2"><CODE>VertexInputStage</CODE></th> 300 </tr> 301 <tr> 302 <th> 303 <a href="../../../nn/gd/CTR/VertexInputStage/Overview.html"><CODE>nn::gd::CTR::VertexInputStage</CODE></a> 304 </th> 305 <td>The vertex input stage.</td> 306 </tr> 307 <tr> 308 <th> 309 <a href="../../../nn/gd/CTR/InputElementDescription/Overview.html"><CODE>nn::gd::CTR::InputElementDescription</CODE></a> 310 </th> 311 <td>The descriptor when creating input layouts.</td> 312 </tr> 313 <tr> 314 <th class="category" colspan="2"><CODE>Result</CODE></th> 315 </tr> 316 <tr> 317 <th> 318 <a href="../../../nn/gd/CTR/ResultSuccess/Overview.html"><CODE>nn::gd::CTR::ResultSuccess</CODE></a> 319 </th> 320 <td>Represents success.</td> 321 </tr> 322 <tr> 323 <th> 324 <a href="../../../nn/gd/CTR/ResultOutOfMemory/Overview.html"><CODE>nn::gd::CTR::ResultOutOfMemory</CODE></a> 325 </th> 326 <td>Insufficient FCRAM memory region.</td> 327 </tr> 328 <tr> 329 <th> 330 <a href="../../../nn/gd/CTR/ResultOutOfMemoryExt/Overview.html"><CODE>nn::gd::CTR::ResultOutOfMemoryExt</CODE></a> 331 </th> 332 <td>Insufficient VRAM memory region.</td> 333 </tr> 334 <tr> 335 <th> 336 <a href="../../../nn/gd/CTR/ResultInvalidParameter/Overview.html"><CODE>nn::gd::CTR::ResultInvalidParameter</CODE></a> 337 </th> 338 <td>Parameter is not correct.</td> 339 </tr> 340 <tr> 341 <th> 342 <a href="../../../nn/gd/CTR/ResultNullParameter/Overview.html"><CODE>nn::gd::CTR::ResultNullParameter</CODE></a> 343 </th> 344 <td>NULL has been specified for parameter.</td> 345 </tr> 346 <tr> 347 <th> 348 <a href="../../../nn/gd/CTR/ResultOutOfRangeParameter/Overview.html"><CODE>nn::gd::CTR::ResultOutOfRangeParameter</CODE></a> 349 </th> 350 <td>Parameter is out of range.</td> 351 </tr> 352 <tr> 353 <th> 354 <a href="../../../nn/gd/CTR/ResultInvalidMemoryRegion/Overview.html"><CODE>nn::gd::CTR::ResultInvalidMemoryRegion</CODE></a> 355 </th> 356 <td>Memory region is not correct.</td> 357 </tr> 358 <tr> 359 <th> 360 <a href="../../../nn/gd/CTR/ResultInvalidFunctionCall/Overview.html"><CODE>nn::gd::CTR::ResultInvalidFunctionCall</CODE></a> 361 </th> 362 <td>Incorrect function call.</td> 363 </tr> 364 <tr> 365 <th> 366 <a href="../../../nn/gd/CTR/ResultAlreadyReleased/Overview.html"><CODE>nn::gd::CTR::ResultAlreadyReleased</CODE></a> 367 </th> 368 <td>Object has already been released.</td> 369 </tr> 370 <tr> 371 <th> 372 <a href="../../../nn/gd/CTR/ResultInvalidTextureResolution/Overview.html"><CODE>nn::gd::CTR::ResultInvalidTextureResolution</CODE></a> 373 </th> 374 <td>Texture 2D resolution is not correct.</td> 375 </tr> 376 <tr> 377 <th> 378 <a href="../../../nn/gd/CTR/ResultInvalidSubRegionResolution/Overview.html"><CODE>nn::gd::CTR::ResultInvalidSubRegionResolution</CODE></a> 379 </th> 380 <td>Region is not correct.</td> 381 </tr> 382 <tr> 383 <th> 384 <a href="../../../nn/gd/CTR/ResultInvalidTextureFormat/Overview.html"><CODE>nn::gd::CTR::ResultInvalidTextureFormat</CODE></a> 385 </th> 386 <td>Texture 2D format is not correct.</td> 387 </tr> 388 <tr> 389 <th> 390 <a href="../../../nn/gd/CTR/ResultInvalidMemoryLayout/Overview.html"><CODE>nn::gd::CTR::ResultInvalidMemoryLayout</CODE></a> 391 </th> 392 <td>Memory layout is not correct.</td> 393 </tr> 394 <tr> 395 <th> 396 <a href="../../../nn/gd/CTR/ResultInvalidMemoryLocation/Overview.html"><CODE>nn::gd::CTR::ResultInvalidMemoryLocation</CODE></a> 397 </th> 398 <td>Memory location is not correct.</td> 399 </tr> 400 <tr> 401 <th> 402 <a href="../../../nn/gd/CTR/ResultInvalidTextureMipLevelIndex/Overview.html"><CODE>nn::gd::CTR::ResultInvalidTextureMipLevelIndex</CODE></a> 403 </th> 404 <td>Texture 2D mipmap level index is not correct.</td> 405 </tr> 406 <tr> 407 <th> 408 <a href="../../../nn/gd/CTR/ResultInvalidTextureFormatForCreatingRenderTarget/Overview.html"><CODE>nn::gd::CTR::ResultInvalidTextureFormatForCreatingRenderTarget</CODE></a> 409 </th> 410 <td>Texture 2D format when creating render target is not correct.</td> 411 </tr> 412 <tr> 413 <th> 414 <a href="../../../nn/gd/CTR/ResultInvalidTextureFormatForCreatingDepthStencilTarget/Overview.html"><CODE>nn::gd::CTR::ResultInvalidTextureFormatForCreatingDepthStencilTarget</CODE></a> 415 </th> 416 <td>Texture 2D format when creating depth stencil target is not correct.</td> 417 </tr> 418 <tr> 419 <th> 420 <a href="../../../nn/gd/CTR/ResultDifferentRenderTargetAndDepthStencilTargetResolution/Overview.html"><CODE>nn::gd::CTR::ResultDifferentRenderTargetAndDepthStencilTargetResolution</CODE></a> 421 </th> 422 <td>Render target and depth stencil target are not compatible.</td> 423 </tr> 424 <tr> 425 <th> 426 <a href="../../../nn/gd/CTR/ResultInvalidTextureUnitId/Overview.html"><CODE>nn::gd::CTR::ResultInvalidTextureUnitId</CODE></a> 427 </th> 428 <td>Texture unit ID is not correct.</td> 429 </tr> 430 <tr> 431 <th> 432 <a href="../../../nn/gd/CTR/ResultInvalidShaderUniformName/Overview.html"><CODE>nn::gd::CTR::ResultInvalidShaderUniformName</CODE></a> 433 </th> 434 <td>Shader uniform name is not correct.</td> 435 </tr> 436 <tr> 437 <th> 438 <a href="../../../nn/gd/CTR/ResultInvalidShaderUniform/Overview.html"><CODE>nn::gd::CTR::ResultInvalidShaderUniform</CODE></a> 439 </th> 440 <td>Shader uniform is not correct.</td> 441 </tr> 442 <tr> 443 <th> 444 <a href="../../../nn/gd/CTR/ResultInvalidShaderSignature/Overview.html"><CODE>nn::gd::CTR::ResultInvalidShaderSignature</CODE></a> 445 </th> 446 <td>Shader signature is not correct.</td> 447 </tr> 448 <tr> 449 <th> 450 <a href="../../../nn/gd/CTR/ResultInvalidShaderOperation/Overview.html"><CODE>nn::gd::CTR::ResultInvalidShaderOperation</CODE></a> 451 </th> 452 <td>Shader is not correct.</td> 453 </tr> 454 <tr> 455 <th> 456 <a href="../../../nn/gd/CTR/ResultSystemNoCmdListBind/Overview.html"><CODE>nn::gd::CTR::ResultSystemNoCmdListBind</CODE></a> 457 </th> 458 <td>Command list is not bound.</td> 459 </tr> 460 <tr> 461 <th> 462 <a href="../../../nn/gd/CTR/ResultSystemInvalidCmdListBind/Overview.html"><CODE>nn::gd::CTR::ResultSystemInvalidCmdListBind</CODE></a> 463 </th> 464 <td>Bound command list is not correct.</td> 465 </tr> 466 <tr> 467 <th> 468 <a href="../../../nn/gd/CTR/ResultSystemReceiveErrorFromGlGetError/Overview.html"><CODE>nn::gd::CTR::ResultSystemReceiveErrorFromGlGetError</CODE></a> 469 </th> 470 <td>A <CODE>GetError</CODE> error occurred in the function. (The error might have occurred by the previous <CODE>nngx</CODE> or <CODE>gd</CODE> function call.)</td> 471 </tr> 472 <tr> 473 <th> 474 <a href="../../../nn/gd/CTR/ResultSystemNoPacketToRecord/Overview.html"><CODE>nn::gd::CTR::ResultSystemNoPacketToRecord</CODE></a> 475 </th> 476 <td>There is no data to save.</td> 477 </tr> 478 <tr> 479 <th> 480 <a href="../../../nn/gd/CTR/ResultSystemNoPacketRecorded/Overview.html"><CODE>nn::gd::CTR::ResultSystemNoPacketRecorded</CODE></a> 481 </th> 482 <td>The save process has not started.</td> 483 </tr> 484 <tr> 485 <th> 486 <a href="../../../nn/gd/CTR/ResultSystemAPacketIsAlreadyBeingRecorded/Overview.html"><CODE>nn::gd::CTR::ResultSystemAPacketIsAlreadyBeingRecorded</CODE></a> 487 </th> 488 <td>The save process has already started.</td> 489 </tr> 490 <tr> 491 <th> 492 <a href="../../../nn/gd/CTR/ResultSystemInvalidPacketId/Overview.html"><CODE>nn::gd::CTR::ResultSystemInvalidPacketId</CODE></a> 493 </th> 494 <td>Packet ID is not correct.</td> 495 </tr> </table> 496 </div> 497 </a> <a name="enum" id="enum"> 498 <h2>Enumerated Types</h2> 499 <div class="section"> 500 <table class="members"> 501 <tr> 502 <td width="100"> </td> 503 <th> 504 <a href="../../../nn/gd/CTR/gdResult.html"><CODE>gdResult</CODE></a> 505 </th> 506 <td>Different return values/error codes are returned from GD functions.</td> 507 </tr> </table> 508 </div> 509 </a> 510 <h2>Revision History</h2> 511 <div class="section"> 512 <dl class="history"> 513 <dt>2011/02/15</dt> 514 <dd>Initial version.<br /> 515 </dd> 516 </dl> 517 </div> 518 <hr><p>CONFIDENTIAL</p></body> 519</html>