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>gx</title> 51 </head> 52 <body> 53<h1>gx</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>This is the system API for the graphics library (DMPGL 2.0).</p><P> 57With a few exceptions, only a C API has been provided for the <CODE>gx</CODE> functions. 58 </P></div> 59 <a name="function" id="function"> 60<h2>Functions</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64<th class="category" colspan="3">Initialization/Termination</th> 65 </tr> 66 <tr> 67 <td width="100"> </td> 68 <th> 69<a href="../nn_gx/nngxInitialize.html"><CODE>nngxInitialize</CODE></a> 70 </th> 71<td>Initializes the graphics library (DMPGL).</td> 72 </tr> 73 <tr> 74 <td width="100"> </td> 75 <th> 76<a href="../nn_gx/nngxFinalize.html"><CODE>nngxFinalize</CODE></a> 77 </th> 78<td>Terminates the (DMPGL) graphics library.</td> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83<a href="../nn_gx/nngxGetAllocator.html"><CODE>nngxGetAllocator</CODE></a> 84 </th> 85<td>Gets a pointer to the allocator function specified by <CODE>nngxInitialize</CODE>.</td> 86 </tr> 87 <tr> 88<th class="category" colspan="3">Command List Execution Control</th> 89 </tr> 90 <tr> 91 <td width="100"> </td> 92 <th> 93<a href="../nn_gx/nngxGenCmdlists.html"><CODE>nngxGenCmdlists</CODE></a> 94 </th> 95<td>Generates command list objects.</td> 96 </tr> 97 <tr> 98 <td width="100"> </td> 99 <th> 100<a href="../nn_gx/nngxDeleteCmdlists.html"><CODE>nngxDeleteCmdlists</CODE></a> 101 </th> 102<td>Deletes command list objects.</td> 103 </tr> 104 <tr> 105 <td width="100"> </td> 106 <th> 107<a href="../nn_gx/nngxBindCmdlist.html"><CODE>nngxBindCmdlist</CODE></a> 108 </th> 109<td>Binds a command list object to the current command list.</td> 110 </tr> 111 <tr> 112 <td width="100"> </td> 113 <th> 114<a href="../nn_gx/nngxCmdlistStorage.html"><CODE>nngxCmdlistStorage</CODE></a> 115 </th> 116<td>Allocates data regions for the current command list.</td> 117 </tr> 118 <tr> 119 <td width="100"> </td> 120 <th> 121<a href="../nn_gx/nngxRunCmdlist.html"><CODE>nngxRunCmdlist</CODE></a> 122 </th> 123<td>Runs the current command list.</td> 124 </tr> 125 <tr> 126 <td width="100"> </td> 127 <th> 128<a href="../nn_gx/nngxStopCmdlist.html"><CODE>nngxStopCmdlist</CODE></a> 129 </th> 130<td>Stops command list execution.</td> 131 </tr> 132 <tr> 133 <td width="100"> </td> 134 <th> 135<a href="../nn_gx/nngxReserveStopCmdlist.html"><CODE>nngxReserveStopCmdlist</CODE></a> 136 </th> 137<td>Presets the current command list to stop.</td> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142<a href="../nn_gx/nngxSplitDrawCmdlist.html"><CODE>nngxSplitDrawCmdlist</CODE></a> 143 </th> 144<td>Splits the 3D command buffer for the current command list.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149<a href="../nn_gx/nngxClearCmdlist.html"><CODE>nngxClearCmdlist</CODE></a> 150 </th> 151<td>Clears commands accumulated in the current command list.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156<a href="../nn_gx/nngxClearFillCmdlist.html"><CODE>nngxClearFillCmdlist</CODE></a> 157 </th> 158<td>Uses the specified value to clear commands accumulated in the current command list.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163<a href="../nn_gx/nngxSetCmdlistCallback.html"><CODE>nngxSetCmdlistCallback</CODE></a> 164 </th> 165<td>Sets the exit callback for the current command list.</td> 166 </tr> 167 <tr> 168 <td width="100"> </td> 169 <th> 170<a href="../nn_gx/nngxEnableCmdlistCallback.html"><CODE>nngxEnableCmdlistCallback</CODE></a> 171 </th> 172<td>Enables an exit callback in the current command list.</td> 173 </tr> 174 <tr> 175 <td width="100"> </td> 176 <th> 177<a href="../nn_gx/nngxDisableCmdlistCallback.html"><CODE>nngxDisableCmdlistCallback</CODE></a> 178 </th> 179<td>Disables an exit callback in the current command list.</td> 180 </tr> 181 <tr> 182 <td width="100"> </td> 183 <th> 184<a href="../nn_gx/nngxSetCmdlistParameteri.html"><CODE>nngxSetCmdlistParameteri</CODE></a> 185 </th> 186<td>Sets a parameter for the current command list.</td> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191<a href="../nn_gx/nngxGetCmdlistParameteri.html"><CODE>nngxGetCmdlistParameteri</CODE></a> 192 </th> 193<td>Gets a parameter value (<SPAN class="argument">param</SPAN>) configured for the current command list.</td> 194 </tr> 195 <tr> 196 <td width="100"> </td> 197 <th> 198<a href="../nn_gx/nngxWaitCmdlistDone.html"><CODE>nngxWaitCmdlistDone</CODE></a> 199 </th> 200<td>Waits for the currently running command list object to finish.</td> 201 </tr> 202 <tr> 203 <td width="100"> </td> 204 <th> 205<a href="../nn_gx/nngxSetTimeout.html"><CODE>nngxSetTimeout</CODE></a> 206 </th> 207<td>Configures the <CODE>nngxWaitCmdlistDone</CODE> function to time out after the specified time.</td> 208 </tr> 209 <tr> 210 <td width="100"> </td> 211 <th> 212<a href="../nn_gx/nngxSetGasAutoAccumulationUpdate.html"><CODE>nngxSetGasAutoAccumulationUpdate</CODE></a> 213 </th> 214<td>Updates the additive blending results from gas density rendering.</td> 215 </tr> 216 <tr> 217<th class="category" colspan="3">V-Sync Control</th> 218 </tr> 219 <tr> 220 <td width="100"> </td> 221 <th> 222<a href="../nn_gx/nngxCheckVSync.html"><CODE>nngxCheckVSync</CODE></a> 223 </th> 224<td>Gets the V-Sync counter.</td> 225 </tr> 226 <tr> 227 <td width="100"> </td> 228 <th> 229<a href="../nn_gx/nngxWaitVSync.html"><CODE>nngxWaitVSync</CODE></a> 230 </th> 231<td>Synchronizes with the V-Sync and then returns.</td> 232 </tr> 233 <tr> 234 <td width="100"> </td> 235 <th> 236<a href="../nn_gx/nngxSetVSyncCallback.html"><CODE>nngxSetVSyncCallback</CODE></a> 237 </th> 238<td>Registers the V-Sync callback.</td> 239 </tr> 240 <tr> 241<th class="category" colspan="3">Display Buffer Control</th> 242 </tr> 243 <tr> 244 <td width="100"> </td> 245 <th> 246<a href="../nn_gx/nngxGenDisplaybuffers.html"><CODE>nngxGenDisplaybuffers</CODE></a> 247 </th> 248<td>Generates display buffer objects.</td> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253<a href="../nn_gx/nngxDeleteDisplaybuffers.html"><CODE>nngxDeleteDisplaybuffers</CODE></a> 254 </th> 255<td>Deletes display buffer objects.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260<a href="../nn_gx/nngxActiveDisplay.html"><CODE>nngxActiveDisplay</CODE></a> 261 </th> 262<td>Activates a display target.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267<a href="../nn_gx/nngxBindDisplaybuffer.html"><CODE>nngxBindDisplaybuffer</CODE></a> 268 </th> 269<td>Binds a display buffer to the active display target.</td> 270 </tr> 271 <tr> 272 <td width="100"> </td> 273 <th> 274<a href="../nn_gx/nngxDisplaybufferStorage.html"><CODE>nngxDisplaybufferStorage</CODE></a> 275 </th> 276<td>Allocates a region for the display buffer bound to the active display target.</td> 277 </tr> 278 <tr> 279 <td width="100"> </td> 280 <th> 281<a href="../nn_gx/nngxDisplayEnv.html"><CODE>nngxDisplayEnv</CODE></a> 282 </th> 283<td>Sets the display position in the active display target.</td> 284 </tr> 285 <tr> 286 <td width="100"> </td> 287 <th> 288<a href="../nn_gx/nngxTransferRenderImage.html"><CODE>nngxTransferRenderImage</CODE></a> 289 </th> 290<td>Transfers images from the current color buffer to the display buffer specified by <SPAN class="argument">buffer</SPAN>.</td> 291 </tr> 292 <tr> 293 <td width="100"> </td> 294 <th> 295<a href="../nn_gx/nngxSwapBuffers.html"><CODE>nngxSwapBuffers</CODE></a> 296 </th> 297<td>Presets the display buffer bound to the <SPAN class="argument">display</SPAN> to be shown.</td> 298 </tr> 299 <tr> 300 <td width="100"> </td> 301 <th> 302<a href="../nn_gx/nngxGetDisplaybufferParameteri.html"><CODE>nngxGetDisplaybufferParameteri</CODE></a> 303 </th> 304<td>Gets a parameter value configured for the display buffer bound to the active display target.</td> 305 </tr> 306 <tr> 307<th class="category" colspan="3">Command Cache Operations</th> 308 </tr> 309 <tr> 310 <td width="100"> </td> 311 <th> 312<a href="../nn_gx/nngxStartCmdlistSave.html"><CODE>nngxStartCmdlistSave</CODE></a> 313 </th> 314<td>Starts saving command list objects.</td> 315 </tr> 316 <tr> 317 <td width="100"> </td> 318 <th> 319<a href="../nn_gx/nngxStopCmdlistSave.html"><CODE>nngxStopCmdlistSave</CODE></a> 320 </th> 321<td>Stops saving command list objects.</td> 322 </tr> 323 <tr> 324 <td width="100"> </td> 325 <th> 326<a href="../nn_gx/nngxUseSavedCmdlist.html"><CODE>nngxUseSavedCmdlist</CODE></a> 327 </th> 328<td>Adds saved commands to the current command request.</td> 329 </tr> 330 <tr> 331 <td width="100"> </td> 332 <th> 333<a href="../nn_gx/nngxExportCmdlist.html"><CODE>nngxExportCmdlist</CODE></a> 334 </th> 335<td>Exports the specified command list as binary data in memory.</td> 336 </tr> 337 <tr> 338 <td width="100"> </td> 339 <th> 340<a href="../nn_gx/nngxImportCmdlist.html"><CODE>nngxImportCmdlist</CODE></a> 341 </th> 342<td>Imports an exported command list (binary data) to the specified command list.</td> 343 </tr> 344 <tr> 345 <td width="100"> </td> 346 <th> 347<a href="../nn_gx/nngxCopyCmdlist.html"><CODE>nngxCopyCmdlist</CODE></a> 348 </th> 349<td>Copies a command list object to another command list object.</td> 350 </tr> 351 <tr> 352 <td width="100"> </td> 353 <th> 354<a href="../nn_gx/nngxValidateState.html"><CODE>nngxValidateState</CODE></a> 355 </th> 356<td>Checks the state and generates commands.</td> 357 </tr> 358 <tr> 359 <td width="100"> </td> 360 <th> 361<a href="../nn_gx/nngxUpdateState.html"><CODE>nngxUpdateState</CODE></a> 362 </th> 363<td>Updates the specified states.</td> 364 </tr> 365 <tr> 366 <td width="100"> </td> 367 <th> 368<a href="../nn_gx/nngxGetExportedCmdlistInfo.html"><CODE>nngxGetExportedCmdlistInfo</CODE></a> 369 </th> 370<td>Gets information about an exported command list (binary data).</td> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375<a href="../nn_gx/nngxSetCommandGenerationMode.html"><CODE>nngxSetCommandGenerationMode</CODE></a> 376 </th> 377<td>Sets the command output mode.</td> 378 </tr> 379 <tr> 380 <td width="100"> </td> 381 <th> 382<a href="../nn_gx/nngxGetCommandGenerationMode.html"><CODE>nngxGetCommandGenerationMode</CODE></a> 383 </th> 384<td>Gets the command output mode.</td> 385 </tr> 386 <tr> 387 <td width="100"> </td> 388 <th> 389<a href="../nn_gx/nngxAdd3DCommand.html"><CODE>nngxAdd3DCommand</CODE></a> 390 </th> 391<td>Adds the data (the 3D command) in the specified region to the current 3D command buffer.</td> 392 </tr> 393 <tr> 394 <td width="100"> </td> 395 <th> 396<a href="../nn_gx/nngxAddCmdlist.html"><CODE>nngxAddCmdlist</CODE></a> 397 </th> 398<td>Adds the content of the specified command list object to the current command list object.</td> 399 </tr> 400 <tr> 401 <td width="100"> </td> 402 <th> 403<a href="../nn_gx/nngxGetUpdatedState.html"><CODE>nngxGetUpdatedState</CODE></a> 404 </th> 405<td>Gets the updated DMPGL states.</td> 406 </tr> 407 <tr> 408 <td width="100"> </td> 409 <th> 410<a href="../nn_gx/nngxInvalidateState.html"><CODE>nngxInvalidateState</CODE></a> 411 </th> 412<td>Disables updates for the specified DMPGL states.</td> 413 </tr> 414 <tr> 415<th class="category" colspan="3">Issuance of Low-level Command Requests</th> 416 </tr> 417 <tr> 418 <td width="100"> </td> 419 <th> 420<a href="../nn_gx/nngxAddVramDmaCommand.html"><CODE>nngxAddVramDmaCommand</CODE></a> 421 </th> 422<td>Issues a DMA transfer command to the current command list.</td> 423 </tr> 424 <tr> 425 <td width="100"> </td> 426 <th> 427<a href="../nn_gx/nngxTransferLinearImage.html"><CODE>nngxTransferLinearImage</CODE></a> 428 </th> 429<td>Adds a command to transfer an image to the specified render buffer or texture.</td> 430 </tr> 431 <tr> 432 <td width="100"> </td> 433 <th> 434<a href="../nn_gx/nngxFilterBlockImage.html"><CODE>nngxFilterBlockImage</CODE></a> 435 </th> 436<td>Issues a command to antialias-filter and transfer a block image.</td> 437 </tr> 438 <tr> 439 <td width="100"> </td> 440 <th> 441<a href="../nn_gx/nngxAddL2BTransferCommand.html"><CODE>nngxAddL2BTransferCommand</CODE></a> 442 </th> 443<td>Adds a command to convert from a linear image into a block image and then to transfer it.</td> 444 </tr> 445 <tr> 446 <td width="100"> </td> 447 <th> 448<a href="../nn_gx/nngxAddB2LTransferCommand.html"><CODE>nngxAddB2LTransferCommand</CODE></a> 449 </th> 450<td>Adds a command to convert from a block image to a linear image and then to transfer it.</td> 451 </tr> 452 <tr> 453 <td width="100"> </td> 454 <th> 455<a href="../nn_gx/nngxAddBlockImageCopyCommand.html"><CODE>nngxAddBlockImageCopyCommand</CODE></a> 456 </th> 457<td>Adds a block image transfer command.</td> 458 </tr> 459 <tr> 460 <td width="100"> </td> 461 <th> 462<a href="../nn_gx/nngxAddMemoryFillCommand.html"><CODE>nngxAddMemoryFillCommand</CODE></a> 463 </th> 464<td>Adds a memory fill command.</td> 465 </tr> 466 <tr> 467 <td width="100"> </td> 468 <th> 469<a href="../nn_gx/nngxFlush3DCommand.html">nngxFlush3DCommand</a> 470 </th> 471<td>Issues a 3D execution command and flushes the accumulated 3D command buffer.</td> 472 </tr> 473 <tr> 474<th class="category" colspan="3">Support of Direct Generation of 3D Command Buffer</th> 475 </tr> 476 <tr> 477 <td width="100"> </td> 478 <th> 479<a href="../nn_gx/nngxGetPhysicalAddr.html">nngxGetPhysicalAddr</a> 480 </th> 481<td>Converts a virtual address into a physical address. </td> 482 </tr> 483 <tr> 484 <td width="100"> </td> 485 <th> 486<a href="../nn_gx/nngxUpdateBuffer.html">nngxUpdateBuffer</a> 487 </th> 488<td>Applies to the graphics processor the updates that have been made to the contents of the vertex buffer and texture buffer in main memory. </td> 489 </tr> 490 <tr> 491 <td width="100"> </td> 492 <th> 493<a href="../nn_gx/nngxMoveCommandbufferPointer.html">nngxMoveCommandbufferPointer</a> 494 </th> 495<td>Moves the current output-destination pointer of the 3D command buffer.</td> 496 </tr> 497 <tr> 498<th class="category" colspan="3">Upper Screen Display Mode Settings</th> 499 </tr> 500 <tr> 501 <td width="100"> </td> 502 <th> 503<a href="../nn_gx/nngxSetDisplayMode.html"><CODE>nngxSetDisplayMode</CODE></a> 504 </th> 505<td>Sets the display mode for the upper screen.</td> 506 </tr> 507 <tr> 508<th class="category" colspan="3">Other</th> 509 </tr> 510 <tr> 511 <td width="100"> </td> 512 <th> 513<a href="../nn_gx/nngxStartLcdDisplay.html"><CODE>nngxStartLcdDisplay</CODE></a> 514 </th> 515<td>Starts displaying an image on an LCD display.</td> 516 </tr> 517 <tr> 518 <td width="100"> </td> 519 <th> 520<a href="../nn_gx/nngxSetMemAccessPrioMode.html"><CODE>nngxSetMemAccessPrioMode</CODE></a> 521 </th> 522<td>Sets priority of access to main memory (FCRAM).</td> 523 </tr> 524 <tr> 525 <td width="100"> </td> 526 <th> 527<a href="../nn_gx/nngxIsStereoVisionAllowed.html"><CODE>nngxIsStereoVisionAllowed</CODE></a> 528 </th> 529<td>Gets whether stereoscopic display is allowed.</td> 530 </tr> 531 <tr> 532 <td width="100"> </td> 533 <th> 534<a href="../nn_gx/nngxGetVramStartAddr.html"><CODE>nngxGetVramStartAddr</CODE></a> 535 </th> 536<td>Gets the starting address of the specified VRAM region.</td> 537 </tr> 538 <tr> 539 <td width="100"> </td> 540 <th> 541<a href="../nn_gx/nngxGetVramEndAddr.html"><CODE>nngxGetVramEndAddr</CODE></a> 542 </th> 543<td>Gets the ending address of the specified VRAM region.</td> 544 </tr> 545 <tr> 546 <td width="100"> </td> 547 <th> 548<a href="../nn_gx/nngxGetVramSize.html"><CODE>nngxGetVramSize</CODE></a> 549 </th> 550<td>Gets the size of the specified VRAM region.</td> 551 </tr> </table> 552 </div> 553 </a> 554<h2>Revision History</h2> 555 <div class="section"> 556 <dl class="history"> 557 <dt>2010/01/07</dt> 558<dd>Initial version.<br /> 559 </dd> 560 </dl> 561 </div> 562 <hr><p>CONFIDENTIAL</p></body> 563</html>