doc: Fix various mismatches between arguments and their documentation
Argument names and @$arg suffered from various little mismatches, fix them in a batch commit. (cherry picked from commit d2ac3c5a88d980e7519c98bd261111b93cf73a6e)
This commit is contained in:
parent
6aadb4a0db
commit
864e5562df
@ -160,6 +160,7 @@ cogl_display_setup (CoglDisplay *display,
|
||||
/**
|
||||
* cogl_gdl_display_set_plane:
|
||||
* @display: a #CoglDisplay
|
||||
* @plane: the GDL plane id
|
||||
*
|
||||
* Request that Cogl output to a specific GDL overlay @plane.
|
||||
*
|
||||
|
@ -204,7 +204,7 @@ cogl_euler_init_from_quaternion (CoglEuler *euler,
|
||||
/**
|
||||
* cogl_euler_equal:
|
||||
* @v1: The first euler angle to compare
|
||||
* @v1: The second euler angle to compare
|
||||
* @v2: The second euler angle to compare
|
||||
*
|
||||
* Compares the two given euler angles @v1 and @v1 and it they are
|
||||
* equal returns %TRUE else %FALSE.
|
||||
|
@ -620,11 +620,9 @@ cogl_framebuffer_push_path_clip (CoglFramebuffer *framebuffer,
|
||||
* bounds
|
||||
* @bounds_y1: y coordinate for the top-left corner of the primitives
|
||||
* bounds
|
||||
* @bounds_x2: x coordinate for the top-left corner of the primitives
|
||||
* bounds
|
||||
* @bounds_y2: x coordinate for the bottom-right corner of the
|
||||
* @bounds_x2: x coordinate for the bottom-right corner of the
|
||||
* primitives bounds.
|
||||
* @bounds_x1: y coordinate for the bottom-right corner of the
|
||||
* @bounds_y2: y coordinate for the bottom-right corner of the
|
||||
* primitives bounds.
|
||||
*
|
||||
* Sets a new clipping area using a 2D shaped described with a
|
||||
@ -1525,8 +1523,8 @@ cogl_framebuffer_draw_multitextured_rectangle (CoglFramebuffer *framebuffer,
|
||||
void
|
||||
cogl_framebuffer_draw_rectangles (CoglFramebuffer *framebuffer,
|
||||
CoglPipeline *pipeline,
|
||||
const float *verts,
|
||||
unsigned int n_rects);
|
||||
const float *coordinates,
|
||||
unsigned int n_rectangles);
|
||||
|
||||
/**
|
||||
* cogl_framebuffer_draw_textured_rectangles:
|
||||
|
@ -283,6 +283,10 @@ cogl_gles2_get_current_vtable (void);
|
||||
* cogl_gles2_context_new()
|
||||
* @handle: An OpenGL ES 2.0 texture handle created with
|
||||
* glGenTextures()
|
||||
* @width: Width of the texture to allocate
|
||||
* @height: Height of the texture to allocate
|
||||
* @internal_format: The format of the texture
|
||||
* @error: A #CoglError for exceptions
|
||||
*
|
||||
* Creates a #CoglTexture2D from an OpenGL ES 2.0 texture handle that
|
||||
* was created within the given @gles2_ctx via glGenTextures(). The
|
||||
@ -311,6 +315,7 @@ cogl_gles2_texture_2d_new_from_handle (CoglContext *ctx,
|
||||
|
||||
/**
|
||||
* cogl_gles2_texture_get_handle:
|
||||
* @texture: A #CoglTexture
|
||||
* @handle: A return location for an OpenGL ES 2.0 texture handle
|
||||
* @target: A return location for an OpenGL ES 2.0 texture target
|
||||
*
|
||||
|
@ -69,6 +69,7 @@ typedef void (*CoglOnscreenX11MaskCallback) (CoglOnscreen *onscreen,
|
||||
* @xid: The XID of an existing X window
|
||||
* @update: A callback that notifies of updates to what Cogl requires
|
||||
* to be in the core X protocol event mask.
|
||||
* @user_data: user data passed to @update
|
||||
*
|
||||
* Ideally we would recommend that you let Cogl be responsible for
|
||||
* creating any X window required to back an onscreen framebuffer but
|
||||
|
@ -172,7 +172,7 @@ cogl_pipeline_set_layer_texture (CoglPipeline *pipeline,
|
||||
void
|
||||
cogl_pipeline_set_layer_null_texture (CoglPipeline *pipeline,
|
||||
int layer_index,
|
||||
CoglTextureType texure_type);
|
||||
CoglTextureType texture_type);
|
||||
|
||||
/**
|
||||
* cogl_pipeline_get_layer_texture:
|
||||
|
@ -712,6 +712,8 @@ cogl_pipeline_get_cull_face_mode (CoglPipeline *pipeline);
|
||||
|
||||
/**
|
||||
* cogl_pipeline_set_front_face_winding:
|
||||
* @pipeline: a #CoglPipeline
|
||||
* @front_winding: the winding order
|
||||
*
|
||||
* The order of the vertices within a primitive specifies whether it
|
||||
* is considered to be front or back facing. This function specifies
|
||||
@ -729,7 +731,8 @@ cogl_pipeline_set_front_face_winding (CoglPipeline *pipeline,
|
||||
CoglWinding front_winding);
|
||||
|
||||
/**
|
||||
* cogl_pipeline_set_front_face_winding:
|
||||
* cogl_pipeline_get_front_face_winding:
|
||||
* @pipeline: a #CoglPipeline
|
||||
*
|
||||
* The order of the vertices within a primitive specifies whether it
|
||||
* is considered to be front or back facing. This function specifies
|
||||
@ -739,6 +742,8 @@ cogl_pipeline_set_front_face_winding (CoglPipeline *pipeline,
|
||||
* %COGL_WINDING_CLOCKWISE sets them to be clockwise. The default is
|
||||
* %COGL_WINDING_COUNTER_CLOCKWISE.
|
||||
*
|
||||
* Returns: The @pipeline front face winding
|
||||
*
|
||||
* Status: Unstable
|
||||
* Since: 2.0
|
||||
*/
|
||||
|
@ -218,7 +218,7 @@ typedef struct
|
||||
* cogl_primitive_new:
|
||||
* @mode: A #CoglVerticesMode defining how to draw the vertices
|
||||
* @n_vertices: The number of vertices to process when drawing
|
||||
* @Varargs: A %NULL terminated list of attributes
|
||||
* @...: A %NULL terminated list of attributes
|
||||
*
|
||||
* Combines a set of #CoglAttribute<!-- -->s with a specific draw @mode
|
||||
* and defines a vertex count so a #CoglPrimitive object can be retained and
|
||||
@ -744,8 +744,8 @@ cogl_primitive_set_mode (CoglPrimitive *primitive,
|
||||
/**
|
||||
* cogl_primitive_set_attributes:
|
||||
* @primitive: A #CoglPrimitive object
|
||||
* @attributes: A %NULL terminated array of #CoglAttribute
|
||||
* pointers
|
||||
* @attributes: an array of #CoglAttribute pointers
|
||||
* @n_attributes: the number of elements in @attributes
|
||||
*
|
||||
* Replaces all the attributes of the given #CoglPrimitive object.
|
||||
*
|
||||
|
@ -633,10 +633,6 @@ cogl_quaternion_nlerp (CoglQuaternion *result,
|
||||
cogl_quaternion_normalize (result);
|
||||
}
|
||||
|
||||
/**
|
||||
* cogl_quaternion_squad:
|
||||
*
|
||||
*/
|
||||
void
|
||||
cogl_quaternion_squad (CoglQuaternion *result,
|
||||
const CoglQuaternion *prev,
|
||||
|
@ -165,6 +165,7 @@ cogl_quaternion_init (CoglQuaternion *quaternion,
|
||||
/**
|
||||
* cogl_quaternion_init_from_angle_vector:
|
||||
* @quaternion: An uninitialized #CoglQuaternion
|
||||
* @angle: The angle to rotate around @axis3f
|
||||
* @axis3f: your 3 component axis vector about which you want to rotate.
|
||||
*
|
||||
* Initializes a quaternion that rotates @angle degrees around the
|
||||
@ -343,7 +344,7 @@ cogl_quaternion_get_rotation_angle (const CoglQuaternion *quaternion);
|
||||
/**
|
||||
* cogl_quaternion_get_rotation_axis:
|
||||
* @quaternion: A #CoglQuaternion
|
||||
*
|
||||
* @vector3: (out): an allocated 3-float array
|
||||
*
|
||||
* Since: 2.0
|
||||
*/
|
||||
@ -407,6 +408,7 @@ cogl_quaternion_multiply (CoglQuaternion *result,
|
||||
/**
|
||||
* cogl_quaternion_pow:
|
||||
* @quaternion: A #CoglQuaternion
|
||||
* @exponent: the exponent
|
||||
*
|
||||
*
|
||||
* Since: 2.0
|
||||
@ -416,6 +418,11 @@ cogl_quaternion_pow (CoglQuaternion *quaternion, float exponent);
|
||||
|
||||
/**
|
||||
* cogl_quaternion_slerp:
|
||||
* @result: The destination #CoglQuaternion
|
||||
* @a: The first #CoglQuaternion
|
||||
* @b: The second #CoglQuaternion
|
||||
* @t: The factor in the range [0,1] used to interpolate between
|
||||
* quaternion @a and @b.
|
||||
*
|
||||
* Performs a spherical linear interpolation between two quaternions.
|
||||
*
|
||||
@ -483,6 +490,13 @@ cogl_quaternion_nlerp (CoglQuaternion *result,
|
||||
float t);
|
||||
/**
|
||||
* cogl_quaternion_squad:
|
||||
* @result: The destination #CoglQuaternion
|
||||
* @prev: A #CoglQuaternion used before @a
|
||||
* @a: The first #CoglQuaternion
|
||||
* @b: The second #CoglQuaternion
|
||||
* @next: A #CoglQuaternion that will be used after @b
|
||||
* @t: The factor in the range [0,1] used to interpolate between
|
||||
* quaternion @a and @b.
|
||||
*
|
||||
*
|
||||
* Since: 2.0
|
||||
|
@ -49,7 +49,7 @@ typedef struct _CoglSubTexture CoglSubTexture;
|
||||
|
||||
/**
|
||||
* cogl_sub_texture_new:
|
||||
* @context: A #CoglContext pointer
|
||||
* @ctx: A #CoglContext pointer
|
||||
* @parent_texture: The full texture containing a sub-region you want
|
||||
* to make a #CoglSubTexture from.
|
||||
* @sub_x: The top-left x coordinate of the parent region to make
|
||||
|
@ -78,7 +78,7 @@ cogl_is_texture_rectangle (void *object);
|
||||
|
||||
/**
|
||||
* cogl_texture_rectangle_new_with_size:
|
||||
* @context: A #CoglContext pointer
|
||||
* @ctx: A #CoglContext pointer
|
||||
* @width: The texture width to allocate
|
||||
* @height: The texture height to allocate
|
||||
* @internal_format: The desired internal texture format
|
||||
|
@ -63,7 +63,6 @@ cogl_wayland_renderer_set_foreign_display (CoglRenderer *renderer,
|
||||
/**
|
||||
* cogl_wayland_renderer_get_display:
|
||||
* @renderer: A #CoglRenderer
|
||||
* @display: A Wayland display
|
||||
*
|
||||
* Retrieves the Wayland display that Cogl is using. If a foreign
|
||||
* display has been specified using
|
||||
|
Loading…
Reference in New Issue
Block a user