osViBlack

Syntax

#include <ultra64.h> /* os.h */ void osViBlack(u8 active);

Arguments

• active
  Blackout flag
  TRUE (Set blackout)
  FALSE (Cancel blackout)

Return Value
None

Explanation
Allows the screen to be blacked out. Blacks out the screen after osViBlack is executed at the time that the first vertical retrace interrupt is generated. Vertical retrace signals continue to be generated while the screen is blacked out.

Cautions
If the coefficient for Y scale processing (yscale) is set to anything other than 1.0 with osViSetYScale when osViBlack is executed, return it to 1.0. In some instances, a reset will have no effect. Also, be sure to execute osViBlack after osCreateViManager.

Example

//  Starting VI manager & Blackout
        osCreateViManager(OS_PRIORITY_VIMGR);
#if (SCREEN_WD==320)&&(SCREEN_HT==240)    // Setting for low resolution
        osViSetMode(&osViModeNtscLan1);
#elif (SCREEN_WD==640)&&(SCREEN_HT==480)  // Setting for high resolution
        osViSetMode(&osViModeNtscHaf1]);
#else
#error  "Illegal Screen size"
#endif
        osViBlack(TRUE);

See Also
osViSetYScale

Revision History
2/1/1999 Completely rewritten

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 March 1998