DarkBASIC Professional Help File

DX11 SET SPRITE SHEET SPLIT

Prepares a sprite for animation by defining how many times the sprite's image should be divided along the X and Y axii.
Each sub-image ("frame") must have the same width and height and the frame id's start at zero and are counted from left to right,
top to bottom (ie. frame 5 of a sprite sheet split with the arguments (4, 4) will refer to the second sub-image to the right on the
second row of the sheet image).
Note that you must call this before trying to animate a sprite or its only valid frame will be 0, which then refers to the
entire source image.
Also note that the split factor will carry over if you change the sprite's image using DX11 SET SPRITE IMAGE. In this case you might
also want to call DX11 SET SPRITE SHEET SPLIT again to correspond to the new image(s). A split setting of (1, 1) means that the entire
image is to be used as the single frame of a sprite (the default behaviour).

Syntax

    DX11 SET SPRITE SHEET SPLIT sprite, across, down

Parameters

    sprite

> Dword
> The sprite to set the sheet split values for.

    across

> Word
> How many times to split the source image horizontally when identifying sprite frames.

    down

> Word
> How many times to split the source image vertically when identifying sprite frames.

Returns

This function does not return a value.

See also

SPRITE Functions Menu
DX11 Function Categories