[cogl/wip/cogl-1.14: 141/177] doc: Fix the remaining warning around the depth state



commit c934cf5ff5cd8b9dee0f988e28106e1ce94cb8dd
Author: Damien Lespiau <damien lespiau intel com>
Date:   Mon Dec 31 14:58:31 2012 +0000

    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)

 cogl/cogl-depth-state.h                            |   10 +++++-----
 cogl/cogl-pipeline-state.h                         |    2 +-
 cogl/cogl-types.h                                  |    7 +++----
 .../cogl-2.0-experimental-sections.txt             |    4 ++++
 4 files changed, 13 insertions(+), 10 deletions(-)
---
diff --git a/cogl/cogl-depth-state.h b/cogl/cogl-depth-state.h
index dadc2eb..4953c24 100644
--- a/cogl/cogl-depth-state.h
+++ b/cogl/cogl-depth-state.h
@@ -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
diff --git a/cogl/cogl-pipeline-state.h b/cogl/cogl-pipeline-state.h
index 8863cf3..44c5027 100644
--- a/cogl/cogl-pipeline-state.h
+++ b/cogl/cogl-pipeline-state.h
@@ -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().
diff --git a/cogl/cogl-types.h b/cogl/cogl-types.h
index bca2e00..248fa2f 100644
--- a/cogl/cogl-types.h
+++ b/cogl/cogl-types.h
@@ -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,
diff --git a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
index 6f98cb3..eebc8f3 100644
--- a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
+++ b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
@@ -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



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]