al_clear_depth_buffer(3alleg5)

al_clear_depth_buffer3alleg5

Allegro 5 api

Usage

#include <allegro5/allegro.h>
void al_clear_depth_buffer(float z)

Overview

Clear the depth buffer (confined by the clipping rectangle) to the given value. A depth buffer is only available if it was requested with al_set_new_display_option(3alleg5) and the requirement could be met by the al_create_display(3alleg5) call creating the current display. Operations involving the depth buffer are also affected by al_set_render_state(3alleg5).

For example, if ALLEGRO_DEPTH_FUNCTION is set to ALLEGRO_RENDER_LESS then depth buffer value of 1 represents infinite distance, and thus is a good value to use when clearing the depth buffer.

Since

5.1.2

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

From allegro5-doc 2:5.2.10.1+dfsg-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.