1ALLEGRO_RENDER_STATE(3)                                ALLEGRO_RENDER_STATE(3)
2
3
4

NAME

6       ALLEGRO_RENDER_STATE - Allegro 5 API
7

SYNOPSIS

9              #include <allegro5/allegro.h>
10
11              typedef enum ALLEGRO_RENDER_STATE {
12

DESCRIPTION

14       Possible render states which can be set with al_set_render_state(3):
15
16       ALLEGRO_ALPHA_TEST
17              If  this  is  set to 1, the values of ALLEGRO_ALPHA_FUNCTION and
18              ALLEGRO_ALPHA_TEST_VALUE define a comparison function  which  is
19              performed for each pixel.  Only if it evaluates to true the pix‐
20              el is written.  Otherwise no subsequent processing  (like  depth
21              test or blending) is performed.
22
23       ALLEGRO_ALPHA_FUNCTION
24              One  of  ALLEGRO_RENDER_FUNCTION(3),  only used when ALLEGRO_AL‐
25              PHA_TEST is 1.
26
27       ALLEGRO_ALPHA_TEST_VALUE
28              Only used when ALLEGRO_ALPHA_TEST is 1.
29
30       ALLEGRO_WRITE_MASK
31              This determines how the framebuffer and depthbuffer are  updated
32              whenever  a pixel is written (in case alpha and/or depth testing
33              is enabled: after all such enabled tests succeed).  Depth values
34              are  only written if ALLEGRO_DEPTH_TEST is 1, in addition to the
35              write mask flag being set.
36
37       ALLEGRO_DEPTH_TEST
38              If this is set to 1, compare the depth value of any newly  writ‐
39              ten pixels with the depth value already in the buffer, according
40              to ALLEGRO_DEPTH_FUNCTION.  Allegro primitives with no  explicit
41              z coordinate will write a value of 0 into the depth buffer.
42
43       ALLEGRO_DEPTH_FUNCTION
44              One   of   ALLEGRO_RENDER_FUNCTION(3),   only  used  when  ALLE‐
45              GRO_DEPTH_TEST is 1.
46

SINCE

48       5.1.2
49

SEE ALSO

51       al_set_render_state(3),        ALLEGRO_RENDER_FUNCTION(3),        ALLE‐
52       GRO_WRITE_MASK_FLAGS(3)
53
54
55
56Allegro reference manual                               ALLEGRO_RENDER_STATE(3)
Impressum