VgaGames4

VgaGames4 - sprite man-pages

[.. upper level ..]

# vg4->sprite->current()

Return image with attributes of current sprite element again.

SYNTAX
VG_BOOL vg4->sprite->current(struct VG_Sprite *sprt, struct VG_Image **imgp, struct VG_ImagecopyAttr *iattr)
FUNCTION PARAMETERS

sprt | Sprite
imgp | For returning image; it may return NULL if the element has no image
iattr | For returning image's image-copy attributes

RETURN VALUE
Returns boolean: - VG_TRUE: OK - VG_FALSE: Sprite ended
DESCRIPTION
Return image with attributes of current sprite element, which was set by vg4->sprite->next(). If the current element has an image, it will be returned in imgp with its attributes in iattr. imgp will return NULL if there is no image defined. imgp and iattr may be passed as NULL, if they are not needed. If the current element defines playing a sound, it will not be played again. If the sprite has ended the returned value is VG_FALSE.
SEE ALSO
vg4->sprite->next()