1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
.TH "al_clear_depth_buffer" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_clear_depth_buffer \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
void\ al_clear_depth_buffer(float\ z)
\f[]
.fi
.SH DESCRIPTION
.PP
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(3) and the requirement could be met by the
al_create_display(3) call creating the current display.
Operations involving the depth buffer are also affected by
al_set_render_state(3).
.PP
For example, if \f[C]ALLEGRO_DEPTH_FUNCTION\f[] is set to
\f[C]ALLEGRO_RENDER_LESS\f[] then depth buffer value of 1 represents
infinite distance, and thus is a good value to use when clearing the
depth buffer.
.SH SINCE
.PP
5.1.2
.SH SEE ALSO
.PP
al_clear_to_color(3), al_set_clipping_rectangle(3),
al_set_render_state(3), al_set_new_display_option(3)
|
