GXSetScissor

Syntax

#include <revolution/gx.h>

void GXSetScissor(
    u32 xOrig, 
    u32 yOrig, 
    u32 wd, 
    u32 ht);

Arguments

xOrig Scissor box left-most coordinate in screen coordinates.
yOrig The scissor box's top-most coordinate in screen coordinates.
wd The scissor box's width in screen coordinates.
ht The scissor box's height in screen coordinates.

Return Values

None.

Description

The scissor box specifies an area of the screen; any primitives that protrude from this area are culled. This function sets the scissor box in screen coordinates. The screen origin (xOrig = 0, yOrig = 0) is at the top left corner of the display.

The values may range from 0 to 2047. Using values that extend beyond the EFB size is allowable since the scissor box may be repositioned within the EFB using the GXSetScissorBoxOffset command.

By default, the scissor box is set to match the viewport rectangle. GXInit initializes the scissor box to match the viewport given the current render mode.

See Also

GXSetScissorBoxOffset, GXSetViewport, GXSetViewportJitter

Revision History

2006/03/01 Initial version.


CONFIDENTIAL