[gtk/matthiasc/glshader-node] gsk: Small doc tweaks



commit 6fc92940369de0ef3bc578a2c3fdf29f2fec8d73
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Sep 28 13:53:51 2020 -0400

    gsk: Small doc tweaks
    
    Add an annotation, and tweak the docs for
    gsk_gl_shader_node_new slightly.

 gsk/gskrendernodeimpl.c | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)
---
diff --git a/gsk/gskrendernodeimpl.c b/gsk/gskrendernodeimpl.c
index 8ca1ece25d..4513ad5733 100644
--- a/gsk/gskrendernodeimpl.c
+++ b/gsk/gskrendernodeimpl.c
@@ -4541,13 +4541,15 @@ gsk_gl_shader_node_diff (GskRenderNode  *node1,
  * @shader: the #GskGLShader
  * @bounds: the rectangle to render the shader into
  * @args: Arguments for the uniforms
- * @children: List of child nodes, these will be rendered to textures and used as input.
- * @n_children: Length of @children (currenly the GL backend only supports max 4 children)
+ * @children: (array length=n_children): array of child nodes, these will
+ *     be rendered to textures and used as input.
+ * @n_children: Length of @children (currenly the GL backend supports
+ *     up to 4 children)
  *
- * Creates a #GskRenderNode that will render the given @shader into the area
- * given by @bounds. The @args is a block of data to use for uniform
- * input, as per types and offsets defined by the @shader. Normally this is
- * generated by gsk_gl_shader_format_args() or #GskGLShaderArgBuilder.
+ * Creates a #GskRenderNode that will render the given @shader into the
+ * area given by @bounds. The @args is a block of data to use for uniform
+ * input, as per types and offsets defined by the @shader. Normally this
+ * is generated by gsk_gl_shader_format_args() or #GskGLShaderArgBuilder.
  *
  * See #GskGLShader for details about how the shader should be written.
  *
@@ -4555,10 +4557,10 @@ gsk_gl_shader_node_diff (GskRenderNode  *node1,
  * #GskTextureNodes, which will be used directly). These textures will be
  * sent as input to the shader.
  *
- * If the renderer doesn't support GL shaders, or if there is any problem when
- * compiling the shader, then the node will draw pink. You should use
- * gsk_gl_shader_try_compile_for() to ensure the @shader will work for the renderer
- * before using it.
+ * If the renderer doesn't support GL shaders, or if there is any problem
+ * when compiling the shader, then the node will draw pink. You should use
+ * gsk_gl_shader_try_compile_for() to ensure the @shader will work for the
+ * renderer before using it.
  *
  * Returns: (transfer full) (type GskGLShaderNode): A new #GskRenderNode
  */


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