[Cogl] [PATCH 37/53] doc: Fix the remaining warning around the depth state

Damien Lespiau damien.lespiau at gmail.com
Tue Jan 1 06:31:13 PST 2013


From: Damien Lespiau <damien.lespiau at intel.com>

Various changes have led to the current, separate from the pipeline,
depth state, this commit fixes the remaining waring around that.
---
 cogl/cogl-depth-state.h                |   10 +++++-----
 cogl/cogl-pipeline-state.h             |    2 +-
 cogl/cogl-types.h                      |    7 +++----
 doc/reference/cogl2/cogl2-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 dd21740..3e1c187 100644
--- a/cogl/cogl-pipeline-state.h
+++ b/cogl/cogl-pipeline-state.h
@@ -391,7 +391,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 83bdebf..4450e72 100644
--- a/cogl/cogl-types.h
+++ b/cogl/cogl-types.h
@@ -568,13 +568,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/cogl2/cogl2-sections.txt b/doc/reference/cogl2/cogl2-sections.txt
index 1970f12..3dee535 100644
--- a/doc/reference/cogl2/cogl2-sections.txt
+++ b/doc/reference/cogl2/cogl2-sections.txt
@@ -660,6 +660,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
@@ -706,6 +709,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
-- 
1.7.7.5



More information about the Cogl mailing list