Add a few annotations on Cogl primitives functions
By default, float * is considered as an out argument by gobject introspection which is wrong for quite a few Cogl symbols. Start adding annotations to fix that for the ones in the "Primitives" gtk-doc section.
This commit is contained in:
parent
1b37cb6cb7
commit
6e50e26c86
@ -254,8 +254,8 @@ void cogl_path_line (float x_1,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_path_polyline:
|
* cogl_path_polyline:
|
||||||
* @coords: A pointer to the first element of an array of fixed-point
|
* @coords: (in) (array) (transfer none): A pointer to the first element of an
|
||||||
* values that specify the vertex coordinates.
|
* array of fixed-point values that specify the vertex coordinates.
|
||||||
* @num_points: The total number of vertices.
|
* @num_points: The total number of vertices.
|
||||||
*
|
*
|
||||||
* Constructs a series of straight line segments, starting from the
|
* Constructs a series of straight line segments, starting from the
|
||||||
@ -276,8 +276,8 @@ void cogl_path_polyline (float *coords,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_path_polygon:
|
* cogl_path_polygon:
|
||||||
* @coords: A pointer to the first element of an array of fixed-point
|
* @coords: (in) (array) (transfer none): A pointer to the first element of
|
||||||
* values that specify the vertex coordinates.
|
* an array of fixed-point values that specify the vertex coordinates.
|
||||||
* @num_points: The total number of vertices.
|
* @num_points: The total number of vertices.
|
||||||
*
|
*
|
||||||
* Constructs a polygonal shape of the given number of vertices. If
|
* Constructs a polygonal shape of the given number of vertices. If
|
||||||
|
@ -364,11 +364,12 @@ void cogl_rectangle_with_texture_coords (float x1,
|
|||||||
* @y1: y coordinate upper left on screen.
|
* @y1: y coordinate upper left on screen.
|
||||||
* @x2: x coordinate lower right on screen.
|
* @x2: x coordinate lower right on screen.
|
||||||
* @y2: y coordinate lower right on screen.
|
* @y2: y coordinate lower right on screen.
|
||||||
* @tex_coords: An array containing groups of 4 float values:
|
* @tex_coords: (in) (array) (transfer none): An array containing groups of 4
|
||||||
* [tx1, ty1, tx2, ty2] that are interpreted as two texture coordinates; one
|
* float values: [tx1, ty1, tx2, ty2] that are interpreted as two texture
|
||||||
* for the upper left texel, and one for the lower right texel. Each value
|
* coordinates; one for the upper left texel, and one for the lower right
|
||||||
* should be between 0.0 and 1.0, where the coordinate (0.0, 0.0) represents
|
* texel. Each value should be between 0.0 and 1.0, where the coordinate
|
||||||
* the top left of the texture, and (1.0, 1.0) the bottom right.
|
* (0.0, 0.0) represents the top left of the texture, and (1.0, 1.0) the
|
||||||
|
* bottom right.
|
||||||
* @tex_coords_len: The length of the tex_coords array. (e.g. for one layer
|
* @tex_coords_len: The length of the tex_coords array. (e.g. for one layer
|
||||||
* and one group of texture coordinates, this would be 4)
|
* and one group of texture coordinates, this would be 4)
|
||||||
*
|
*
|
||||||
@ -393,7 +394,7 @@ void cogl_rectangle_with_multitexture_coords (float x1,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_rectangles_with_texture_coords:
|
* cogl_rectangles_with_texture_coords:
|
||||||
* @verts: an array of vertices
|
* @verts: (in) (array) (transfer none): an array of vertices
|
||||||
* @n_rects: number of rectangles to draw
|
* @n_rects: number of rectangles to draw
|
||||||
*
|
*
|
||||||
* Draws a series of rectangles in the same way that
|
* Draws a series of rectangles in the same way that
|
||||||
@ -413,7 +414,7 @@ void cogl_rectangles_with_texture_coords (const float *verts,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* cogl_rectangles:
|
* cogl_rectangles:
|
||||||
* @verts: an array of vertices
|
* @verts: (in) (array) (transfer none): an array of vertices
|
||||||
* @n_rects: number of rectangles to draw
|
* @n_rects: number of rectangles to draw
|
||||||
*
|
*
|
||||||
* Draws a series of rectangles in the same way that
|
* Draws a series of rectangles in the same way that
|
||||||
|
Loading…
Reference in New Issue
Block a user