filename | :: FileName | The path to the sprite file to use. |
The path to the sprite file to use. | ||
size optional | :: SpriteSizeType or {SpriteSizeType, SpriteSizeType} | The width and height of the sprite. [...] |
The width and height of the sprite. [...] | ||
width optional | :: SpriteSizeType | Mandatory if |
Mandatory if | ||
height optional | :: SpriteSizeType | Mandatory if |
Mandatory if | ||
x optional | :: SpriteSizeType | Horizontal position of the sprite in the source file in pixels. |
Horizontal position of the sprite in the source file in pixels. | ||
y optional | :: SpriteSizeType | Vertical position of the sprite in the source file in pixels. |
Vertical position of the sprite in the source file in pixels. | ||
position optional | :: {SpriteSizeType, SpriteSizeType} | Loaded only when |
Loaded only when | ||
load_in_minimal_mode optional | :: bool | Minimal mode is entered when mod loading fails. [...] |
Minimal mode is entered when mod loading fails. [...] | ||
premul_alpha optional | :: bool | Whether alpha should be pre-multiplied. |
Whether alpha should be pre-multiplied. | ||
allow_forced_downscale optional | :: bool | If |
If |
filename | :: FileName | The path to the sprite file to use. |
The path to the sprite file to use. | ||
allow_forced_downscale optional | :: bool | If |
If | ||
height optional | :: SpriteSizeType | Mandatory if |
Mandatory if | ||
load_in_minimal_mode optional | :: bool | Minimal mode is entered when mod loading fails. [...] |
Minimal mode is entered when mod loading fails. [...] | ||
position optional | :: {SpriteSizeType, SpriteSizeType} | Loaded only when |
Loaded only when | ||
premul_alpha optional | :: bool | Whether alpha should be pre-multiplied. |
Whether alpha should be pre-multiplied. | ||
size optional | :: SpriteSizeType or {SpriteSizeType, SpriteSizeType} | The width and height of the sprite. [...] |
The width and height of the sprite. [...] | ||
width optional | :: SpriteSizeType | Mandatory if |
Mandatory if | ||
x optional | :: SpriteSizeType | Horizontal position of the sprite in the source file in pixels. |
Horizontal position of the sprite in the source file in pixels. | ||
y optional | :: SpriteSizeType | Vertical position of the sprite in the source file in pixels. |
Vertical position of the sprite in the source file in pixels. |
The path to the sprite file to use.
The width and height of the sprite. If this is a tuple, the first member of the tuple is the width and the second is the height. Otherwise the size is both width and height. Width and height may only be in the range of 0-4096.
Mandatory if size
is not defined.
Width of the picture in pixels, from 0-4096.
Mandatory if size
is not defined.
Height of the picture in pixels, from 0-4096.
Default: 0
Horizontal position of the sprite in the source file in pixels.
Default: 0
Vertical position of the sprite in the source file in pixels.
Loaded only when x
and y
are both 0
. The first member of the tuple is x
and the second is y
.