brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Expose CoglDepthState

Browse Source 
It wasn't included to the documention up to now.

(cherry picked from commit 826c0d5c8333ad31595d690d7c8753f84d12b2ad)
This commit is contained in:
Damien Lespiau 2012-12-30 20:21:34 +00:00 committed by Robert Bragg
parent 5cd6e9c27c
commit 9ae9602047
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cogl/cogl-depth-state.h
View File

@ -39,8 +39,13 @@ COGL_BEGIN_DECLS
* state of your GPU.
*/
typedef struct
{
/**
* CoglDepthState
*
* Since: 2.0
*/
typedef struct {
/*< private >*/
uint32_t COGL_PRIVATE (magic);
CoglBool COGL_PRIVATE (test_enabled);
@ -59,7 +64,6 @@ typedef struct
uint32_t COGL_PRIVATE (padding7);
uint32_t COGL_PRIVATE (padding8);
uint32_t COGL_PRIVATE (padding9);
} CoglDepthState;
/**
@ -91,7 +95,7 @@ cogl_depth_state_init (CoglDepthState *state);
* value stored in the current depth buffer, and if the test passes
* then the fragments depth value is used to update the depth buffer.
* (unless you have disabled depth writing via
* cogl_pipeline_set_depth_writing_enabled ())
* cogl_pipeline_set_depth_write_enabled())
*
* By default depth testing is disabled.
*
@ -149,7 +153,7 @@ cogl_depth_state_set_write_enabled (CoglDepthState *state,
* @state: A #CoglDepthState struct
*
* Gets the depth writing enable state as set by the corresponding
* cogl_pipeline_set_depth_writing_enabled.
* cogl_pipeline_set_depth_write_enabled().
*
* Returns: The current depth writing enable state
* Since: 2.0

1
doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
View File

@ -80,6 +80,7 @@
<title>Setting Up A GPU Pipeline</title>
<xi:include href="blend-strings.xml"/>
<xi:include href="xml/cogl-pipeline.xml"/>
<xi:include href="xml/cogl-depth-state.xml"/>
<xi:include href="xml/cogl-snippet.xml"/>
</section>

5
doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
View File

@ -774,14 +774,15 @@ cogl_blend_string_error_domain
<SECTION>
<FILE>cogl-depth-state</FILE>
<TITLE>Depth State</TITLE>
CoglDepthState
cogl_depth_state_init
cogl_depth_state_set_test_enabled
cogl_depth_state_get_test_enabled
cogl_depth_state_set_test_function
cogl_depth_state_get_test_function
cogl_depth_state_set_writing_enabled
cogl_depth_state_get_writing_enabled
cogl_depth_state_set_write_enabled
cogl_depth_state_get_write_enabled
cogl_depth_state_set_range
cogl_depth_state_get_range
</SECTION>