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/nngxAddVramDmaCommand.html"><CODE>nngxAddVramDmaCommand</CODE></a> 206 </th> 207<td>Issues a DMA transfer command to the current command list.</td> 208 </tr> 209 <tr> 210 <td width="100"> </td> 211 <th> 212<a href="../nn_gx/nngxSetTimeout.html"><CODE>nngxSetTimeout</CODE></a> 213 </th> 214<td>Configures the <CODE>nngxWaitCmdlistDone</CODE> function to time out after the specified time.</td> 215 </tr> 216 <tr> 217 <td width="100"> </td> 218 <th> 219<a href="../nn_gx/nngxSetGasAutoAccumulationUpdate.html"><CODE>nngxSetGasAutoAccumulationUpdate</CODE></a> 220 </th> 221<td>Updates the additive blending results from gas density rendering.</td> 222 </tr> 223 <tr> 224 <td width="100"> </td> 225 <th> 226<a href="../nn_gx/nngxAddL2BTransferCommand.html"><CODE>nngxAddL2BTransferCommand</CODE></a> 227 </th> 228<td>Adds a command to convert from a linear image into a block image and then to transfer it.</td> 229 </tr> 230 <tr> 231 <td width="100"> </td> 232 <th> 233<a href="../nn_gx/nngxAddB2LTransferCommand.html"><CODE>nngxAddB2LTransferCommand</CODE></a> 234 </th> 235<td>Adds a command to convert from a block image to a linear image and then to transfer it.</td> 236 </tr> 237 <tr> 238 <td width="100"> </td> 239 <th> 240<a href="../nn_gx/nngxAddBlockImageCopyCommand.html"><CODE>nngxAddBlockImageCopyCommand</CODE></a> 241 </th> 242<td>Adds a block image transfer command.</td> 243 </tr> 244 <tr> 245 <td width="100"> </td> 246 <th> 247<a href="../nn_gx/nngxAddMemoryFillCommand.html"><CODE>nngxAddMemoryFillCommand</CODE></a> 248 </th> 249<td>Adds a memory fill command.</td> 250 </tr> 251 <tr> 252<th class="category" colspan="3">V-Sync Control</th> 253 </tr> 254 <tr> 255 <td width="100"> </td> 256 <th> 257<a href="../nn_gx/nngxCheckVSync.html"><CODE>nngxCheckVSync</CODE></a> 258 </th> 259<td>Gets the V-Sync counter.</td> 260 </tr> 261 <tr> 262 <td width="100"> </td> 263 <th> 264<a href="../nn_gx/nngxWaitVSync.html"><CODE>nngxWaitVSync</CODE></a> 265 </th> 266<td>Synchronizes with the V-Sync and then returns.</td> 267 </tr> 268 <tr> 269 <td width="100"> </td> 270 <th> 271<a href="../nn_gx/nngxSetVSyncCallback.html"><CODE>nngxSetVSyncCallback</CODE></a> 272 </th> 273<td>Registers the V-Sync callback.</td> 274 </tr> 275 <tr> 276<th class="category" colspan="3">Display Buffer Control</th> 277 </tr> 278 <tr> 279 <td width="100"> </td> 280 <th> 281<a href="../nn_gx/nngxGenDisplaybuffers.html"><CODE>nngxGenDisplaybuffers</CODE></a> 282 </th> 283<td>Generates display buffer objects.</td> 284 </tr> 285 <tr> 286 <td width="100"> </td> 287 <th> 288<a href="../nn_gx/nngxDeleteDisplaybuffers.html"><CODE>nngxDeleteDisplaybuffers</CODE></a> 289 </th> 290<td>Deletes display buffer objects.</td> 291 </tr> 292 <tr> 293 <td width="100"> </td> 294 <th> 295<a href="../nn_gx/nngxActiveDisplay.html"><CODE>nngxActiveDisplay</CODE></a> 296 </th> 297<td>Activates a display target.</td> 298 </tr> 299 <tr> 300 <td width="100"> </td> 301 <th> 302<a href="../nn_gx/nngxBindDisplaybuffer.html"><CODE>nngxBindDisplaybuffer</CODE></a> 303 </th> 304<td>Binds a display buffer to the active display target.</td> 305 </tr> 306 <tr> 307 <td width="100"> </td> 308 <th> 309<a href="../nn_gx/nngxDisplaybufferStorage.html"><CODE>nngxDisplaybufferStorage</CODE></a> 310 </th> 311<td>Allocates a region for the display buffer bound to the active display target.</td> 312 </tr> 313 <tr> 314 <td width="100"> </td> 315 <th> 316<a href="../nn_gx/nngxDisplayEnv.html"><CODE>nngxDisplayEnv</CODE></a> 317 </th> 318<td>Sets the display position in the active display target.</td> 319 </tr> 320 <tr> 321 <td width="100"> </td> 322 <th> 323<a href="../nn_gx/nngxTransferRenderImage.html"><CODE>nngxTransferRenderImage</CODE></a> 324 </th> 325<td>Transfers images from the current color buffer to the display buffer specified by <SPAN class="argument">buffer</SPAN>.</td> 326 </tr> 327 <tr> 328 <td width="100"> </td> 329 <th> 330<a href="../nn_gx/nngxSwapBuffers.html"><CODE>nngxSwapBuffers</CODE></a> 331 </th> 332<td>Presets the display buffer bound to the <SPAN class="argument">display</SPAN> to be shown.</td> 333 </tr> 334 <tr> 335 <td width="100"> </td> 336 <th> 337<a href="../nn_gx/nngxGetDisplaybufferParameteri.html"><CODE>nngxGetDisplaybufferParameteri</CODE></a> 338 </th> 339<td>Gets a parameter value configured for the display buffer bound to the active display target.</td> 340 </tr> 341 <tr> 342 <td width="100"> </td> 343 <th> 344<a href="../nn_gx/nngxTransferLinearImage.html"><CODE>nngxTransferLinearImage</CODE></a> 345 </th> 346<td>Adds a command to transfer an image to the specified render buffer or texture.</td> 347 </tr> 348 <tr> 349 <td width="100"> </td> 350 <th> 351<a href="../nn_gx/nngxFilterBlockImage.html"><CODE>nngxFilterBlockImage</CODE></a> 352 </th> 353<td>Issues a command to antialias-filter and transfer a block image.</td> 354 </tr> 355 <tr> 356<th class="category" colspan="3">Command Cache Operations</th> 357 </tr> 358 <tr> 359 <td width="100"> </td> 360 <th> 361<a href="../nn_gx/nngxStartCmdlistSave.html"><CODE>nngxStartCmdlistSave</CODE></a> 362 </th> 363<td>Starts saving command list objects.</td> 364 </tr> 365 <tr> 366 <td width="100"> </td> 367 <th> 368<a href="../nn_gx/nngxStopCmdlistSave.html"><CODE>nngxStopCmdlistSave</CODE></a> 369 </th> 370<td>Stops saving command list objects.</td> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375<a href="../nn_gx/nngxUseSavedCmdlist.html"><CODE>nngxUseSavedCmdlist</CODE></a> 376 </th> 377<td>Adds saved commands to the current command request.</td> 378 </tr> 379 <tr> 380 <td width="100"> </td> 381 <th> 382<a href="../nn_gx/nngxExportCmdlist.html"><CODE>nngxExportCmdlist</CODE></a> 383 </th> 384<td>Exports the specified command list as binary data in memory.</td> 385 </tr> 386 <tr> 387 <td width="100"> </td> 388 <th> 389<a href="../nn_gx/nngxImportCmdlist.html"><CODE>nngxImportCmdlist</CODE></a> 390 </th> 391<td>Imports an exported command list (binary data) to the specified command list.</td> 392 </tr> 393 <tr> 394 <td width="100"> </td> 395 <th> 396<a href="../nn_gx/nngxCopyCmdlist.html"><CODE>nngxCopyCmdlist</CODE></a> 397 </th> 398<td>Copies a command list object to another command list object.</td> 399 </tr> 400 <tr> 401 <td width="100"> </td> 402 <th> 403<a href="../nn_gx/nngxValidateState.html"><CODE>nngxValidateState</CODE></a> 404 </th> 405<td>Checks the state and generates commands.</td> 406 </tr> 407 <tr> 408 <td width="100"> </td> 409 <th> 410<a href="../nn_gx/nngxUpdateState.html"><CODE>nngxUpdateState</CODE></a> 411 </th> 412<td>Updates the specified states.</td> 413 </tr> 414 <tr> 415 <td width="100"> </td> 416 <th> 417<a href="../nn_gx/nngxGetExportedCmdlistInfo.html"><CODE>nngxGetExportedCmdlistInfo</CODE></a> 418 </th> 419<td>Gets information about an exported command list (binary data).</td> 420 </tr> 421 <tr> 422 <td width="100"> </td> 423 <th> 424<a href="../nn_gx/nngxSetCommandGenerationMode.html"><CODE>nngxSetCommandGenerationMode</CODE></a> 425 </th> 426<td>Sets the command output mode.</td> 427 </tr> 428 <tr> 429 <td width="100"> </td> 430 <th> 431<a href="../nn_gx/nngxGetCommandGenerationMode.html"><CODE>nngxGetCommandGenerationMode</CODE></a> 432 </th> 433<td>Gets the command output mode.</td> 434 </tr> 435 <tr> 436 <td width="100"> </td> 437 <th> 438<a href="../nn_gx/nngxAdd3DCommand.html"><CODE>nngxAdd3DCommand</CODE></a> 439 </th> 440<td>Adds the data (the 3D command) in the specified region to the current 3D command buffer.</td> 441 </tr> 442 <tr> 443 <td width="100"> </td> 444 <th> 445<a href="../nn_gx/nngxAddCmdlist.html"><CODE>nngxAddCmdlist</CODE></a> 446 </th> 447<td>Adds the content of the specified command list object to the current command list object.</td> 448 </tr> 449 <tr> 450 <td width="100"> </td> 451 <th> 452<a href="../nn_gx/nngxGetUpdatedState.html"><CODE>nngxGetUpdatedState</CODE></a> 453 </th> 454<td>Gets the updated DMPGL states.</td> 455 </tr> 456 <tr> 457 <td width="100"> </td> 458 <th> 459<a href="../nn_gx/nngxInvalidateState.html"><CODE>nngxInvalidateState</CODE></a> 460 </th> 461<td>Disables updates for the specified DMPGL states.</td> 462 </tr> 463 <tr> 464<th class="category" colspan="3">Upper Screen Display Mode Settings</th> 465 </tr> 466 <tr> 467 <td width="100"> </td> 468 <th> 469<a href="../nn_gx/nngxSetDisplayMode.html"><CODE>nngxSetDisplayMode</CODE></a> 470 </th> 471<td>Sets the display mode for the upper screen.</td> 472 </tr> 473 <tr> 474<th class="category" colspan="3">Other</th> 475 </tr> 476 <tr> 477 <td width="100"> </td> 478 <th> 479<a href="../nn_gx/nngxStartLcdDisplay.html"><CODE>nngxStartLcdDisplay</CODE></a> 480 </th> 481<td>Starts displaying an image on an LCD display.</td> 482 </tr> 483 <tr> 484 <td width="100"> </td> 485 <th> 486<a href="../nn_gx/nngxSetMemAccessPrioMode.html"><CODE>nngxSetMemAccessPrioMode</CODE></a> 487 </th> 488<td>Sets priority of access to main memory (FCRAM).</td> 489 </tr> 490 <tr> 491 <td width="100"> </td> 492 <th> 493<a href="../nn_gx/nngxIsStereoVisionAllowed.html"><CODE>nngxIsStereoVisionAllowed</CODE></a> 494 </th> 495<td>Gets whether stereoscopic display is allowed.</td> 496 </tr> 497 <tr> 498 <td width="100"> </td> 499 <th> 500<a href="../nn_gx/nngxGetVramStartAddr.html"><CODE>nngxGetVramStartAddr</CODE></a> 501 </th> 502<td>Gets the starting address of the specified VRAM region.</td> 503 </tr> 504 <tr> 505 <td width="100"> </td> 506 <th> 507<a href="../nn_gx/nngxGetVramEndAddr.html"><CODE>nngxGetVramEndAddr</CODE></a> 508 </th> 509<td>Gets the ending address of the specified VRAM region.</td> 510 </tr> 511 <tr> 512 <td width="100"> </td> 513 <th> 514<a href="../nn_gx/nngxGetVramSize.html"><CODE>nngxGetVramSize</CODE></a> 515 </th> 516<td>Gets the size of the specified VRAM region.</td> 517 </tr> </table> 518 </div> 519 </a> 520<h2>Revision History</h2> 521 <div class="section"> 522 <dl class="history"> 523 <dt>2010/01/07</dt> 524<dd>Initial version.<br /> 525 </dd> 526 </dl> 527 </div> 528 <hr><p>CONFIDENTIAL</p></body> 529</html>