isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-23 11:32:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

renderer: Remove _EXP symbol mangling and add gtk-doc

Browse Source 
We are in the process of removing all _EXP suffix mangling for
experimental APIs (Ref: c6528c4b6c) and adding missing gtk-doc
comments so that we can instead rely on the "Stability: unstable"
markers in the gtk-doc comments. This patch tackles the cogl-pipeline
symbols.
This commit is contained in:
Robert Bragg 2012-01-13 20:23:22 +00:00
parent e163f1ca1a
commit 54b1fb0b5e
3 changed files with 21 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
cogl/cogl-pipeline-layer-state.h
View File

@ -117,7 +117,6 @@ typedef enum {
} CoglPipelineWrapMode;
/* NB: these values come from the equivalents in gl.h */
#define cogl_pipeline_set_layer_texture cogl_pipeline_set_layer_texture_EXP
/**
* cogl_pipeline_set_layer:
* @pipeline: A #CoglPipeline object
@ -136,25 +135,26 @@ typedef enum {
* as purely GLSL based layers.</note>
*
* Since: 2.0
* Stability: unstable
*/
void
cogl_pipeline_set_layer_texture (CoglPipeline *pipeline,
int layer_index,
CoglTexture *texture);
#define cogl_pipeline_remove_layer cogl_pipeline_remove_layer_EXP
/**
* cogl_pipeline_remove_layer:
* @pipeline: A #CoglPipeline object
* @layer_index: Specifies the layer you want to remove
*
* This function removes a layer from your pipeline
* Since: 1.10
* Stability: unstable
*/
void
cogl_pipeline_remove_layer (CoglPipeline *pipeline,
int layer_index);
#define cogl_pipeline_set_layer_combine cogl_pipeline_set_layer_combine_EXP
/**
* cogl_pipeline_set_layer_combine:
* @pipeline: A #CoglPipeline object
@ -246,6 +246,7 @@ cogl_pipeline_remove_layer (CoglPipeline *pipeline,
* or hardware. On failure, %FALSE is returned and @error is set
*
* Since: 2.0
* Stability: unstable
*/
gboolean
cogl_pipeline_set_layer_combine (CoglPipeline *pipeline,
@ -253,8 +254,6 @@ cogl_pipeline_set_layer_combine (CoglPipeline *pipeline,
const char *blend_string,
GError **error);
#define cogl_pipeline_set_layer_combine_constant \
cogl_pipeline_set_layer_combine_constant_EXP
/**
* cogl_pipeline_set_layer_combine_constant:
* @pipeline: A #CoglPipeline object
@ -266,13 +265,13 @@ cogl_pipeline_set_layer_combine (CoglPipeline *pipeline,
* description then you can use this function to define its value.
*
* Since: 2.0
* Stability: unstable
*/
void
cogl_pipeline_set_layer_combine_constant (CoglPipeline *pipeline,
int layer_index,
const CoglColor *constant);
#define cogl_pipeline_set_layer_matrix cogl_pipeline_set_layer_matrix_EXP
/**
* cogl_pipeline_set_layer_matrix:
* @pipeline: A #CoglPipeline object
@ -281,13 +280,15 @@ cogl_pipeline_set_layer_combine_constant (CoglPipeline *pipeline,
*
* This function lets you set a matrix that can be used to e.g. translate
* and rotate a single layer of a pipeline used to fill your geometry.
*
* Since: 1.10
* Stability: unstable
*/
void
cogl_pipeline_set_layer_matrix (CoglPipeline *pipeline,
int layer_index,
const CoglMatrix *matrix);
#define cogl_pipeline_get_n_layers cogl_pipeline_get_n_layers_EXP
/**
* cogl_pipeline_get_n_layers:
* @pipeline: A #CoglPipeline object
@ -297,11 +298,11 @@ cogl_pipeline_set_layer_matrix (CoglPipeline *pipeline,
* Return value: the number of layers
*
* Since: 2.0
* Stability: unstable
*/
int
cogl_pipeline_get_n_layers (CoglPipeline *pipeline);
#define cogl_pipeline_set_layer_filters cogl_pipeline_set_layer_filters_EXP
/**
* cogl_pipeline_set_layer_filters:
* @pipeline: A #CoglPipeline object
@ -311,6 +312,9 @@ cogl_pipeline_get_n_layers (CoglPipeline *pipeline);
*
* Changes the decimation and interpolation filters used when a texture is
* drawn at other scales than 100%.
*
* Since: 1.10
* Stability: unstable
*/
void
cogl_pipeline_set_layer_filters (CoglPipeline *pipeline,
@ -318,8 +322,6 @@ cogl_pipeline_set_layer_filters (CoglPipeline *pipeline,
CoglPipelineFilter min_filter,
CoglPipelineFilter mag_filter);
#define cogl_pipeline_set_layer_point_sprite_coords_enabled \
cogl_pipeline_set_layer_point_sprite_coords_enabled_EXP
/**
* cogl_pipeline_set_layer_point_sprite_coords_enabled:
* @pipeline: a #CoglHandle to a pipeline.
@ -340,6 +342,7 @@ cogl_pipeline_set_layer_filters (CoglPipeline *pipeline,
*
* Return value: %TRUE if the function succeeds, %FALSE otherwise.
* Since: 2.0
* Stability: unstable
*/
gboolean
cogl_pipeline_set_layer_point_sprite_coords_enabled (CoglPipeline *pipeline,
@ -347,8 +350,6 @@ cogl_pipeline_set_layer_point_sprite_coords_enabled (CoglPipeline *pipeline,
gboolean enable,
GError **error);
#define cogl_pipeline_get_layer_point_sprite_coords_enabled \
cogl_pipeline_get_layer_point_sprite_coords_enabled_EXP
/**
* cogl_pipeline_get_layer_point_sprite_coords_enabled:
* @pipeline: a #CoglHandle to a pipeline.
@ -361,13 +362,12 @@ cogl_pipeline_set_layer_point_sprite_coords_enabled (CoglPipeline *pipeline,
* point sprite coordinates.
*
* Since: 2.0
* Stability: unstable
*/
gboolean
cogl_pipeline_get_layer_point_sprite_coords_enabled (CoglPipeline *pipeline,
int layer_index);
#define cogl_pipeline_get_layer_wrap_mode_s \
cogl_pipeline_get_layer_wrap_mode_s_EXP
/**
* cogl_pipeline_get_layer_wrap_mode_s:
* @pipeline: A #CoglPipeline object
@ -380,13 +380,12 @@ cogl_pipeline_get_layer_point_sprite_coords_enabled (CoglPipeline *pipeline,
* this layer.
*
* Since: 1.6
* Stability: unstable
*/
CoglPipelineWrapMode
cogl_pipeline_get_layer_wrap_mode_s (CoglPipeline *pipeline,
int layer_index);
#define cogl_pipeline_set_layer_wrap_mode_s \
cogl_pipeline_set_layer_wrap_mode_s_EXP
/**
* cogl_pipeline_set_layer_wrap_mode_s:
* @pipeline: A #CoglPipeline object
@ -396,14 +395,13 @@ cogl_pipeline_get_layer_wrap_mode_s (CoglPipeline *pipeline,
* Sets the wrap mode for the 's' coordinate of texture lookups on this layer.
*
* Since: 2.0
* Stability: unstable
*/
void
cogl_pipeline_set_layer_wrap_mode_s (CoglPipeline *pipeline,
int layer_index,
CoglPipelineWrapMode mode);
#define cogl_pipeline_get_layer_wrap_mode_t \
cogl_pipeline_get_layer_wrap_mode_t_EXP
/**
* cogl_pipeline_get_layer_wrap_mode_t:
* @pipeline: A #CoglPipeline object
@ -416,14 +414,13 @@ cogl_pipeline_set_layer_wrap_mode_s (CoglPipeline *pipeline,
* this layer.
*
* Since: 1.6
* Stability: unstable
*/
CoglPipelineWrapMode
cogl_pipeline_get_layer_wrap_mode_t (CoglPipeline *pipeline,
int layer_index);
#define cogl_pipeline_set_layer_wrap_mode_t \
cogl_pipeline_set_layer_wrap_mode_t_EXP
/**
* cogl_pipeline_set_layer_wrap_mode_t:
* @pipeline: A #CoglPipeline object
@ -433,14 +430,13 @@ cogl_pipeline_get_layer_wrap_mode_t (CoglPipeline *pipeline,
* Sets the wrap mode for the 't' coordinate of texture lookups on this layer.
*
* Since: 2.0
* Stability: unstable
*/
void
cogl_pipeline_set_layer_wrap_mode_t (CoglPipeline *pipeline,
int layer_index,
CoglPipelineWrapMode mode);
#define cogl_pipeline_get_layer_wrap_mode_p \
cogl_pipeline_get_layer_wrap_mode_p_EXP
/**
* cogl_pipeline_get_layer_wrap_mode_p:
* @pipeline: A #CoglPipeline object
@ -453,13 +449,12 @@ cogl_pipeline_set_layer_wrap_mode_t (CoglPipeline *pipeline,
* this layer.
*
* Since: 1.6
* Stability: unstable
*/
CoglPipelineWrapMode
cogl_pipeline_get_layer_wrap_mode_p (CoglPipeline *pipeline,
int layer_index);
#define cogl_pipeline_set_layer_wrap_mode_p \
cogl_pipeline_set_layer_wrap_mode_p_EXP
/**
* cogl_pipeline_set_layer_wrap_mode_p:
* @pipeline: A #CoglPipeline object
@ -470,14 +465,13 @@ cogl_pipeline_get_layer_wrap_mode_p (CoglPipeline *pipeline,
* this layer. 'p' is the third coordinate.
*
* Since: 2.0
* Stability: unstable
*/
void
cogl_pipeline_set_layer_wrap_mode_p (CoglPipeline *pipeline,
int layer_index,
CoglPipelineWrapMode mode);
#define cogl_pipeline_set_layer_wrap_mode \
cogl_pipeline_set_layer_wrap_mode_EXP
/**
* cogl_pipeline_set_layer_wrap_mode:
* @pipeline: A #CoglPipeline object
@ -491,13 +485,13 @@ cogl_pipeline_set_layer_wrap_mode_p (CoglPipeline *pipeline,
* cogl_pipeline_set_layer_wrap_mode_p() separately.
*
* Since: 2.0
* Stability: unstable
*/
void
cogl_pipeline_set_layer_wrap_mode (CoglPipeline *pipeline,
int layer_index,
CoglPipelineWrapMode mode);
#define cogl_pipeline_add_layer_snippet cogl_pipeline_add_layer_snippet_EXP
/**
* cogl_pipeline_add_layer_snippet:
* @pipeline: A #CoglPipeline

43
cogl/cogl-pipeline-state.h
View File

@ -36,7 +36,6 @@ G_BEGIN_DECLS
#ifdef COGL_ENABLE_EXPERIMENTAL_API
#define cogl_pipeline_set_color cogl_pipeline_set_color_EXP
/**
* cogl_pipeline_set_color:
* @pipeline: A #CoglPipeline object
@ -58,7 +57,6 @@ void
cogl_pipeline_set_color (CoglPipeline *pipeline,
const CoglColor *color);
#define cogl_pipeline_set_color4ub cogl_pipeline_set_color4ub_EXP
/**
* cogl_pipeline_set_color4ub:
* @pipeline: A #CoglPipeline object
@ -81,7 +79,6 @@ cogl_pipeline_set_color4ub (CoglPipeline *pipeline,
guint8 blue,
guint8 alpha);
#define cogl_pipeline_set_color4f cogl_pipeline_set_color4f_EXP
/**
* cogl_pipeline_set_color4f:
* @pipeline: A #CoglPipeline object
@ -104,7 +101,6 @@ cogl_pipeline_set_color4f (CoglPipeline *pipeline,
float blue,
float alpha);
#define cogl_pipeline_get_color cogl_pipeline_get_color_EXP
/**
* cogl_pipeline_get_color:
* @pipeline: A #CoglPipeline object
@ -119,7 +115,6 @@ void
cogl_pipeline_get_color (CoglPipeline *pipeline,
CoglColor *color);
#define cogl_pipeline_set_ambient cogl_pipeline_set_ambient_EXP
/**
* cogl_pipeline_set_ambient:
* @pipeline: A #CoglPipeline object
@ -141,7 +136,6 @@ void
cogl_pipeline_set_ambient (CoglPipeline *pipeline,
const CoglColor *ambient);
#define cogl_pipeline_get_ambient cogl_pipeline_get_ambient_EXP
/**
* cogl_pipeline_get_ambient:
* @pipeline: A #CoglPipeline object
@ -156,7 +150,6 @@ void
cogl_pipeline_get_ambient (CoglPipeline *pipeline,
CoglColor *ambient);
#define cogl_pipeline_set_diffuse cogl_pipeline_set_diffuse_EXP
/**
* cogl_pipeline_set_diffuse:
* @pipeline: A #CoglPipeline object
@ -175,7 +168,6 @@ void
cogl_pipeline_set_diffuse (CoglPipeline *pipeline,
const CoglColor *diffuse);
#define cogl_pipeline_get_diffuse cogl_pipeline_get_diffuse_EXP
/**
* cogl_pipeline_get_diffuse:
* @pipeline: A #CoglPipeline object
@ -190,8 +182,6 @@ void
cogl_pipeline_get_diffuse (CoglPipeline *pipeline,
CoglColor *diffuse);
#define cogl_pipeline_set_ambient_and_diffuse \
cogl_pipeline_set_ambient_and_diffuse_EXP
/**
* cogl_pipeline_set_ambient_and_diffuse:
* @pipeline: A #CoglPipeline object
@ -211,7 +201,6 @@ void
cogl_pipeline_set_ambient_and_diffuse (CoglPipeline *pipeline,
const CoglColor *color);
#define cogl_pipeline_set_specular cogl_pipeline_set_specular_EXP
/**
* cogl_pipeline_set_specular:
* @pipeline: A #CoglPipeline object
@ -230,7 +219,6 @@ void
cogl_pipeline_set_specular (CoglPipeline *pipeline,
const CoglColor *specular);
#define cogl_pipeline_get_specular cogl_pipeline_get_specular_EXP
/**
* cogl_pipeline_get_specular:
* @pipeline: A #CoglPipeline object
@ -245,7 +233,6 @@ void
cogl_pipeline_get_specular (CoglPipeline *pipeline,
CoglColor *specular);
#define cogl_pipeline_set_shininess cogl_pipeline_set_shininess_EXP
/**
* cogl_pipeline_set_shininess:
* @pipeline: A #CoglPipeline object
@ -265,7 +252,6 @@ void
cogl_pipeline_set_shininess (CoglPipeline *pipeline,
float shininess);
#define cogl_pipeline_get_shininess cogl_pipeline_get_shininess_EXP
/**
* cogl_pipeline_get_shininess:
* @pipeline: A #CoglPipeline object
@ -280,7 +266,6 @@ cogl_pipeline_set_shininess (CoglPipeline *pipeline,
float
cogl_pipeline_get_shininess (CoglPipeline *pipeline);
#define cogl_pipeline_set_emission cogl_pipeline_set_emission_EXP
/**
* cogl_pipeline_set_emission:
* @pipeline: A #CoglPipeline object
@ -299,7 +284,6 @@ void
cogl_pipeline_set_emission (CoglPipeline *pipeline,
const CoglColor *emission);
#define cogl_pipeline_get_emission cogl_pipeline_get_emission_EXP
/**
* cogl_pipeline_get_emission:
* @pipeline: A #CoglPipeline object
@ -348,8 +332,6 @@ typedef enum {
} CoglPipelineAlphaFunc;
/* NB: these values come from the equivalents in gl.h */
#define cogl_pipeline_set_alpha_test_function \
cogl_pipeline_set_alpha_test_function_EXP
/**
* cogl_pipeline_set_alpha_test_function:
* @pipeline: A #CoglPipeline object
@ -373,8 +355,6 @@ cogl_pipeline_set_alpha_test_function (CoglPipeline *pipeline,
CoglPipelineAlphaFunc alpha_func,
float alpha_reference);
#define cogl_pipeline_get_alpha_test_function \
cogl_pipeline_get_alpha_test_function_EXP
/**
* cogl_pipeline_get_alpha_test_function:
* @pipeline: A #CoglPipeline object
@ -387,8 +367,6 @@ cogl_pipeline_set_alpha_test_function (CoglPipeline *pipeline,
CoglPipelineAlphaFunc
cogl_pipeline_get_alpha_test_function (CoglPipeline *pipeline);
#define cogl_pipeline_get_alpha_test_reference \
cogl_pipeline_get_alpha_test_reference_EXP
/**
* cogl_pipeline_get_alpha_test_reference:
* @pipeline: A #CoglPipeline object
@ -401,7 +379,6 @@ cogl_pipeline_get_alpha_test_function (CoglPipeline *pipeline);
float
cogl_pipeline_get_alpha_test_reference (CoglPipeline *pipeline);
#define cogl_pipeline_set_blend cogl_pipeline_set_blend_EXP
/**
* cogl_pipeline_set_blend:
* @pipeline: A #CoglPipeline object
@ -489,7 +466,6 @@ cogl_pipeline_set_blend (CoglPipeline *pipeline,
const char *blend_string,
GError **error);
#define cogl_pipeline_set_blend_constant cogl_pipeline_set_blend_constant_EXP
/**
* cogl_pipeline_set_blend_constant:
* @pipeline: A #CoglPipeline object
@ -505,7 +481,6 @@ void
cogl_pipeline_set_blend_constant (CoglPipeline *pipeline,
const CoglColor *constant_color);
#define cogl_pipeline_set_point_size cogl_pipeline_set_point_size_EXP
/**
* cogl_pipeline_set_point_size:
* @pipeline: a #CoglPipeline pointer
@ -526,7 +501,6 @@ void
cogl_pipeline_set_point_size (CoglPipeline *pipeline,
float point_size);
#define cogl_pipeline_get_point_size cogl_pipeline_get_point_size_EXP
/**
* cogl_pipeline_get_point_size:
* @pipeline: a #CoglPipeline pointer
@ -542,7 +516,6 @@ cogl_pipeline_set_point_size (CoglPipeline *pipeline,
float
cogl_pipeline_get_point_size (CoglPipeline *pipeline);
#define cogl_pipeline_get_color_mask cogl_pipeline_get_color_mask_EXP
/**
* cogl_pipeline_get_color_mask:
* @pipeline: a #CoglPipeline object.
@ -558,7 +531,6 @@ cogl_pipeline_get_point_size (CoglPipeline *pipeline);
CoglColorMask
cogl_pipeline_get_color_mask (CoglPipeline *pipeline);
#define cogl_pipeline_set_color_mask cogl_pipeline_set_color_mask_EXP
/**
* cogl_pipeline_set_color_mask:
* @pipeline: a #CoglPipeline object.
@ -576,7 +548,6 @@ void
cogl_pipeline_set_color_mask (CoglPipeline *pipeline,
CoglColorMask color_mask);
#define cogl_pipeline_get_user_program cogl_pipeline_get_user_program_EXP
/**
* cogl_pipeline_get_user_program:
* @pipeline: a #CoglPipeline object.
@ -592,7 +563,6 @@ cogl_pipeline_set_color_mask (CoglPipeline *pipeline,
CoglHandle
cogl_pipeline_get_user_program (CoglPipeline *pipeline);
#define cogl_pipeline_set_user_program cogl_pipeline_set_user_program_EXP
/**
* cogl_pipeline_set_user_program:
* @pipeline: a #CoglPipeline object.
@ -644,7 +614,6 @@ void
cogl_pipeline_set_user_program (CoglPipeline *pipeline,
CoglHandle program);
#define cogl_pipeline_set_depth_state cogl_pipeline_set_depth_state_EXP
/**
* cogl_pipeline_set_depth_state:
* @pipeline: A #CoglPipeline object
@ -670,7 +639,6 @@ cogl_pipeline_set_depth_state (CoglPipeline *pipeline,
const CoglDepthState *state,
GError **error);
#define cogl_pipeline_get_depth_state cogl_pipeline_get_depth_state_EXP
/**
* cogl_pipeline_get_depth_state
* @pipeline: A #CoglPipeline object
@ -777,8 +745,6 @@ cogl_pipeline_set_front_face_winding (CoglPipeline *pipeline,
CoglWinding
cogl_pipeline_get_front_face_winding (CoglPipeline *pipeline);
#define cogl_pipeline_set_uniform_1f \
cogl_pipeline_set_uniform_1f_EXP
/**
* cogl_pipeline_set_uniform_1f:
* @pipeline: A #CoglPipeline object
@ -804,8 +770,6 @@ cogl_pipeline_set_uniform_1f (CoglPipeline *pipeline,
int uniform_location,
float value);
#define cogl_pipeline_set_uniform_1i \
cogl_pipeline_set_uniform_1i_EXP
/**
* cogl_pipeline_set_uniform_1i:
* @pipeline: A #CoglPipeline object
@ -831,8 +795,6 @@ cogl_pipeline_set_uniform_1i (CoglPipeline *pipeline,
int uniform_location,
int value);
#define cogl_pipeline_set_uniform_float \
cogl_pipeline_set_uniform_float_EXP
/**
* cogl_pipeline_set_uniform_float:
* @pipeline: A #CoglPipeline object
@ -864,8 +826,6 @@ cogl_pipeline_set_uniform_float (CoglPipeline *pipeline,
int count,
const float *value);
#define cogl_pipeline_set_uniform_int \
cogl_pipeline_set_uniform_int_EXP
/**
* cogl_pipeline_set_uniform_int:
* @pipeline: A #CoglPipeline object
@ -897,8 +857,6 @@ cogl_pipeline_set_uniform_int (CoglPipeline *pipeline,
int count,
const int *value);
#define cogl_pipeline_set_uniform_matrix \
cogl_pipeline_set_uniform_matrix_EXP
/**
* cogl_pipeline_set_uniform_matrix:
* @pipeline: A #CoglPipeline object
@ -937,7 +895,6 @@ cogl_pipeline_set_uniform_matrix (CoglPipeline *pipeline,
gboolean transpose,
const float *value);
#define cogl_pipeline_add_snippet cogl_pipeline_add_snippet_EXP
/**
* cogl_pipeline_add_snippet:
* @pipeline: A #CoglPipeline

6
cogl/cogl-pipeline.h
View File

@ -52,7 +52,6 @@ typedef struct _CoglPipeline CoglPipeline;
#define COGL_PIPELINE(OBJECT) ((CoglPipeline *)OBJECT)
#define cogl_pipeline_new cogl_pipeline_new_EXP
/**
* cogl_pipeline_new:
*
@ -67,7 +66,6 @@ typedef struct _CoglPipeline CoglPipeline;
CoglPipeline *
cogl_pipeline_new (void);
#define cogl_pipeline_copy cogl_pipeline_copy_EXP
/**
* cogl_pipeline_copy:
* @source: a #CoglPipeline object to copy
@ -89,7 +87,6 @@ cogl_pipeline_new (void);
CoglPipeline *
cogl_pipeline_copy (CoglPipeline *source);
#define cogl_is_pipeline cogl_is_pipeline_EXP
/**
* cogl_is_pipeline:
* @handle: A CoglHandle
@ -121,7 +118,6 @@ typedef gboolean (*CoglPipelineLayerCallback) (CoglPipeline *pipeline,
int layer_index,
void *user_data);
#define cogl_pipeline_foreach_layer cogl_pipeline_foreach_layer_EXP
/**
* cogl_pipeline_foreach_layer:
* @pipeline: A #CoglPipeline object
@ -139,8 +135,6 @@ cogl_pipeline_foreach_layer (CoglPipeline *pipeline,
CoglPipelineLayerCallback callback,
void *user_data);
#define cogl_pipeline_get_uniform_location \
cogl_pipeline_get_uniform_location_EXP
/**
* cogl_pipeline_get_uniform_location:
* @pipeline: A #CoglPipeline object