N64® Functions Menu

al - Audio Library Functions
gDP - DP GBI Macros
gdSP - General GBI Macros
gSP - SP GBI Macros
gt - Turbo Microcode RDP
gu - Graphics Utilities
Math - Math Functions
nuSys - NuSystem
os - N64 Operating System
sp - Sprite Library Functions
uh - Host to Target IO
64DD - N64 Disk Drive

Nintendo® Confidential

   

guS2DEmuGBgRect1Cyc

Format
void guS2DEmuGBgRect1Cyc (Gfx **gdl_p,
   uObjBg *bg);
Arguments
  • gdl_p is the pointer to the pointer to the display list; it is automatically calculated.
  • bg is the pointer to the uObjBg data structure
What This Macro Does
This function uses the CPU to emulate the action of the S2DEX microcode macro gSPBgRect1Cyc. It is one of the following two new emulation functions that came with the S2DEX microcode that you can use to have the CPU emulate the S2DEX microcode:
  • guS2DEmuGBgRect1Cyc
  • guS2DEmuSetScissor
By using this function, you can replace this call:
gSPBgRect1Cyc(gdl++, bg)
with this call:
guS2DEmuGBgRect1Cyc (&gdl, bg)
See gSPBgRect1Cyc for an explanation of the bg argument.

To notify the main routine about a scissoring box setting and texture filter setting, you must call the guS2DEmuSetScissor function before calling this function (guS2DEmuBgRect1Cyc).

This function's resulting GBI code can be used in both S2DEX and the F3DEX series microcode. Because of this, one microcode can be processed to display both a scaled scrolling BG screen and a 3D model at the same time.

For detailed information on S2DEX microcode GBI macros and data structures, please see the "S2DEX Microcode" area of the N64 Programming Manual.

See Also
guS2DInitBg


Nintendo® Confidential

Warning: all information in this document is confidential and covered by a non-disclosure agreement. You are responsible for keeping this information confidential and protected. Nintendo will vigorously enforce this responsibility.


Copyright © 1998
Nintendo of America Inc. All rights reserved
Nintendo and N64 are registered trademarks of Nintendo
Last updated January 1998