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>GXCompressZ16</title>
10</head>
11
12<body>
13
14<h1 align="left">GXCompressZ16</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20u32 GXCompressZ16( u32 z24, <A href="../Enumerated_Types/GXZFmt16.html">GXZFmt16</A> zfmt );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH>z24</TH>
27<TD>24-bit Z value. 0x00000000 &lt;= <SPAN class="argument">z24</SPAN> &lt;= 0x00FFFFFF.</TD>
28  </tr>
29  <tr>
30<TH>zfmt</TH>
31<TD>Z compression format. Accepted values are:
32      <TABLE class="arguments" border="1" >
33          <tr>
34<TD bgcolor="#C0C0C0">Name</TD>
35<TD bgcolor="#C0C0C0">Z format</TD>
36          </tr>
37          <tr>
38<TH>GX_ZC_LINEAR</TH>
39<TD>16-bit linear.</TD>
40          </tr>
41          <tr>
42<TH>GX_ZC_NEAR</TH>
43<TD>Compressed format for smaller far/near ratio.</TD>
44          </tr>
45          <tr>
46<TH>GX_ZC_MID</TH>
47<TD>Compressed format for medium far/near ratio.</TD>
48          </tr>
49          <tr>
50<TH>GX_ZC_FAR</TH>
51<TD>Compressed format for large far/near ratio.</TD>
52          </tr>
53      </TABLE>
54      </TD>
55    </tr>
56</TABLE>
57
58<h2>Return Values</h2>
59<P>16-bit compressed Z value. Return type is u32 to match the argument of the <A href="GXPokeZ.html"><CODE>GXPokeZ</CODE></A> function.</P>
60
61<H2>Description</H2>
62<P>This auxiliary function is used to directly write the Z value to the 16-bit Z buffer, using the <A href="GXPokeZ.html"><CODE>GXPokeZ</CODE></A> function. The 24-bit value is compressed to a 16-bit value via the Z compression format specified by the argument <SPAN class="argument">zfmt</SPAN>.</P>
63
64<h2>See Also</h2>
65<P class="reference">
66<a href="GXPokeZ.html">GXPokeZ</a>,
67<a href="GXDecompressZ16.html">GXDecompressZ16</a>
68</p>
69
70<H2>Revision History</H2>
71<P>
722006/03/01 Initial version.<br>
73</P>
74
75<hr><p>CONFIDENTIAL</p></body>
76</HTML>