[mutter/zbrown/assorted-g-i-things: 128/132] cogl: Update annotations




commit 44edadcf092b6f4bb0724e8b38892eed452a7c30
Author: Zander Brown <zbrown gnome org>
Date:   Tue Jul 6 18:10:19 2021 +0100

    cogl: Update annotations
    
    As CoglPrimative etc are unintrospected they are unknown to g-i, mark
    them as gpointers to keep things happy

 cogl/cogl/cogl-bitmap.h               |  4 ++--
 cogl/cogl/cogl-context.h              |  6 +++---
 cogl/cogl/cogl-framebuffer.h          |  4 ++--
 cogl/cogl/cogl-pipeline-layer-state.h |  2 +-
 cogl/cogl/cogl-pipeline-state.h       |  6 +++---
 cogl/cogl/cogl-xlib-renderer.h        | 17 +++++++++--------
 6 files changed, 20 insertions(+), 19 deletions(-)
---
diff --git a/cogl/cogl/cogl-bitmap.h b/cogl/cogl/cogl-bitmap.h
index 955fbb59db..5f80e78ba4 100644
--- a/cogl/cogl/cogl-bitmap.h
+++ b/cogl/cogl/cogl-bitmap.h
@@ -87,7 +87,7 @@ cogl_bitmap_new_from_file (const char *filename,
 
 /**
  * cogl_bitmap_new_from_buffer: (skip)
- * @buffer: A #CoglBuffer containing image data
+ * @buffer: (type gpointer): A #CoglBuffer containing image data
  * @format: The #CoglPixelFormat defining the format of the image data
  *          in the given @buffer.
  * @width: The width of the image data in the given @buffer.
@@ -225,7 +225,7 @@ cogl_bitmap_get_rowstride (CoglBitmap *bitmap);
  * cogl_bitmap_get_buffer: (skip)
  * @bitmap: A #CoglBitmap
  *
- * Return value: (transfer none): the #CoglPixelBuffer that this
+ * Returns: (transfer none) (type gpointer): the #CoglPixelBuffer that this
  *   buffer uses for storage. Note that if the bitmap was created with
  *   cogl_bitmap_new_from_file() then it will not actually be using a
  *   pixel buffer and this function will return %NULL.
diff --git a/cogl/cogl/cogl-context.h b/cogl/cogl/cogl-context.h
index 38ac11be83..4e9c16df66 100644
--- a/cogl/cogl/cogl-context.h
+++ b/cogl/cogl/cogl-context.h
@@ -106,7 +106,7 @@ GType cogl_context_get_gtype (void);
 
 /**
  * cogl_context_new: (constructor) (skip)
- * @display: (allow-none): A #CoglDisplay pointer
+ * @display: (allow-none) (type gpointer): A #CoglDisplay pointer
  * @error: A GError return location.
  *
  * Creates a new #CoglContext which acts as an application sandbox
@@ -130,7 +130,7 @@ cogl_context_new (CoglDisplay *display,
  * cogl_context_new() then this function returns a pointer to the
  * display that was automatically setup internally.
  *
- * Return value: (transfer none): The #CoglDisplay associated with the
+ * Returns: (transfer none) (type gpointer): The #CoglDisplay associated with the
  *               given @context.
  * Since: 1.8
  * Stability: unstable
@@ -149,7 +149,7 @@ cogl_context_get_display (CoglContext *context);
  * a pointer to the renderer that was automatically connected
  * internally.
  *
- * Return value: (transfer none): The #CoglRenderer associated with the
+ * Return: (transfer none) (type gpointer): The #CoglRenderer associated with the
  *               given @context.
  * Since: 1.16
  * Stability: unstable
diff --git a/cogl/cogl/cogl-framebuffer.h b/cogl/cogl/cogl-framebuffer.h
index 571b489988..1bedd18a84 100644
--- a/cogl/cogl/cogl-framebuffer.h
+++ b/cogl/cogl/cogl-framebuffer.h
@@ -588,7 +588,7 @@ cogl_framebuffer_push_rectangle_clip (CoglFramebuffer *framebuffer,
 /**
  * cogl_framebuffer_push_primitive_clip: (skip)
  * @framebuffer: A #CoglFramebuffer pointer
- * @primitive: A #CoglPrimitive describing a flat 2D shape
+ * @primitive: (type gpointer): A #CoglPrimitive describing a flat 2D shape
  * @bounds_x1: x coordinate for the top-left corner of the primitives
  *             bounds
  * @bounds_y1: y coordinate for the top-left corner of the primitives
@@ -1050,7 +1050,7 @@ cogl_framebuffer_clear4f (CoglFramebuffer *framebuffer,
  * cogl_framebuffer_draw_primitive: (skip)
  * @framebuffer: A destination #CoglFramebuffer
  * @pipeline: A #CoglPipeline state object
- * @primitive: A #CoglPrimitive geometry object
+ * @primitive: (type gpointer): A #CoglPrimitive geometry object
  *
  * Draws the given @primitive geometry to the specified destination
  * @framebuffer using the graphics processing state described by @pipeline.
diff --git a/cogl/cogl/cogl-pipeline-layer-state.h b/cogl/cogl/cogl-pipeline-layer-state.h
index 13bc465789..51881519a8 100644
--- a/cogl/cogl/cogl-pipeline-layer-state.h
+++ b/cogl/cogl/cogl-pipeline-layer-state.h
@@ -551,7 +551,7 @@ cogl_pipeline_set_layer_wrap_mode (CoglPipeline        *pipeline,
  * cogl_pipeline_add_layer_snippet: (skip)
  * @pipeline: A #CoglPipeline
  * @layer: The layer to hook the snippet to
- * @snippet: A #CoglSnippet
+ * @snippet: (type gpointer): A #CoglSnippet
  *
  * Adds a shader snippet that will hook on to the given layer of the
  * pipeline. The exact part of the pipeline that the snippet wraps
diff --git a/cogl/cogl/cogl-pipeline-state.h b/cogl/cogl/cogl-pipeline-state.h
index 4387685462..be3a3d64f1 100644
--- a/cogl/cogl/cogl-pipeline-state.h
+++ b/cogl/cogl/cogl-pipeline-state.h
@@ -447,7 +447,7 @@ cogl_pipeline_set_user_program (CoglPipeline *pipeline,
 /**
  * cogl_pipeline_set_depth_state: (skip)
  * @pipeline: A #CoglPipeline object
- * @state: A #CoglDepthState struct
+ * @state: (type gpointer): A #CoglDepthState struct
  * @error: A #GError to report failures to setup the given @state.
  *
  * This commits all the depth state configured in @state struct to the
@@ -472,7 +472,7 @@ cogl_pipeline_set_depth_state (CoglPipeline *pipeline,
 /**
  * cogl_pipeline_get_depth_state: (skip)
  * @pipeline: A #CoglPipeline object
- * @state_out: (out): A destination #CoglDepthState struct
+ * @state_out: (type gpointer) (out): A destination #CoglDepthState struct
  *
  * Retrieves the current depth state configuration for the given
  * @pipeline as previously set using cogl_pipeline_set_depth_state().
@@ -733,7 +733,7 @@ cogl_pipeline_set_uniform_matrix (CoglPipeline *pipeline,
 /**
  * cogl_pipeline_add_snippet: (skip)
  * @pipeline: A #CoglPipeline
- * @snippet: The #CoglSnippet to add to the vertex processing hook
+ * @snippet: (type gpointer): The #CoglSnippet to add to the vertex processing hook
  *
  * Adds a shader snippet to @pipeline. The snippet will wrap around or
  * replace some part of the pipeline as defined by the hook point in
diff --git a/cogl/cogl/cogl-xlib-renderer.h b/cogl/cogl/cogl-xlib-renderer.h
index 3afdabb27e..162a6ee7bc 100644
--- a/cogl/cogl/cogl-xlib-renderer.h
+++ b/cogl/cogl/cogl-xlib-renderer.h
@@ -59,7 +59,7 @@ G_BEGIN_DECLS
 
 /**
  * cogl_xlib_renderer_handle_event: (skip)
- * @renderer: a #CoglRenderer
+ * @renderer: (type gpointer): a #CoglRenderer
  * @event: pointer to an XEvent structure
  *
  * This function processes a single event; it can be used to hook into
@@ -91,9 +91,9 @@ typedef CoglFilterReturn (* CoglXlibFilterFunc) (XEvent *event,
 
 /**
  * cogl_xlib_renderer_add_filter: (skip)
- * @renderer: a #CoglRenderer
+ * @renderer: (type gpointer): a #CoglRenderer
  * @func: the callback function
- * @data: user data passed to @func when called
+ * @data: (closure func): user data passed to @func when called
  *
  * Adds a callback function that will receive all native events. The
  * function can stop further processing of the event by return
@@ -106,9 +106,9 @@ cogl_xlib_renderer_add_filter (CoglRenderer *renderer,
 
 /**
  * cogl_xlib_renderer_remove_filter: (skip)
- * @renderer: a #CoglRenderer
+ * @renderer: (type gpointer): a #CoglRenderer
  * @func: the callback function
- * @data: user data given when the callback was installed
+ * @data: (closure func): user data given when the callback was installed
  *
  * Removes a callback that was previously added with
  * cogl_xlib_renderer_add_filter().
@@ -120,7 +120,7 @@ cogl_xlib_renderer_remove_filter (CoglRenderer *renderer,
 
 /**
  * cogl_xlib_renderer_get_foreign_display: (skip)
- * @renderer: a #CoglRenderer
+ * @renderer: (type gpointer): a #CoglRenderer
  *
  * Return value: the foreign Xlib display that will be used by any Xlib based
  * winsys backend. The display needs to be set with
@@ -131,7 +131,7 @@ cogl_xlib_renderer_get_foreign_display (CoglRenderer *renderer);
 
 /**
  * cogl_xlib_renderer_set_foreign_display: (skip)
- * @renderer: a #CoglRenderer
+ * @renderer: (type gpointer): a #CoglRenderer
  *
  * Sets a foreign Xlib display that Cogl will use for and Xlib based winsys
  * backend.
@@ -147,13 +147,14 @@ cogl_xlib_renderer_set_foreign_display (CoglRenderer *renderer,
 
 /**
  * cogl_xlib_renderer_get_display: (skip)
+ * @renderer: (type gpointer):
  */
 COGL_EXPORT Display *
 cogl_xlib_renderer_get_display (CoglRenderer *renderer);
 
 /**
  * cogl_xlib_renderer_request_reset_on_video_memory_purge: (skip)
- * @renderer: a #CoglRenderer
+ * @renderer: (type gpointer): a #CoglRenderer
  * @enable: The new value
  *
  * Sets whether Cogl should make use of the


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]