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>GXPeekARGB</title>
10</head>
11
12<body>
13
14<h1 align="left">GXPeekARGB</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/gx.h&gt;
19
20void GXPeekARGB( u16 x, u16 y, u32* color );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH>x</TH>
27<TD>The x coordinate, in pixels; 0 &lt;= <SPAN class="argument">x</SPAN> &lt;= 639</TD>
28  </tr>
29  <tr>
30<TH>y</TH>
31<TD>The y coordinate, in lines; 0 &lt;= <SPAN class="argument">y</SPAN> &lt;= 527</TD>
32  </tr>
33  <tr>
34<TH>color</TH>
35<TD>Pointer to a u32. Color read is in ARGB format, eight bits per component.</TD>
36  </tr>
37</TABLE>
38
39<h2>Return Values</h2>
40<p>None.</p>
41
42<H2>Description</H2>
43<P>This function allows the CPU to read a <SPAN class="argument">color</SPAN> value directly from the embedded frame buffer (EFB) at position <SPAN class="argument">x</SPAN>, <SPAN class="argument">y</SPAN>.</P>
44<P>For an anti-aliased frame buffer, only the subsample of a pixel is read.&nbsp;The returned color is in 32-bit format.</P>
45
46<h2>See Also</h2>
47<P class="reference">
48<A href="GXPeekZ.html">GXPeekZ</A>,
49<A href="GXPokeARGB.html">GXPokeARGB</A>,
50<A href="GXPokeAlphaRead.html">GXPokeAlphaRead</A>
51</P>
52
53<h2>Revision History</h2>
54<P>
552008/05/15 Added <CODE>GXPokeAlphaRead</CODE> to <B>See Also</B>.<br>2006/03/01 Initial version.<br>
56</P>
57
58<hr><p>CONFIDENTIAL</p></body>
59</HTML>