layer_get_depth


Description

You can use this function to get the depth value associated with a given layer. 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 the function will return that layers depth as a real number. Note that depth is defined as being higher the "further away" from the camera and lower the "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 if you supply an invalid layer ID value you will get an error.


Syntax:

layer_get_depth(layer_id)


Arguments:

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


Returns:

Real


Example:

if layer_get_depth(global.temp_layer) != -100
   {
   layer_destroy(global.temp_layer);
   global.temp_layer = layer_create(-100);
   }

The above code checks the depth of a layer ID stored in a global variable and if it is not -100 it destroys the layer and re-creates it at the depth of -100.


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