sprite_get_uvs

Returns the texture coordinates of the sprite within the texture page as an array.

Syntax:

sprite_get_uvs(sprite, subimage);

Argument	Description
sprite	The index of the sprite to use.
subimage	The sub-image of the sprite to use.

Returns: Array

Description

This function returns an array with the UV coordinates and other data for the texture of the sprite sub-image on the texture page. The function returns an array with the following 8 elements:

[0] = left
[1] = top
[2] = right
[3] = bottom
[4] = amount of pixels the asset compiler has trimmed from the sprites left side
[5] = amount of pixels the asset compiler has trimmed from the sprites top side
[6] = normalised percentage of pixel data from the original sprites width that has been saved to the texture page
[7] = normalised percentage of pixel data from the original sprites height that has been saved to the texture page

This value can then be used in other draw functions, particularly in general 3D and some of the 2D primitive functions, as well as the Shader functions.

NOTE: This function will not work with vector sprites or skeleton animation sprites.

Example:

var tex = sprite_get_uvs(sprite, 0);
tex_left = tex[0];
tex_top = tex[1];
tex_right = tex[2];
tex_bottom = tex[3];

The above code will store the UV coordinates for the given sprite in a local array and then assign the values to instance variables.

Back: Sprites

Next: sprite_get_name

sprite_get_uvs

Returns the texture coordinates of the sprite within the texture page as an array.

Syntax:

Description

Example:

© Copyright YoYo Games Ltd. 2018 All Rights Reserved