GXSetScissor

Syntax

#include <revolution/gx.h>

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

Arguments

xOrig Scissor box's leftmost coordinate in screen coordinates.
yOrig Scissor box's topmost coordinate in screen coordinates.
wd Scissor box's width in screen coordinates.
ht 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.

Values in the range [ xOrig + wd < 1706 ] and [ yOrig + ht < 1706 ] can be acquired. 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

2009/01/14 Changed the range of values that can be acquired for scissor box coordinates.
2006/03/01 Initial version.


CONFIDENTIAL