mirror of
https://github.com/brl/mutter.git
synced 2024-11-25 17:40:40 -05:00
doc: Fix the remaining warning around the depth state
Various changes have led to the current, separate from the pipeline, depth state, this commit fixes the remaining waring around that. (cherry picked from commit 111e687e722ad67a0e1c09f881c6282ccb06410b)
This commit is contained in:
parent
9ae9602047
commit
f1f1e876f1
@ -90,12 +90,12 @@ cogl_depth_state_init (CoglDepthState *state);
|
||||
* @enable.
|
||||
*
|
||||
* If depth testing is enable then the #CoglDepthTestFunction set
|
||||
* using cogl_pipeline_set_depth_test_function() us used to evaluate
|
||||
* using cogl_depth_state_set_test_function() us used to evaluate
|
||||
* the depth value of incoming fragments against the corresponding
|
||||
* 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_write_enabled())
|
||||
* cogl_depth_state_set_write_enabled())
|
||||
*
|
||||
* By default depth testing is disabled.
|
||||
*
|
||||
@ -153,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_write_enabled().
|
||||
* cogl_depth_state_set_write_enabled().
|
||||
*
|
||||
* Returns: The current depth writing enable state
|
||||
* Since: 2.0
|
||||
@ -189,7 +189,7 @@ cogl_depth_state_set_test_function (CoglDepthState *state,
|
||||
* @state: A #CoglDepthState struct
|
||||
*
|
||||
* Gets the current depth test enable state as previously set via
|
||||
* cogl_pipeline_set_depth_test_enabled().
|
||||
* cogl_depth_state_set_test_enabled().
|
||||
*
|
||||
* Returns: The current depth test enable state.
|
||||
* Since: 2.0
|
||||
@ -249,7 +249,7 @@ cogl_depth_state_set_range (CoglDepthState *state,
|
||||
*
|
||||
* Gets the current range to which normalized depth values are mapped
|
||||
* before writing to the depth buffer. This corresponds to the range
|
||||
* set with cogl_pipeline_set_depth_range().
|
||||
* set with cogl_depth_state_set_range().
|
||||
*
|
||||
* Since: 2.0
|
||||
* Stability: Unstable
|
||||
|
@ -642,7 +642,7 @@ cogl_pipeline_set_depth_state (CoglPipeline *pipeline,
|
||||
/**
|
||||
* cogl_pipeline_get_depth_state
|
||||
* @pipeline: A #CoglPipeline object
|
||||
* @state: A destination #CoglDepthState struct
|
||||
* @state_out: (out): A destination #CoglDepthState struct
|
||||
*
|
||||
* Retrieves the current depth state configuration for the given
|
||||
* @pipeline as previously set using cogl_pipeline_set_depth_state().
|
||||
|
@ -742,13 +742,12 @@ typedef enum {
|
||||
* When using depth testing one of these functions is used to compare
|
||||
* the depth of an incoming fragment against the depth value currently
|
||||
* stored in the depth buffer. The function is changed using
|
||||
* cogl_material_set_depth_test_function().
|
||||
* cogl_depth_state_set_test_function().
|
||||
*
|
||||
* The test is only done when depth testing is explicitly enabled. (See
|
||||
* cogl_material_set_depth_test_enabled())
|
||||
* cogl_depth_state_set_test_enabled())
|
||||
*/
|
||||
typedef enum
|
||||
{
|
||||
typedef enum {
|
||||
COGL_DEPTH_TEST_FUNCTION_NEVER = 0x0200,
|
||||
COGL_DEPTH_TEST_FUNCTION_LESS = 0x0201,
|
||||
COGL_DEPTH_TEST_FUNCTION_EQUAL = 0x0202,
|
||||
|
@ -729,6 +729,9 @@ cogl_pipeline_get_point_size
|
||||
cogl_pipeline_get_color_mask
|
||||
cogl_pipeline_set_color_mask
|
||||
|
||||
cogl_pipeline_set_depth_state
|
||||
cogl_pipeline_get_depth_state
|
||||
|
||||
CoglPipelineCullFaceMode
|
||||
cogl_pipeline_set_cull_face_mode
|
||||
CoglWinding
|
||||
@ -776,6 +779,7 @@ cogl_blend_string_error_domain
|
||||
<FILE>cogl-depth-state</FILE>
|
||||
<TITLE>Depth State</TITLE>
|
||||
CoglDepthState
|
||||
CoglDepthTestFunction
|
||||
cogl_depth_state_init
|
||||
cogl_depth_state_set_test_enabled
|
||||
cogl_depth_state_get_test_enabled
|
||||
|
Loading…
Reference in New Issue
Block a user