1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>GXSetScissor</title>
10</head>
11
12<body>
13
14<h1 align="left">GXSetScissor</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20void GXSetScissor(
21    u32 xOrig,
22    u32 yOrig,
23    u32 wd,
24    u32 ht);
25</pre></dd></dl>
26
27<h2>Arguments</h2>
28<TABLE class="arguments" border="1" >
29  <tr>
30<TH>xOrig</TH>
31<TD>Scissor box's leftmost coordinate in screen coordinates.</TD>
32    </tr>
33  <tr>
34<TH>yOrig</TH>
35<TD>Scissor box's topmost coordinate in screen coordinates.</TD>
36    </tr>
37  <tr>
38<TH>wd</TH>
39<TD>Scissor box's width in screen coordinates.</TD>
40    </tr>
41  <tr>
42<TH>ht</TH>
43<TD>Scissor box's height in screen coordinates.</TD>
44    </tr>
45</TABLE>
46
47<h2>Return Values</h2>
48<p>None.</p>
49
50<H2>Description</H2>
51<P>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 (<SPAN class="argument">xOrig</SPAN> = 0, <SPAN class="argument">yOrig</SPAN> = 0) is at the top left corner of the display.</P>
52<P>Values in the range [ <SPAN class="argument">xOrig</SPAN> + <SPAN class="argument">wd</SPAN> < 1706 ] and [ <SPAN class="argument">yOrig</SPAN> + <SPAN class="argument">ht</SPAN> < 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 <A href="GXSetScissorBoxOffset.html"><CODE>GXSetScissorBoxOffset</CODE></A> command.</P>
53<P>By default, the scissor box is set to match the viewport rectangle.&nbsp;<a href="../Management/GXInit.html"><code>GXInit</code></a> initializes the scissor box to match the viewport given the current <a href="../Framebuffer/RenderMode.html">render mode</a>.</P>
54
55<h2>See Also</h2>
56<P>
57<A href="GXSetScissorBoxOffset.html"><CODE>GXSetScissorBoxOffset</CODE></A><BR> <A href="../Transform/GXSetViewport.html"><CODE>GXSetViewport</CODE></A><BR> <A href="../Transform/GXSetViewportJitter.html"><CODE>GXSetViewportJitter</CODE></A>
58</p>
59
60<H2>Revision History</H2>
61<P>
622009/01/14 Changed the range of values that can be acquired for scissor box coordinates.<br>2006/03/01 Initial version.
63</P>
64
65<hr><p>CONFIDENTIAL</p></body>
66</HTML>