VgaGames 3 - Animation man-pages

[.. upper level ..]

VG3_sprite_get()

Get current values of an animated sprite.
SYNTAX
int VG3_sprite_get(struct vg3_sprite *sprt, void **imgptr, struct vg3_image_attributes *attr, int *audkz)

FUNCTION PARAMETERS
sprt Sprite
imgptr For returning image or NULL if no image is set for this element
attr For returning image-attributes for the image
audkz For returning audio-descriptor (return value 0 = no sound),
Pass NULL to have a possible sound self-played.

RETURN VALUE
Returns integer: - 1: OK - 0: sprite has been ended

DESCRIPTION
Get current values of an animated sprite: - image to show - image-attributes for the image - sound to play if wanted, otherwise the sound will be played automatically Return whether the sprite has been ended, that is when the common parameter LIFETIME has been exhausted.

SEE ALSO
VG3_sprite_rewind() VG3_sprite_imagesize()