.TH guSprite2DInit 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
guSprite2DInit \- initializes a sprite data structure.
.SH C SPECIFICATION
.nf
\f3#include "gu.h"

void guSprite2DInit(uSprite *SpritePointer,   
		    void *SourceImagePointer,
		    void *TlutPointer,
		    short Stride,
		    short SubImageWidth,
		    short SubImageHeight,
		    char  SourceImageType,
		    char  SourceImageBitSize,
		    short SourceImageOffsetS,
		    short SourceImageOffsetT);

\fP
.fi
.SH PARAMETERS
Refer to 
.IR gSPSprite2D (3P)
for an explanation of the parameters

.SH DESCRIPTION
.I guSprite2DInit
is used to initialize a passed in Sprite structure for subsequent use by
the sprite microcode.

.SH NOTE
Currently 
.IR guSprite2DInit (3P)
is a convenience function which merely copies its parameters into the
correct entries of the passed in SpritePointer. The call to this function
can be avoided by initializing the sprite structure manually.

.SH SEE ALSO
.IR gSPSprite2D (3P)
.IR gSPSprite2DBase (3P)
.IR gSPSprite2DScaleFlip (3P)
.IR gSPSprite2DDraw (3P)