surface_get_texture

Returns the texture id for the given surface.

Syntax:

surface_get_texture(surf);


Argument Description
surf The index of the surface to get the width of.


Returns: Real


Description

This function returns a special id for the surface texture. This value can then be used in other draw functions, particularly in general 3D and some of the 2D primitive functions.

NOTE: When working with surfaces there is the possibility that they can cease to exist at any time due to them being stored in texture memory. You should ALWAYS check that a surface exists using surface_exists before referencing them directly. For further information see Surfaces.


Example:

var tex;
tex = surface_get_texture(surf);
draw_primitive_begin_texture(pr_trianglefan, tex);
draw_vertex_texture(0, 480, 0, 0);
draw_vertex_texture(640, 480, 1, 0);
draw_vertex_texture(640, 480, 1, 1);
draw_vertex_texture(0, 480, 0, 1);
draw_primitive_end();

The above code will draw a 4 vertex triangle fan textured with the texture held in the "tex" variable, which is itself taken from a previously created surface.


Back: Surfaces
Next: surface_getpixel
© Copyright YoYo Games Ltd. 2014 All Rights Reserved