DarkBASIC Professional Help File

DX11:SPRITELAYER

SpriteLayers are used to group several sprites together.
The draw order ("priority") of sprite layers can be changed and is more significant than the contained sprite's own priority values,
meaning that it can be changed whether a whole group (layer) of sprites will be drawn on top of or underneath other layers.
It is also possible to exclude entire sprite layers from rendering.
These settings are in addition to the sprite's own settings; single sprites can still be excluded within a sprite layer, but if the sprite
layer is excluded the sprite won't be drawn even if it itself isn't set to be excluded. In the same way the draw order priority of the
individual sprites define in what order sprites within the same layer will be drawn.
By default, all sprites are put into a default layer with a priority value of 1. They can be set to use other layers at creating or later in the
life of the sprite by calling the DX11 SET SPRITE LAYER function. There is also an internal GUI layer with a priority value of 0, ensuring its
contents will be drawn on top of all other layers. Take note that the layers you create yourself cannot set a higher priority than 1; you can however
lower the priority of the GUI layer if you so choose.
As usual, the default sprite layer resources (DX11 GET DEFAULT SPRITE LAYER / DX11 GET GUI SPRITE LAYER) cannot be deleted since they are used as
fallback layers by the engine when another one isn't provided.

    DX11 CREATE SPRITE LAYER : Return Dword = DX11 CREATE SPRITE LAYER(priority)

    DX11 DELETE SPRITE LAYER : DX11 DELETE SPRITE LAYER layer

    DX11 SPRITE LAYER EXISTS : Return Boolean = DX11 SPRITE LAYER EXISTS(layer)

    DX11 SET SPRITE LAYER PRIORITY : DX11 SET SPRITE LAYER PRIORITY layer, priority

    DX11 GET SPRITE LAYER PRIORITY : Return Word = DX11 GET SPRITE LAYER PRIORITY(layer)

    DX11 SET EXCLUDE SPRITE LAYER : DX11 SET EXCLUDE SPRITE LAYER layer, flag

    DX11 IS SPRITE LAYER EXCLUDED : Return Boolean = DX11 IS SPRITE LAYER EXCLUDED(layer)

    DX11 GET DEFAULT SPRITE LAYER : Return Dword = DX11 GET DEFAULT SPRITE LAYER()

    DX11 GET GUI SPRITE LAYER : Return Dword = DX11 GET GUI SPRITE LAYER()