1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="Microsoft FrontPage 5.0">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8<TITLE>GXTexFmt</TITLE>
9</HEAD>
10<BODY>
11<H1 align="left">GXTexFmt</H1>
12
13<H2>Enumerated Types</H2>
14<DIV align="left">
15<TABLE border="0" width="100%">
16  <TBODY>
17    <TR>
18      <TD width="100%"><CODE>GX_TF_I4</CODE></TD>
19    </TR>
20    <TR>
21      <TD width="100%"><CODE>GX_TF_I8</CODE></TD>
22    </TR>
23  <TR>
24      <TD width="100%"><CODE>GX_TF_IA4</CODE></TD>
25    </TR>
26    <TR>
27      <TD width="100%"><CODE>GX_TF_IA8</CODE></TD>
28    </TR>
29    <TR>
30      <TD width="100%"><CODE>GX_TF_RGB565</CODE></TD>
31    </TR>
32    <TR>
33      <TD width="100%"><CODE>GX_TF_RGB5A3</CODE></TD>
34    </TR>
35    <TR>
36      <TD width="100%"><CODE>GX_TF_RGBA8</CODE></TD>
37    </TR>
38    <TR>
39      <TD width="100%"><CODE>GX_TF_CMPR</CODE></TD>
40    </TR>
41    <TR>
42      <TD width="100%"><CODE>GX_TF_Z8</CODE></TD>
43    </TR>
44    <TR>
45      <TD width="100%"><CODE>GX_TF_Z16</CODE></TD>
46    </TR>
47    <TR>
48      <TD width="100%"><CODE>GX_TF_Z24X8</CODE></TD>
49    </TR>
50    <TR>
51      <TD width="100%"><CODE>GX_CTF_R4</CODE></TD>
52    </TR>
53    <TR>
54      <TD width="100%"><CODE>GX_CTF_RA4</CODE></TD>
55    </TR>
56    <TR>
57      <TD width="100%"><CODE>GX_CTF_RA8</CODE></TD>
58    </TR>
59    <TR>
60      <TD width="100%"><CODE>GX_CTF_A8</CODE></TD>
61    </TR>
62    <TR>
63      <TD width="100%"><CODE>GX_CTF_R8</CODE></TD>
64    </TR>
65    <TR>
66      <TD width="100%"><CODE>GX_CTF_G8</CODE></TD>
67    </TR>
68    <TR>
69      <TD width="100%"><CODE>GX_CTF_B8</CODE></TD>
70    </TR>
71    <TR>
72      <TD width="100%"><CODE>GX_CTF_RG8</CODE></TD>
73    </TR>
74    <TR>
75      <TD width="100%"><CODE>GX_CTF_GB8</CODE></TD>
76    </TR>
77    <TR>
78      <TD width="100%"><CODE>GX_CTF_Z4</CODE></TD>
79    </TR>
80    <TR>
81      <TD width="100%"><CODE>GX_CTF_Z8M</CODE></TD>
82    </TR>
83    <TR>
84      <TD width="100%"><CODE>GX_CTF_Z8L</CODE></TD>
85    </TR>
86    <TR>
87      <TD width="100%"><CODE>GX_CTF_Z16L</CODE></TD>
88    </TR>
89  </TBODY>
90</TABLE>
91</DIV>
92
93<H2>Description</H2>
94<P>RGB, RGBA, Intensity, Intensity/Alpha, Compressed, and Z texture format types. See <A href="GXCITexFmt.html"><CODE>GXCITexFmt</CODE></A> for information on color index formats.</P>
95<P>The CTF format is used only by the <A href="../Framebuffer/GXSetTexCopyDst.html"><CODE>GXSetTexCopyDst</CODE></A> function to specify how data is copied out of the EFB into a texture in main memory. In order to actually use that texture, you must specify a non-copy format of matching size.&nbsp;For example, if copying using <CODE>GX_CTF_RG8</CODE>, you would apply the resulting texture using <CODE>GX_TF_IA8</CODE>.</P>
96<TABLE class="arguments" border="1" >
97  <TBODY>
98    <TR>
99<TH>GX_TF_I4</TH>
100<TD>4-bit intensity</TD>
101    </TR>
102    <TR>
103<TH>GX_TF_I8</TH>
104<TD>8-bit intensity</TD>
105    </TR>
106    <TR>
107<TH>GX_TF_A8</TH>
108<TD>8-bit alpha.</TD>
109    </TR>
110    <TR>
111<TH>GX_TF_IA4</TH>
112<TD>8-bit intensity + alpha (4+4).</TD>
113    </TR>
114    <TR>
115<TH>GX_TF_IA8</TH>
116<TD>16-bit intensity + alpha (8+8).</TD>
117    </TR>
118    <TR>
119<TH>GX_TF_RGB565</TH>
120<TD>16-bit RGB.</TD>
121    </TR>
122    <TR>
123<TH>GX_TF_RGB5A3</TH>
124<TD>When MSB=1, RGB555 format (opaque), and when MSB=0, RGBA4443 format (transparent).</TD>
125    </TR>
126    <TR>
127<TH>GX_TF_RGBA8</TH>
128<TD>32-bit RGB.</TD>
129    </TR>
130    <TR>
131<TH>GX_TF_CMPR</TH>
132<TD>Compressed 4-bit texel.</TD>
133    </TR>
134    <TR>
135<TH>GX_TF_Z8</TH>
136<TD>Unsigned 8-bit Z. For texture copies, specify the upper 8 bits of Z.</TD>
137    </TR>
138    <TR>
139<TH>GX_TF_Z16</TH>
140<TD>Unsigned 16-bit Z. For texture copies, specify the upper 16 bits of Z.</TD>
141    </TR>
142    <TR>
143<TH>GX_TF_Z24X8</TH>
144<TD>Unsigned 24-bit (32-bit texture) Z. For texture copies, copy the 24-bit Z and <CODE>0xff</CODE>.</TD>
145    </TR>
146    <TR>
147<TH>GX_CTF_R4</TH>
148<TD>4-bit red. For copying 4 bits from red.</TD>
149    </TR>
150    <TR>
151<TH>GX_CTF_RA4</TH>
152<TD>4-bit red + 4-bit alpha. For copying 4 bits from red, 4 bits from alpha.</TD>
153    </TR>
154    <TR>
155<TH>GX_CTF_RA8</TH>
156<TD>8-bit red + 8-bit alpha. For copying 8 bits from red, 8 bits from alpha.</TD>
157    </TR>
158    <TR>
159<TH>GX_CTF_A8</TH>
160<TD>8-bit alpha. For copying 8 bits from alpha.</TD>
161    </TR>
162    <TR>
163<TH>GX_CTF_R8</TH>
164<TD>8-bit red. For copying 8 bits from red.</TD>
165    </TR>
166    <TR>
167<TH>GX_CTF_G8</TH>
168<TD>8-bit green. For copying 8 bits from green.</TD>
169    </TR>
170    <TR>
171<TH>GX_CTF_B8</TH>
172<TD>8-bit blue. For copying 8 bits from blue.</TD>
173    </TR>
174    <TR>
175<TH>GX_CTF_RG8</TH>
176<TD>8-bit red +8-bit green. For copying 8 bits from red, 8 bits from green.</TD>
177    </TR>
178    <TR>
179<TH>GX_CTF_GB8</TH>
180<TD>8-bit green +8-bit blue. For copying 8 bits from green, 8 bits from blue.</TD>
181    </TR>
182    <TR>
183<TH>GX_CTF_Z4</TH>
184<TD>4-bit Z. For copying the 4 upper bits from Z.</TD>
185    </TR>
186    <TR>
187<TH>GX_CTF_Z8M</TH>
188<TD>8-bit Z (median byte). For copying the middle 8 bits of Z.</TD>
189    </TR>
190    <TR>
191<TH>GX_CTF_Z8L</TH>
192<TD>8-bit Z (lower byte). For copying the lower 8 bits of Z.</TD>
193    </TR>
194    <TR>
195<TH>GX_CTF_Z16L</TH>
196<TD>16-bit Z (lower portion). For copying the lower 16 bits of Z.</TD>
197    </TR>
198  </TBODY>
199</TABLE>
200
201<H2>Functions Using This Type</H2>
202<P class="reference">
203<A href="../Texture/GXInitTexObj.html">GXInitTexObj</A>,
204<A href="../Framebuffer/GXSetTexCopyDst.html">GXSetTexCopyDst</A>,
205<A href="../Tev/GXSetZTexture.html">GXSetZTexture</A>
206</P>
207
208<H2>Revision History</H2>
209<P>
2102006/03/01 Initial version.<br>
211</P>
212
213<hr><p>CONFIDENTIAL</p></body>
214</HTML>