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>GXSetCopyClamp</title>
10</head>
11
12<body>
13
14<h1 align="left">GXSetCopyClamp</h1>
15
16
17<h2>C Specification</h2>
18
19<dl>
20<dd><PRE><CODE>#include &lt;revolution/gx.h&gt;</CODE></PRE></dd>
21<dd><pre><CODE>void GXSetCopyClamp( <a href="../Enumerated_Types/GXFBClamp.html">GXFBClamp</a> clamp );</CODE></pre></dd>
22</dl><h2>Arguments</h2>
23<TABLE border="1" cellpadding="3" cellspacing="0.1">
24  <tr>
25<TD width="120" bgcolor="#ffffe8"><em><strong><CODE>clamp</CODE></strong></em></TD>
26<TD width="520">clamp mode The OR bit of <CODE><A href="../Enumerated_Types/GXFBClamp.html">GXFBClamp</A></CODE>. Accepted values are:
27      <TABLE width="500" border="1" cellspacing="0.1">
28
29          <tr>
30<TD bgcolor="#C0C0C0" width="150">Name</TD>
31<TD bgcolor="#C0C0C0" width="350">where the clamp occurs</TD>
32          </tr>
33          <tr>
34<TD width="150"><code>GX_CLAMP_NONE</code></TD>
35<TD width="350">no clamping</TD>
36          </tr>
37          <tr>
38<TD width="150"><code>GX_CLAMP_TOP</code></TD>
39<TD width="350">the uppermost line</TD>
40          </tr>
41          <tr>
42<TD width="150"><code>GX_CLAMP_BOTTOM</code></TD>
43<TD width="350">the lowest line</TD>
44          </tr>
45          <tr>
46<TD height="25" width="150"><code>GX_CLAMP_TOP | GX_CLAMP_BOTTOM</code></TD>
47<TD height="25" width="350">both the uppermost and the lowest</TD>
48          </tr>
49
50      </TABLE>
51      </TD>
52    </tr>
53</TABLE>
54<h2>Return Values</h2>
55
56<p>None</p>
57<H2>Description</H2>
58<P>This function sets the vertical clamping mode to use during the Embedded Frame Buffer (EFB) to External Frame Buffer (XFB) or texture copy.</P>
59<P>If you use vertical filter (see <a href="GXSetCopyFilter.html"><code>GXSetCopyFilter</code></a>), the GP looks up contiguous three lines at the same time for filtering during copy. This means some data can come out of the region specified by <code><a href="GXSetDispCopySrc.html">GXSetDispCopySrc</a></code> or from <code><a href="GXSetTexCopySrc.html">GXSetTexCopySrc</a></code> when it copies the top-most line or bottom-most line. Vertical clamping avoids pulling samples from such out-of-regions. For example, usually the GP attempts to look up three lines <code>{top-1, top, top+1}</code> for copying the first line. But if clamping is working, the look-up becomes <code>{top, top, top+1}</code> and prevents the GP from looking up the line <code> (top-1)</code> which is out of region.</P>
60
61
62
63
64<h2>See Also</h2>
65
66<p><a href="GXCopyDisp.html">GXCopyDisp</a><br> <a href="GXCopyTex.html">GXCopyTex</a></p>
67<H2>Revision History</H2>
68<P>03/01/2006 Initial version</P></body>
69</html>