GXPokeZ

C Specification

#include <revolution/gx.h>
void GXPokeZ( u16 x, u16 y, u32 z );

Arguments

x The x coordinate, in pixels (0 - 639).
y The y coordinate, in lines (0 - 527).
z Integer z value to write at position (x,y) in the EFB. 0x00000000 <= z <= 0x00FFFFFF.

Return Values

None.

Description

This function allows the CPU to write a z value directly to the Embedded Frame Buffer (EFB) at position x,y. The z value can be compared with the current contents of the EFB. The Z compare fuction is set using GXPokeZMode. The z value should be in the range of 0x00000000 to 0x00FFFFFF for the non-antialiased frame buffer.

For an antialiased frame buffer, the z value should be in the compressed 16-bit format (0x00000000 - 0x0000FFFF) and the poke will affect all three subsamples of a pixel. To convert a 24-bit integer value into compressed 16-bit form, use GXCompressZ16.

See Also

GXPeekZ
GXCompressZ16

Revision History

03/01/2006 Initial version.