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 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
|
.TH "ALLEGRO_RENDER_STATE" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
ALLEGRO_RENDER_STATE \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
typedef\ enum\ ALLEGRO_RENDER_STATE\ {
\f[]
.fi
.SH DESCRIPTION
.PP
Possible render states which can be set with al_set_render_state(3):
.TP
.B ALLEGRO_ALPHA_TEST
If this is set to 1, the values of ALLEGRO_ALPHA_FUNCTION and
ALLEGRO_ALPHA_TEST_VALUE define a comparison function which is performed
for each pixel.
Only if it evaluates to true the pixel is written.
Otherwise no subsequent processing (like depth test or blending) is
performed.
.RS
.RE
.TP
.B ALLEGRO_ALPHA_FUNCTION
One of ALLEGRO_RENDER_FUNCTION(3), only used when ALLEGRO_ALPHA_TEST is
1.
.RS
.RE
.TP
.B ALLEGRO_ALPHA_TEST_VALUE
Only used when ALLEGRO_ALPHA_TEST is 1.
.RS
.RE
.TP
.B ALLEGRO_WRITE_MASK
This determines how the framebuffer and depthbuffer are updated whenever
a pixel is written (in case alpha and/or depth testing is enabled: after
all such enabled tests succeed).
Depth values are only written if ALLEGRO_DEPTH_TEST is 1, in addition to
the write mask flag being set.
.RS
.RE
.TP
.B ALLEGRO_DEPTH_TEST
If this is set to 1, compare the depth value of any newly written pixels
with the depth value already in the buffer, according to
ALLEGRO_DEPTH_FUNCTION.
Allegro primitives with no explicit z coordinate will write a value of 0
into the depth buffer.
.RS
.RE
.TP
.B ALLEGRO_DEPTH_FUNCTION
One of ALLEGRO_RENDER_FUNCTION(3), only used when ALLEGRO_DEPTH_TEST is
1.
.RS
.RE
.SH SINCE
.PP
5.1.2
.SH SEE ALSO
.PP
al_set_render_state(3), ALLEGRO_RENDER_FUNCTION(3),
ALLEGRO_WRITE_MASK_FLAGS(3)
|