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>GXPeekZ</title> 10</head> 11 12<body> 13 14<h1 align="left">GXPeekZ</h1> 15 16 17<h2>C Specification</h2> 18 19<dl> 20<dd><PRE><CODE>#include <revolution/gx.h></CODE></PRE></dd> 21<dd><pre><CODE>void GXPeekZ( u16 x, u16 y, u32* z );</CODE></pre></dd> 22</dl> 23 24<h2>Arguments</h2> 25<TABLE border="1" cellpadding="3" cellspacing="0.1"> 26 <tr> 27<TD width="120" valign="top" bgcolor="#ffffe8"><CODE><em><strong>x</strong></em></font></TD> 28<TD width="520">The <em>x</em> coordinate, in pixels <CODE>0 <= <em>x</em> <= 639</CODE></TD> 29 </tr> 30 <tr> 31<TD width="120" valign="top" bgcolor="#ffffe8"><CODE><em><strong>y</strong></em></font></TD> 32<TD width="520">The <em>y</em> coordinate, in lines <CODE>0 <= <em>y</em> <= 527</CODE> </TD> 33 </tr> 34 <tr> 35<TD width="120" valign="top" bgcolor="#ffffe8"><CODE><em><strong>z</strong></em></font></TD> 36 <TD width="520"> 37Pointer to a returned Z value. Z value will be read from position (<em>x,y</em>) in the EFB.<br>Returned Z value will be in the range of 0x00000000 to 0x00FFFFFF. 38 39</TD> 40 </tr> 41</TABLE> 42<h2>Return Values</h2> 43 44<p>None.</p> 45<H2>Description</H2> 46<P>This function allows the CPU to read a <em><strong><code>z</code></strong></em> value directly from the Embedded Frame Buffer (EFB) at position <em><strong><code>x,y</code></strong></em>. The <code><em><strong>z</strong></em></code> value is the raw integer value from the Z buffer. The value range is 24-bit when reading from a non-antialiased frame buffer.</P> 47<P>When reading from an antialiased frame buffer, subsample 0 is read and returned. The value is in compressed 16-bit form. To convert the compressed value to a plain 24-bit integer, use <a href="GXDecompressZ16.html"><code>GXDecompressZ16</code></a>.</P> 48 49 50 51 52<h2>See Also</h2> 53<P><code><a href="GXPokeZ.html">GXPokeZ</a><br> <a href="GXDecompressZ16.html">GXDecompressZ16</a></code></P> 54<h2>Revision History</h2><P>2006/03/01 Initial version.</p> 55<hr> 56<P>CONFIDENTIAL</p> 57</BODY> 58</HTML>