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>C Specification</h2>
17
18<dl>
19  <dd><pre><CODE>#include &lt;revolution/gx.h&gt;</CODE></pre>
20  </dd>
21  <dd><pre><CODE>void GXSetScissor(
22    u32 xOrig,
23    u32 yOrig,
24    u32 wd,
25    u32 ht);</CODE></pre>
26  </dd>
27</dl>
28
29<h2>Arguments</h2>
30<TABLE border="1" cellpadding="3" cellspacing="0.1">
31  <tr>
32<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>xOrig</font></strong></em></TD>
33<TD width="520">Scissorbox left-most coordinate in screen coordinates.</TD>
34    </tr>
35  <tr>
36<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>yOrig</font></strong></em></TD>
37<TD width="520">The scissor box's top-most coordinate in screen coordinates.</TD>
38    </tr>
39  <tr>
40<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>wd</font></strong></em></TD>
41<TD width="520">The scissor box's width in screen coordinates.</TD>
42    </tr>
43  <tr>
44<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>ht</font></strong></em></TD>
45<TD width="520">The scissor box's height in screen coordinates.</TD>
46    </tr>
47</TABLE>
48<h2>Return Values</h2>
49
50<p>None.</p>
51<H2>Description</H2>
52<P>The scissor box specifies an area of the screen where primitives are not culled.&nbsp;This function sets the scissor box in screen coordinates. The screen origin (<code><em><strong>xOrig</strong></em></code>=0, <code><em><strong>yOrig</strong></em></code>=0) is at the top left corner of the display.</P>
53<P>The values may range within [0 ... 2047]. Using values that extend beyond the EFB size is allowable since the scissor box may be repositioned within the EFB using the command <a href="GXSetScissorBoxOffset.html"><code>GXSetScissorBoxOffset</code></a>.</P>
54<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>
55<h2>See Also</h2>
56
57<p><a href="GXSetScissorBoxOffset.html">GXSetScissorBoxOffset</a><br> <a href="../Transform/GXSetViewport.html">GXSetViewport</a><br> <a href="../Transform/GXSetViewportJitter.html">GXSetViewportJitter</a></p>
58<H2>Revision History</H2>
59<P>2006/03/01 Initial version.</P>
60<hr>
61<P>CONFIDENTIAL</p>
62</BODY>
63</HTML>
64