layer_depth


Description

This function can be used to change the depth of the given layer, changing the order in which its contents will be rendered to the screen. You supply the layer ID (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and then give the new depth to set it to (an integer value form -16000 to 16000). The layer depth is defined as being higher when "further away" from the camera and lower when "closer" to the camera, so if you have three layers with depths -100, 0, 100, the layers will draw in the order 100, 0, -100, so that the "top" layer (ie, the closest to the camera view and so drawn over everything else) will be the layer with the -100 depth.

The following image shows a schematic of how depth works for layers: Layer Depth

Note that you can check the depth of a layer at any time using the function layer_get_depth. Also note that the minimum and maximum layer depths are -16000 to 16000, and anything outside of those depths will not be rendered. If you require a depth outside of that range then you will need to use the function layer_force_draw_depth.


Syntax:

layer_depth(layer_id, depth)


Arguments:

Argument Description
layer_id The unique ID value of the layer to set the depth of (or the layer name as a string)
depth The new depth for the layer


Returns:

N/A


Example:

if layer_get_depth(layer) != -100
   {
   layer_depth(layer, -100);
   }

The above code gets the depth of the layer that the instance running the code is on, and if it is not -100 then the depth is set to -100.


Back: General Layer Functions
next: layer_force_draw_depth
© Copyright YoYo Games Ltd. 2018 All Rights Reserved