docs: Fixes for the Cogl API reference
This commit is contained in:
parent
ba4e3905d3
commit
aa4f63338c
@ -107,8 +107,8 @@ cogl_is_bitmap (CoglHandle handle);
|
|||||||
* CoglBitmapError:
|
* CoglBitmapError:
|
||||||
* @COGL_BITMAP_ERROR_FAILED: Generic failure code, something went
|
* @COGL_BITMAP_ERROR_FAILED: Generic failure code, something went
|
||||||
* wrong.
|
* wrong.
|
||||||
* @COGL_ERROR_UNKNOWN_TYPE: Unknown image type.
|
* @COGL_BITMAP_ERROR_UNKNOWN_TYPE: Unknown image type.
|
||||||
* @COGL_ERROR_CORRUPT_IMAGE: An image file was broken somehow.
|
* @COGL_BITMAP_ERROR_CORRUPT_IMAGE: An image file was broken somehow.
|
||||||
*
|
*
|
||||||
* Error codes that can be thrown when performing bitmap
|
* Error codes that can be thrown when performing bitmap
|
||||||
* operations. Note that gdk_pixbuf_new_from_file() can also throw
|
* operations. Note that gdk_pixbuf_new_from_file() can also throw
|
||||||
|
@ -160,7 +160,7 @@ typedef enum { /*< prefix=COGL_BUFFER_ACCESS >*/
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* CoglBufferMapHint:
|
* CoglBufferMapHint:
|
||||||
* COGL_BUFFER_MAP_HINT_DISCARD: Tells Cogl that you plan to replace
|
* @COGL_BUFFER_MAP_HINT_DISCARD: Tells Cogl that you plan to replace
|
||||||
* all the buffer's contents.
|
* all the buffer's contents.
|
||||||
*
|
*
|
||||||
* Hints to Cogl about how you are planning to modify the data once it
|
* Hints to Cogl about how you are planning to modify the data once it
|
||||||
|
@ -45,7 +45,7 @@ typedef struct _CoglIndexArray CoglIndexArray;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_index_array_new:
|
* cogl_index_array_new:
|
||||||
* @size: The number of bytes to allocate for vertex attribute data.
|
* @bytes: The number of bytes to allocate for vertex attribute data.
|
||||||
*
|
*
|
||||||
* Declares a new #CoglIndexArray of @size bytes to contain vertex
|
* Declares a new #CoglIndexArray of @size bytes to contain vertex
|
||||||
* indices. Once declared, data can be set using
|
* indices. Once declared, data can be set using
|
||||||
|
@ -171,7 +171,7 @@ cogl_material_copy (CoglMaterial *source);
|
|||||||
* Deprecated: 1.2: Use cogl_object_ref() instead
|
* Deprecated: 1.2: Use cogl_object_ref() instead
|
||||||
*/
|
*/
|
||||||
CoglHandle
|
CoglHandle
|
||||||
cogl_material_ref (CoglHandle handle) G_GNUC_DEPRECATED;
|
cogl_material_ref (CoglHandle material) G_GNUC_DEPRECATED;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_material_unref:
|
* cogl_material_unref:
|
||||||
@ -184,7 +184,7 @@ cogl_material_ref (CoglHandle handle) G_GNUC_DEPRECATED;
|
|||||||
* Deprecated: 1.2: Use cogl_object_unref() instead
|
* Deprecated: 1.2: Use cogl_object_unref() instead
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
cogl_material_unref (CoglHandle handle) G_GNUC_DEPRECATED;
|
cogl_material_unref (CoglHandle material) G_GNUC_DEPRECATED;
|
||||||
|
|
||||||
#endif /* COGL_DISABLE_DEPRECATED */
|
#endif /* COGL_DISABLE_DEPRECATED */
|
||||||
|
|
||||||
@ -607,8 +607,8 @@ cogl_material_set_blend_constant (CoglMaterial *material,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_material_set_point_size:
|
* cogl_material_set_point_size:
|
||||||
* @material: a #CoglHandle to a material.
|
* @material: a material.
|
||||||
* @size: the new point size.
|
* @point_size: the new point size.
|
||||||
*
|
*
|
||||||
* Changes the size of points drawn when %COGL_VERTICES_MODE_POINTS is
|
* Changes the size of points drawn when %COGL_VERTICES_MODE_POINTS is
|
||||||
* used with the vertex buffer API. Note that typically the GPU will
|
* used with the vertex buffer API. Note that typically the GPU will
|
||||||
@ -645,7 +645,8 @@ cogl_material_get_point_size (CoglMaterial *material);
|
|||||||
* Queries what user program has been associated with the given
|
* Queries what user program has been associated with the given
|
||||||
* @material using cogl_material_set_user_program().
|
* @material using cogl_material_set_user_program().
|
||||||
*
|
*
|
||||||
* Return value: The current user program or %COGL_INVALID_HANDLE.
|
* Return value: (transfer none): The current user program
|
||||||
|
* or %COGL_INVALID_HANDLE.
|
||||||
*
|
*
|
||||||
* Since: 1.4
|
* Since: 1.4
|
||||||
*/
|
*/
|
||||||
|
@ -82,15 +82,15 @@ typedef struct
|
|||||||
typedef void (*CoglUserDataDestroyCallback) (void *user_data);
|
typedef void (*CoglUserDataDestroyCallback) (void *user_data);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_object_set_user_data:
|
* cogl_object_set_user_data: (skip)
|
||||||
* @object: The object to associate private data with
|
* @object: The object to associate private data with
|
||||||
* @key: The address of a #CoglUserDataKey which provides a unique value
|
* @key: The address of a #CoglUserDataKey which provides a unique value
|
||||||
* with which to index the private data.
|
* with which to index the private data.
|
||||||
* @user_data: The data to associate with the given object, or NULL to
|
* @user_data: The data to associate with the given object,
|
||||||
* remove a previous association.
|
* or %NULL to remove a previous association.
|
||||||
* @destroy: A #CoglUserDataDestroyCallback to call if the object is
|
* @destroy: A #CoglUserDataDestroyCallback to call if the object is
|
||||||
* destroyed or if the association is removed by later setting
|
* destroyed or if the association is removed by later setting
|
||||||
* NULL data for the same key.
|
* %NULL data for the same key.
|
||||||
*
|
*
|
||||||
* Associates some private @user_data with a given #CoglObject. To
|
* Associates some private @user_data with a given #CoglObject. To
|
||||||
* later remove the association call cogl_object_set_user_data() with
|
* later remove the association call cogl_object_set_user_data() with
|
||||||
@ -105,7 +105,7 @@ cogl_object_set_user_data (CoglObject *object,
|
|||||||
CoglUserDataDestroyCallback destroy);
|
CoglUserDataDestroyCallback destroy);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_object_get_user_data:
|
* cogl_object_get_user_data: (skip)
|
||||||
* @object: The object with associated private data to query
|
* @object: The object with associated private data to query
|
||||||
* @key: The address of a #CoglUserDataKey which provides a unique value
|
* @key: The address of a #CoglUserDataKey which provides a unique value
|
||||||
* with which to index the private data.
|
* with which to index the private data.
|
||||||
@ -114,8 +114,9 @@ cogl_object_set_user_data (CoglObject *object,
|
|||||||
* the given @key. If no user data has been associated with @object
|
* the given @key. If no user data has been associated with @object
|
||||||
* for the given @key this function returns NULL.
|
* for the given @key this function returns NULL.
|
||||||
*
|
*
|
||||||
* Returns: The user data previously associated with @object using
|
* Returns: (transfer none): The user data previously associated
|
||||||
* the given @key; or NULL if no associated data is found.
|
* with @object using the given @key; or %NULL if no associated
|
||||||
|
* data is found.
|
||||||
*
|
*
|
||||||
* Since: 1.4
|
* Since: 1.4
|
||||||
*/
|
*/
|
||||||
|
@ -440,7 +440,7 @@ cogl_path_round_rectangle (float x_1,
|
|||||||
float arc_step);
|
float arc_step);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_get_path:
|
* cogl_get_path: (skip)
|
||||||
*
|
*
|
||||||
* Gets a pointer to the current path. The path can later be used
|
* Gets a pointer to the current path. The path can later be used
|
||||||
* again by calling cogl_path_set(). Note that the path isn't copied
|
* again by calling cogl_path_set(). Note that the path isn't copied
|
||||||
@ -457,7 +457,7 @@ CoglPath *
|
|||||||
cogl_get_path (void);
|
cogl_get_path (void);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_set_path:
|
* cogl_set_path: (skip)
|
||||||
* @path: A #CoglPath object
|
* @path: A #CoglPath object
|
||||||
*
|
*
|
||||||
* Replaces the current path with @path. A reference is taken on the
|
* Replaces the current path with @path. A reference is taken on the
|
||||||
@ -470,7 +470,7 @@ void
|
|||||||
cogl_set_path (CoglPath *path);
|
cogl_set_path (CoglPath *path);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_path_copy:
|
* cogl_path_copy: (skip)
|
||||||
* @path: A #CoglPath object
|
* @path: A #CoglPath object
|
||||||
*
|
*
|
||||||
* Returns a new copy of the path in @path. The new path has a
|
* Returns a new copy of the path in @path. The new path has a
|
||||||
@ -480,7 +480,7 @@ cogl_set_path (CoglPath *path);
|
|||||||
* Internally the path will share the data until one of the paths is
|
* Internally the path will share the data until one of the paths is
|
||||||
* modified so copying paths should be relatively cheap.
|
* modified so copying paths should be relatively cheap.
|
||||||
*
|
*
|
||||||
* Return value: a copy of the path in @path.
|
* Return value: (transfer full): a copy of the path in @path.
|
||||||
*/
|
*/
|
||||||
CoglPath *
|
CoglPath *
|
||||||
cogl_path_copy (CoglPath *path);
|
cogl_path_copy (CoglPath *path);
|
||||||
|
@ -603,7 +603,7 @@ cogl_pipeline_set_blend_constant (CoglPipeline *pipeline,
|
|||||||
/**
|
/**
|
||||||
* cogl_pipeline_set_point_size:
|
* cogl_pipeline_set_point_size:
|
||||||
* @pipeline: a #CoglHandle to a pipeline.
|
* @pipeline: a #CoglHandle to a pipeline.
|
||||||
* @size: the new point size.
|
* @point_size: the new point size.
|
||||||
*
|
*
|
||||||
* Changes the size of points drawn when %COGL_VERTICES_MODE_POINTS is
|
* Changes the size of points drawn when %COGL_VERTICES_MODE_POINTS is
|
||||||
* used with the vertex buffer API. Note that typically the GPU will
|
* used with the vertex buffer API. Note that typically the GPU will
|
||||||
|
@ -84,7 +84,7 @@ void
|
|||||||
cogl_handle_unref (CoglHandle handle);
|
cogl_handle_unref (CoglHandle handle);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_object_ref:
|
* cogl_object_ref: (skip)
|
||||||
* @object: a #CoglObject
|
* @object: a #CoglObject
|
||||||
*
|
*
|
||||||
* Increases the reference count of @handle by 1
|
* Increases the reference count of @handle by 1
|
||||||
@ -95,7 +95,7 @@ void *
|
|||||||
cogl_object_ref (void *object);
|
cogl_object_ref (void *object);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_object_unref:
|
* cogl_object_unref: (skip)
|
||||||
* @object: a #CoglObject
|
* @object: a #CoglObject
|
||||||
*
|
*
|
||||||
* Drecreases the reference count of @object by 1; if the reference
|
* Drecreases the reference count of @object by 1; if the reference
|
||||||
|
@ -44,7 +44,7 @@ typedef struct _CoglVertexArray CoglVertexArray;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_vertex_array_new:
|
* cogl_vertex_array_new:
|
||||||
* @size: The number of bytes to allocate for vertex attribute data.
|
* @bytes: The number of bytes to allocate for vertex attribute data.
|
||||||
* @data: An optional pointer to vertex data to upload immediately.
|
* @data: An optional pointer to vertex data to upload immediately.
|
||||||
*
|
*
|
||||||
* Declares a new #CoglVertexArray of @size bytes to contain arrays of vertex
|
* Declares a new #CoglVertexArray of @size bytes to contain arrays of vertex
|
||||||
|
@ -296,7 +296,7 @@ cogl_vertex_buffer_indices_new (CoglIndicesType indices_type,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_vertex_buffer_indices_get_type:
|
* cogl_vertex_buffer_indices_get_type:
|
||||||
* @handle: An indices handle
|
* @indices: An indices handle
|
||||||
*
|
*
|
||||||
* Queries back the data type used for the given indices
|
* Queries back the data type used for the given indices
|
||||||
*
|
*
|
||||||
|
@ -186,11 +186,15 @@ cogl_path_stroke_preserve
|
|||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>cogl-bitmap</FILE>
|
<FILE>cogl-bitmap</FILE>
|
||||||
<TITLE>Bitmaps</TITLE>
|
<TITLE>Bitmaps</TITLE>
|
||||||
|
CoglBitmap
|
||||||
cogl_bitmap_new_from_file
|
cogl_bitmap_new_from_file
|
||||||
cogl_bitmap_get_size_from_file
|
cogl_bitmap_get_size_from_file
|
||||||
cogl_is_bitmap
|
cogl_is_bitmap
|
||||||
CoglBitmapError
|
CoglBitmapError
|
||||||
COGL_BITMAP_ERROR
|
COGL_BITMAP_ERROR
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
cogl_bitmap_error_get_type
|
||||||
|
cogl_bitmap_error_quark
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
@ -334,6 +338,9 @@ cogl_fixed_pow2
|
|||||||
cogl_fixed_sin
|
cogl_fixed_sin
|
||||||
cogl_fixed_sqrt
|
cogl_fixed_sqrt
|
||||||
cogl_fixed_tan
|
cogl_fixed_tan
|
||||||
|
cogl_fixed_div
|
||||||
|
cogl_fixed_mul
|
||||||
|
cogl_fixed_mul_div
|
||||||
|
|
||||||
<SUBSECTION>
|
<SUBSECTION>
|
||||||
CoglAngle
|
CoglAngle
|
||||||
@ -348,7 +355,7 @@ cogl_angle_tan
|
|||||||
<SUBSECTION Private>
|
<SUBSECTION Private>
|
||||||
cogl_double_to_fixed
|
cogl_double_to_fixed
|
||||||
cogl_double_to_int
|
cogl_double_to_int
|
||||||
cogl_double_to_unit
|
cogl_double_to_uint
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
@ -358,6 +365,9 @@ CoglColor
|
|||||||
cogl_color_new
|
cogl_color_new
|
||||||
cogl_color_copy
|
cogl_color_copy
|
||||||
cogl_color_free
|
cogl_color_free
|
||||||
|
cogl_color_init_from_4f
|
||||||
|
cogl_color_init_from_4fv
|
||||||
|
cogl_color_init_from_4ub
|
||||||
cogl_color_set_from_4ub
|
cogl_color_set_from_4ub
|
||||||
cogl_color_set_from_4f
|
cogl_color_set_from_4f
|
||||||
|
|
||||||
@ -433,6 +443,9 @@ cogl_vertex_buffer_indices_get_type
|
|||||||
<TITLE>Matrices</TITLE>
|
<TITLE>Matrices</TITLE>
|
||||||
CoglMatrix
|
CoglMatrix
|
||||||
cogl_matrix_init_identity
|
cogl_matrix_init_identity
|
||||||
|
cogl_matrix_copy
|
||||||
|
cogl_matrix_equal
|
||||||
|
cogl_matrix_free
|
||||||
cogl_matrix_frustum
|
cogl_matrix_frustum
|
||||||
cogl_matrix_ortho
|
cogl_matrix_ortho
|
||||||
cogl_matrix_perspective
|
cogl_matrix_perspective
|
||||||
@ -444,11 +457,16 @@ cogl_matrix_init_from_array
|
|||||||
cogl_matrix_get_array
|
cogl_matrix_get_array
|
||||||
cogl_matrix_get_inverse
|
cogl_matrix_get_inverse
|
||||||
cogl_matrix_transform_point
|
cogl_matrix_transform_point
|
||||||
|
cogl_matrix_project_points
|
||||||
|
cogl_matrix_transform_points
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>cogl-material</FILE>
|
<FILE>cogl-material</FILE>
|
||||||
<TITLE>Materials</TITLE>
|
<TITLE>Materials</TITLE>
|
||||||
|
CoglMaterial
|
||||||
|
CoglMaterialLayer
|
||||||
|
CoglMaterialLayerCallback
|
||||||
cogl_material_new
|
cogl_material_new
|
||||||
cogl_material_copy
|
cogl_material_copy
|
||||||
cogl_is_material
|
cogl_is_material
|
||||||
@ -495,9 +513,22 @@ cogl_material_set_layer_wrap_mode
|
|||||||
cogl_material_set_layer_wrap_mode_s
|
cogl_material_set_layer_wrap_mode_s
|
||||||
cogl_material_set_layer_wrap_mode_t
|
cogl_material_set_layer_wrap_mode_t
|
||||||
cogl_material_set_layer_wrap_mode_p
|
cogl_material_set_layer_wrap_mode_p
|
||||||
cogl_material_layer_get_wrap_mode_s
|
cogl_material_get_layer_wrap_mode_s
|
||||||
cogl_material_layer_get_wrap_mode_t
|
cogl_material_get_layer_wrap_mode_t
|
||||||
cogl_material_layer_get_wrap_mode_p
|
cogl_material_get_layer_wrap_mode_p
|
||||||
|
cogl_material_wrap_mode_get_type
|
||||||
|
cogl_material_set_user_program
|
||||||
|
cogl_material_get_user_program
|
||||||
|
cogl_material_set_depth_range
|
||||||
|
cogl_material_get_depth_range
|
||||||
|
cogl_material_set_depth_test_enabled
|
||||||
|
cogl_material_get_depth_test_enabled
|
||||||
|
cogl_material_set_depth_test_function
|
||||||
|
cogl_material_get_depth_test_function
|
||||||
|
cogl_material_set_depth_writing_enabled
|
||||||
|
cogl_material_get_depth_writing_enabled
|
||||||
|
cogl_material_foreach_layer
|
||||||
|
|
||||||
<SUBSECTION Private>
|
<SUBSECTION Private>
|
||||||
cogl_blend_string_error_get_type
|
cogl_blend_string_error_get_type
|
||||||
cogl_blend_string_error_quark
|
cogl_blend_string_error_quark
|
||||||
|
Loading…
x
Reference in New Issue
Block a user