surface_get_depth_disable


Syntax:

surface_get_depth_disable();


Returns:

Boolean


Description

This function checks to see if the automatic depth buffer generation for all surfaces is enabled. Normally all surfaces have depth buffers so if you draw 3D objects to them then it'll sort them properly by depth, however allocating depth buffers essentially doubles the size of surfaces, which could be an excessive and unnecessary overhead especially if your game is very memory intensive. In that case you can check this using this function and disable the depth buffer for surfaces if required using the function surface_depth_disable().

NOTE: This function is currently only valid for the Sony Playstation 4 target platform.


Example:

if surface_get_depth_disable() == false
    {
    surface_depth_disable(true);
    }

The above code will check the current state of the surface depth buffer and if it is enabled, it will disable it instead.