DarkBASIC Professional Help File

DX11 CREATE SPRITE

Creates a sprite from an image and positions it at the given screen coordinates.
Note that this will setup an internal dependency on the image, meaning that it will not be deleted until the Sprite is deleted too.
Also note that if several sprites have the same internal- and layer priority, the draw order will be static (in other words, no flickering) but the
order between the sprites with the same priority cannot be known prior to runtime.

Syntax

    Return Dword = DX11 CREATE SPRITE(image, x, y, [priority], [layer])

Parameters

    image

> Dword
> The source image.

    x

> Integer
> The X screen coordinate to put the Sprite's left edge at.

    y

> Integer
> The Y screen coordinate to put the Sprite's top edge at.

    [Optional] priority

> Word
> A draw priority to assign to this sprite. Sprites are drawn back to front and a higher priority means it gets drawn earlier. Defaults to 1 which means the sprite will be drawn last.

    [Optional] layer

> Dword
> A sprite layer to put this sprite in. Defaults to DX11 GET DEFAULT SPRITE LAYER() which has a layer priority of 1, making its contents draw on top of all but sprites in the GUI layer.

Returns

The created sprite.

See also

SPRITE Functions Menu
DX11 Function Categories