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