AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-11-08 17:50:10 +00:00
Code Issues Projects Releases Wiki Activity

docs: Improve gsk docs

Browse Source 
Convert link formats, add summaries, and make
a few missing things show up in the docs.
This commit is contained in:
Matthias Clasen 2021-02-20 01:09:55 -05:00 committed by Emmanuele Bassi
parent e5bed812f5
commit ca3120919f
8 changed files with 324 additions and 262 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
gsk/gl/gskglrenderer.h
View File

@ -33,6 +33,11 @@ G_BEGIN_DECLS
#define GSK_IS_GL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_GL_RENDERER)) #define GSK_IS_GL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_GL_RENDERER))
#define GSK_GL_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_GL_RENDERER, GskGLRendererClass)) #define GSK_GL_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_GL_RENDERER, GskGLRendererClass))
/**
* GskGLRenderer:
*
* A GSK renderer that is using OpenGL.
*/
typedef struct _GskGLRenderer GskGLRenderer; typedef struct _GskGLRenderer GskGLRenderer;
typedef struct _GskGLRendererClass GskGLRendererClass; typedef struct _GskGLRendererClass GskGLRendererClass;

8
gsk/gskcairorenderer.h
View File

@ -34,6 +34,14 @@ G_BEGIN_DECLS
#define GSK_IS_CAIRO_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_CAIRO_RENDERER)) #define GSK_IS_CAIRO_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_CAIRO_RENDERER))
#define GSK_CAIRO_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_CAIRO_RENDERER, GskCairoRendererClass)) #define GSK_CAIRO_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_CAIRO_RENDERER, GskCairoRendererClass))
/**
* GskCairoRenderer:
*
* A GSK renderer that is using cairo.
*
* Since it is using cairo, this renderer cannot support
* 3D transformations.
*/
typedef struct _GskCairoRenderer GskCairoRenderer; typedef struct _GskCairoRenderer GskCairoRenderer;
typedef struct _GskCairoRendererClass GskCairoRendererClass; typedef struct _GskCairoRendererClass GskCairoRendererClass;

13
gsk/gskenums.h
View File

@ -201,9 +201,10 @@ typedef enum {
* @GSK_TRANSFORM_CATEGORY_2D_TRANSLATE: The matrix is a 2D translation. * @GSK_TRANSFORM_CATEGORY_2D_TRANSLATE: The matrix is a 2D translation.
* @GSK_TRANSFORM_CATEGORY_IDENTITY: The matrix is the identity matrix. * @GSK_TRANSFORM_CATEGORY_IDENTITY: The matrix is the identity matrix.
* *
* The categories of matrices relevant for GSK and GTK. Note that any * The categories of matrices relevant for GSK and GTK.
* category includes matrices of all later categories. So if you want *
* to for example check if a matrix is a 2D matrix, * Note that any category includes matrices of all later categories.
* So if you want to for example check if a matrix is a 2D matrix,
* `category >= GSK_TRANSFORM_CATEGORY_2D` is the way to do this. * `category >= GSK_TRANSFORM_CATEGORY_2D` is the way to do this.
* *
* Also keep in mind that rounding errors may cause matrices to not * Also keep in mind that rounding errors may cause matrices to not
@ -233,8 +234,10 @@ typedef enum
* @GSK_GL_UNIFORM_TYPE_VEC3: A GLSL vec3 / graphene_vec3_t uniform * @GSK_GL_UNIFORM_TYPE_VEC3: A GLSL vec3 / graphene_vec3_t uniform
* @GSK_GL_UNIFORM_TYPE_VEC4: A GLSL vec4 / graphene_vec4_t uniform * @GSK_GL_UNIFORM_TYPE_VEC4: A GLSL vec4 / graphene_vec4_t uniform
* *
* This defines the types of the uniforms that #GskGLShaders * This defines the types of the uniforms that `GskGLShaders`
* declare. It defines both what the type is called in the GLSL shader * declare.
*
* It defines both what the type is called in the GLSL shader
* code, and what the corresponding C type is on the Gtk side. * code, and what the corresponding C type is on the Gtk side.
*/ */
typedef enum typedef enum

197
gsk/gskglshader.c
View File

@ -17,25 +17,26 @@
*/ */
/** /**
* SECTION:GskGLShader * SECTION:gskglshader
* @Title: GskGLShader * @Title: GskGLShader
* @Short_description: Fragment shaders for GSK * @Short_description: Fragment shaders for GSK
* *
* A #GskGLShader is a snippet of GLSL that is meant to run in the * A `GskGLShader` is a snippet of GLSL that is meant to run in the
* fragment shader of the rendering pipeline. A fragment shader * fragment shader of the rendering pipeline.
* gets the coordinates being rendered as input and produces the *
* pixel values for that particular pixel. Additionally, the * A fragment shader gets the coordinates being rendered as input and
* shader can declare a set of other input arguments, called * produces the pixel values for that particular pixel. Additionally,
* the shader can declare a set of other input arguments, called
* uniforms (as they are uniform over all the calls to your shader in * uniforms (as they are uniform over all the calls to your shader in
* each instance of use). A shader can also receive up to 4 * each instance of use). A shader can also receive up to 4
* textures that it can use as input when producing the pixel data. * textures that it can use as input when producing the pixel data.
* *
#GskGLShader is usually used with gtk_snapshot_push_gl_shader() * `GskGLShader` is usually used with gtk_snapshot_push_gl_shader()
* to produce a #GskGLShaderNode in the rendering hierarchy, and then * to produce a [class@Gsk.GLShaderNode] in the rendering hierarchy,
* its input textures are constructed by rendering the child nodes to * and then its input textures are constructed by rendering the child
* textures before rendering the shader node itself. (You can pass * nodes to textures before rendering the shader node itself. (You can
* texture nodes as children if you want to directly use a texture * pass texture nodes as children if you want to directly use a texture
* as input). * as input).
* *
* The actual shader code is GLSL code that gets combined with * The actual shader code is GLSL code that gets combined with
* some other code into the fragment shader. Since the exact * some other code into the fragment shader. Since the exact
@ -56,16 +57,16 @@
* *
* The main function the shader must implement is: * The main function the shader must implement is:
* *
* |[<!-- language="plain" --> * ```glsl
* void mainImage(out vec4 fragColor, * void mainImage(out vec4 fragColor,
* in vec2 fragCoord, * in vec2 fragCoord,
* in vec2 resolution, * in vec2 resolution,
* in vec2 uv) * in vec2 uv)
* ]| * ```
* *
* Where the input @fragCoord is the coordinate of the pixel we're * Where the input @fragCoord is the coordinate of the pixel we're
* currently rendering, relative to the boundary rectangle that was * currently rendering, relative to the boundary rectangle that was
* specified in the #GskGLShaderNode, and @resolution is the width and * specified in the `GskGLShaderNode`, and @resolution is the width and
* height of that rectangle. This is in the typical GTK coordinate * height of that rectangle. This is in the typical GTK coordinate
* system with the origin in the top left. @uv contains the u and v * system with the origin in the top left. @uv contains the u and v
* coordinates that can be used to index a texture at the * coordinates that can be used to index a texture at the
@ -90,26 +91,26 @@
* Note that GTK parses the uniform declarations, so each uniform has to * Note that GTK parses the uniform declarations, so each uniform has to
* be on a line by itself with no other code, like so: * be on a line by itself with no other code, like so:
* *
* |[<!-- language="plain" --> * ```glsl
* uniform float u_time; * uniform float u_time;
* uniform vec3 u_color; * uniform vec3 u_color;
* uniform sampler2D u_texture1; * uniform sampler2D u_texture1;
* uniform sampler2D u_texture2; * uniform sampler2D u_texture2;
* ]| * ```
* *
* GTK uses the the "gsk" namespace in the symbols it uses in the * GTK uses the the "gsk" namespace in the symbols it uses in the
* shader, so your code should not use any symbols with the prefix gsk * shader, so your code should not use any symbols with the prefix gsk
* or GSK. There are some helper functions declared that you can use: * or GSK. There are some helper functions declared that you can use:
* *
* |[<!-- language="plain" --> * ```glsl
* vec4 GskTexture(sampler2D sampler, vec2 texCoords); * vec4 GskTexture(sampler2D sampler, vec2 texCoords);
* ]| * ```
* *
* This samples a texture (e.g. u_texture1) at the specified * This samples a texture (e.g. u_texture1) at the specified
* coordinates, and containes some helper ifdefs to ensure that * coordinates, and containes some helper ifdefs to ensure that
* it works on all OpenGL versions. * it works on all OpenGL versions.
* *
* You can compile the shader yourself using gsk_gl_shader_compile(), * You can compile the shader yourself using [method@Gsk.GLShader.compile],
* otherwise the GSK renderer will do it when it handling the glshader * otherwise the GSK renderer will do it when it handling the glshader
* node. If errors occurs, the returned @error will include the glsl * node. If errors occurs, the returned @error will include the glsl
* sources, so you can see what GSK was passing to the compiler. You * sources, so you can see what GSK was passing to the compiler. You
@ -118,7 +119,7 @@
* *
* # An example shader * # An example shader
* *
* |[<!-- language="plain" --> * ```glsl
* uniform float position; * uniform float position;
* uniform sampler2D u_texture1; * uniform sampler2D u_texture1;
* uniform sampler2D u_texture2; * uniform sampler2D u_texture2;
@ -132,7 +133,7 @@
* *
* fragColor = position * source1 + (1.0 - position) * source2; * fragColor = position * source1 + (1.0 - position) * source2;
* } * }
* ]| * ```
*/ */
#include "config.h" #include "config.h"
@ -443,7 +444,7 @@ gsk_gl_shader_class_init (GskGLShaderClass *klass)
/** /**
* GskGLShader:sourcecode: * GskGLShader:sourcecode:
* *
* The source code for the shader, as a #GBytes. * The source code for the shader, as a `GBytes`.
*/ */
gsk_gl_shader_properties[GLSHADER_PROP_SOURCE] = gsk_gl_shader_properties[GLSHADER_PROP_SOURCE] =
g_param_spec_boxed ("source", g_param_spec_boxed ("source",
@ -486,7 +487,7 @@ gsk_gl_shader_init (GskGLShader *shader)
* *
* Creates a #GskGLShader that will render pixels using the specified code. * Creates a #GskGLShader that will render pixels using the specified code.
* *
* Returns: (transfer full): A new #GskGLShader * Returns: (transfer full): A new `GskGLShader`
*/ */
GskGLShader * GskGLShader *
gsk_gl_shader_new_from_bytes (GBytes *sourcecode) gsk_gl_shader_new_from_bytes (GBytes *sourcecode)
@ -503,9 +504,9 @@ gsk_gl_shader_new_from_bytes (GBytes *sourcecode)
* @resource_path: path to a resource that contains the GLSL sourcecode for * @resource_path: path to a resource that contains the GLSL sourcecode for
* the shader * the shader
* *
* Creates a #GskGLShader that will render pixels using the specified code. * Creates a `GskGLShader` that will render pixels using the specified code.
* *
* Returns: (transfer full): A new #GskGLShader * Returns: (transfer full): A new `GskGLShader`
*/ */
GskGLShader * GskGLShader *
gsk_gl_shader_new_from_resource (const char *resource_path) gsk_gl_shader_new_from_resource (const char *resource_path)
@ -523,10 +524,12 @@ gsk_gl_shader_new_from_resource (const char *resource_path)
* @renderer: a #GskRenderer * @renderer: a #GskRenderer
* @error: location to store error in * @error: location to store error in
* *
* Tries to compile the @shader for the given @renderer, and reports * Tries to compile the @shader for the given @renderer.
* %FALSE with an error if there is a problem. You should use this *
* function before relying on the shader for rendering and use a * If there is a problem, this function returns %FALSE and reports
* fallback with a simpler shader or without shaders if it fails. * an error. You should use this function before relying on the shader
* for rendering and use a fallback with a simpler shader or without
* shaders if it fails.
* *
* Note that this will modify the rendering state (for example * Note that this will modify the rendering state (for example
* change the current GL context) and requires the renderer to be * change the current GL context) and requires the renderer to be
@ -556,7 +559,7 @@ gsk_gl_shader_compile (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_source: * gsk_gl_shader_get_source:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* *
* Gets the GLSL sourcecode being used to render this shader. * Gets the GLSL sourcecode being used to render this shader.
* *
@ -572,7 +575,7 @@ gsk_gl_shader_get_source (GskGLShader *shader)
/** /**
* gsk_gl_shader_get_resource: * gsk_gl_shader_get_resource:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* *
* Gets the resource path for the GLSL sourcecode being used * Gets the resource path for the GLSL sourcecode being used
* to render this shader. * to render this shader.
@ -590,7 +593,7 @@ gsk_gl_shader_get_resource (GskGLShader *shader)
/** /**
* gsk_gl_shader_get_n_textures: * gsk_gl_shader_get_n_textures:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* *
* Returns the number of textures that the shader requires. * Returns the number of textures that the shader requires.
* *
@ -610,7 +613,7 @@ gsk_gl_shader_get_n_textures (GskGLShader *shader)
/** /**
* gsk_gl_shader_get_n_uniforms: * gsk_gl_shader_get_n_uniforms:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* *
* Get the number of declared uniforms for this shader. * Get the number of declared uniforms for this shader.
* *
@ -626,7 +629,7 @@ gsk_gl_shader_get_n_uniforms (GskGLShader *shader)
/** /**
* gsk_gl_shader_get_uniform_name: * gsk_gl_shader_get_uniform_name:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @idx: index of the uniform * @idx: index of the uniform
* *
* Get the name of the declared uniform for this shader at index @idx. * Get the name of the declared uniform for this shader at index @idx.
@ -644,7 +647,7 @@ gsk_gl_shader_get_uniform_name (GskGLShader *shader,
/** /**
* gsk_gl_shader_find_uniform_by_name: * gsk_gl_shader_find_uniform_by_name:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @name: uniform name * @name: uniform name
* *
* Looks for a uniform by the name @name, and returns the index * Looks for a uniform by the name @name, and returns the index
@ -670,7 +673,7 @@ gsk_gl_shader_find_uniform_by_name (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_uniform_type: * gsk_gl_shader_get_uniform_type:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @idx: index of the uniform * @idx: index of the uniform
* *
* Get the type of the declared uniform for this shader at index @idx. * Get the type of the declared uniform for this shader at index @idx.
@ -688,7 +691,7 @@ gsk_gl_shader_get_uniform_type (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_uniform_offset: * gsk_gl_shader_get_uniform_offset:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @idx: index of the uniform * @idx: index of the uniform
* *
* Get the offset into the data block where data for this uniforms is stored. * Get the offset into the data block where data for this uniforms is stored.
@ -714,7 +717,7 @@ gsk_gl_shader_get_uniforms (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_args_size: * gsk_gl_shader_get_args_size:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* *
* Get the size of the data block used to specify arguments for this shader. * Get the size of the data block used to specify arguments for this shader.
* *
@ -744,11 +747,12 @@ gsk_gl_shader_find_uniform (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_float: * gsk_gl_shader_get_arg_float:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of float type. * The uniform must be of float type.
* *
* Returns: The value * Returns: The value
@ -776,11 +780,12 @@ gsk_gl_shader_get_arg_float (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_int: * gsk_gl_shader_get_arg_int:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of int type. * The uniform must be of int type.
* *
* Returns: The value * Returns: The value
@ -808,11 +813,12 @@ gsk_gl_shader_get_arg_int (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_uint: * gsk_gl_shader_get_arg_uint:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of uint type. * The uniform must be of uint type.
* *
* Returns: The value * Returns: The value
@ -840,11 +846,12 @@ gsk_gl_shader_get_arg_uint (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_bool: * gsk_gl_shader_get_arg_bool:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of bool type. * The uniform must be of bool type.
* *
* Returns: The value * Returns: The value
@ -872,12 +879,13 @@ gsk_gl_shader_get_arg_bool (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_vec2: * gsk_gl_shader_get_arg_vec2:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* @out_value: location to store the uniform value in * @out_value: location to store the uniform value in
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of vec2 type. * The uniform must be of vec2 type.
*/ */
void void
@ -904,12 +912,13 @@ gsk_gl_shader_get_arg_vec2 (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_vec3: * gsk_gl_shader_get_arg_vec3:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* @out_value: location to store the uniform value in * @out_value: location to store the uniform value in
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of vec3 type. * The uniform must be of vec3 type.
*/ */
void void
@ -936,12 +945,13 @@ gsk_gl_shader_get_arg_vec3 (GskGLShader *shader,
/** /**
* gsk_gl_shader_get_arg_vec4: * gsk_gl_shader_get_arg_vec4:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @args: uniform arguments * @args: uniform arguments
* @idx: index of the uniform * @idx: index of the uniform
* @out_value: location to store set the uniform value in * @out_value: location to store set the uniform value in
* *
* Gets the value of the uniform @idx in the @args block. * Gets the value of the uniform @idx in the @args block.
*
* The uniform must be of vec4 type. * The uniform must be of vec4 type.
*/ */
void void
@ -968,15 +978,16 @@ gsk_gl_shader_get_arg_vec4 (GskGLShader *shader,
/** /**
* gsk_gl_shader_format_args_va: * gsk_gl_shader_format_args_va:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @uniforms: name-Value pairs for the uniforms of @shader, ending * @uniforms: name-Value pairs for the uniforms of @shader, ending
* with a %NULL name * with a %NULL name
* *
* Formats the uniform data as needed for feeding the named uniforms * Formats the uniform data as needed for feeding the named uniforms
* values into the shader. The argument list is a list of pairs of * values into the shader.
* names, and values for the types that match the declared uniforms *
* (i.e. double/int/guint/gboolean for primitive values and * The argument list is a list of pairs of names, and values for the
* `graphene_vecN_t *` for vecN uniforms). * types that match the declared uniforms (i.e. double/int/guint/gboolean
* for primitive values and `graphene_vecN_t *` for vecN uniforms).
* *
* It is an error to pass a uniform name that is not declared by the shader. * It is an error to pass a uniform name that is not declared by the shader.
* *
@ -984,7 +995,7 @@ gsk_gl_shader_get_arg_vec4 (GskGLShader *shader,
* are zero-initialized. * are zero-initialized.
* *
* Returns: (transfer full): A newly allocated block of data which can be * Returns: (transfer full): A newly allocated block of data which can be
* passed to gsk_gl_shader_node_new(). * passed to [ctor@Gsk.GLShaderNode.new].
*/ */
GBytes * GBytes *
gsk_gl_shader_format_args_va (GskGLShader *shader, gsk_gl_shader_format_args_va (GskGLShader *shader,
@ -1053,21 +1064,22 @@ gsk_gl_shader_format_args_va (GskGLShader *shader,
/** /**
* gsk_gl_shader_format_args: * gsk_gl_shader_format_args:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @...: name-Value pairs for the uniforms of @shader, ending with * @...: name-Value pairs for the uniforms of @shader, ending with
* a %NULL name * a %NULL name
* *
* Formats the uniform data as needed for feeding the named uniforms * Formats the uniform data as needed for feeding the named uniforms
* values into the shader. The argument list is a list of pairs of * values into the shader.
* names, and values for the types that match the declared uniforms *
* (i.e. double/int/guint/gboolean for primitive values and * The argument list is a list of pairs of names, and values for the types
* `graphene_vecN_t *` for vecN uniforms). * that match the declared uniforms (i.e. double/int/guint/gboolean for
* primitive values and `graphene_vecN_t *` for vecN uniforms).
* *
* Any uniforms of the shader that are not included in the argument list * Any uniforms of the shader that are not included in the argument list
* are zero-initialized. * are zero-initialized.
* *
* Returns: (transfer full): A newly allocated block of data which can be * Returns: (transfer full): A newly allocated block of data which can be
* passed to gsk_gl_shader_node_new(). * passed to [ctor@Gsk.GLShaderNode.new].
*/ */
GBytes * GBytes *
gsk_gl_shader_format_args (GskGLShader *shader, gsk_gl_shader_format_args (GskGLShader *shader,
@ -1096,14 +1108,14 @@ G_DEFINE_BOXED_TYPE (GskShaderArgsBuilder, gsk_shader_args_builder,
/** /**
* gsk_shader_args_builder_new: * gsk_shader_args_builder_new:
* @shader: a #GskGLShader * @shader: a `GskGLShader`
* @initial_values: (nullable): optional #Bytes with initial values * @initial_values: (nullable): optional `GBytes` with initial values
* *
* Allocates a builder that can be used to construct a new uniform data * Allocates a builder that can be used to construct a new uniform data
* chunk. * chunk.
* *
* Returns: (transfer full): The newly allocated builder, free with * Returns: (transfer full): The newly allocated builder, free with
* gsk_shader_args_builder_unref() * [method@Gsk.ShaderArgsBuilder.unref]
*/ */
GskShaderArgsBuilder * GskShaderArgsBuilder *
gsk_shader_args_builder_new (GskGLShader *shader, gsk_shader_args_builder_new (GskGLShader *shader,
@ -1128,21 +1140,23 @@ gsk_shader_args_builder_new (GskGLShader *shader,
/** /**
* gsk_shader_args_builder_to_args: * gsk_shader_args_builder_to_args:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* *
* Creates a new #GBytes args from the current state of the * Creates a new `GBytes` args from the current state of the
* given @builder. Any uniforms of the shader that have not * given @builder.
* been explicitly set on the @builder are zero-initialized.
* *
* The given #GskShaderArgsBuilder is reset once this function returns; * Any uniforms of the shader that have not been explicitly set on
* the @builder are zero-initialized.
*
* The given `GskShaderArgsBuilder` is reset once this function returns;
* you cannot call this function multiple times on the same @builder instance. * you cannot call this function multiple times on the same @builder instance.
* *
* This function is intended primarily for bindings. C code should use * This function is intended primarily for bindings. C code should use
* gsk_shader_args_builder_free_to_args(). * [method@Gsk.ShaderArgsBuilder.free_to_args].
* *
* *
* Returns: (transfer full): the newly allocated builder, free with * Returns: (transfer full): the newly allocated buffer with
* gsk_shader_args_builder_free() * all the args added to @builder
*/ */
GBytes * GBytes *
gsk_shader_args_builder_to_args (GskShaderArgsBuilder *builder) gsk_shader_args_builder_to_args (GskShaderArgsBuilder *builder)
@ -1153,15 +1167,16 @@ gsk_shader_args_builder_to_args (GskShaderArgsBuilder *builder)
/** /**
* gsk_shader_args_builder_free_to_args: (skip) * gsk_shader_args_builder_free_to_args: (skip)
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* *
* Creates a new #GBytes args from the current state of the * Creates a new #GBytes args from the current state of the
* given @builder, and frees the @builder instance. Any uniforms * given @builder, and frees the @builder instance.
* of the shader that have not been explicitly set on the @builder
* are zero-initialized.
* *
* Returns: (transfer full): the newly created #GBytes * Any uniforms of the shader that have not been explicitly set
* with all the args added to @builder * on the @builder are zero-initialized.
*
* Returns: (transfer full): the newly allocated buffer with
* all the args added to @builder
*/ */
GBytes * GBytes *
gsk_shader_args_builder_free_to_args (GskShaderArgsBuilder *builder) gsk_shader_args_builder_free_to_args (GskShaderArgsBuilder *builder)
@ -1180,9 +1195,10 @@ gsk_shader_args_builder_free_to_args (GskShaderArgsBuilder *builder)
/** /**
* gsk_shader_args_builder_unref: * gsk_shader_args_builder_unref:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
*
* Decreases the reference count of a `GskShaderArgBuilder` by one.
* *
* Decreases the reference count of a #GskShaderArgBuilder by one.
* If the resulting reference count is zero, frees the builder. * If the resulting reference count is zero, frees the builder.
*/ */
void void
@ -1203,11 +1219,11 @@ gsk_shader_args_builder_unref (GskShaderArgsBuilder *builder)
/** /**
* gsk_shader_args_builder_ref: * gsk_shader_args_builder_ref:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* *
* Increases the reference count of a #GskShaderArgsBuilder by one. * Increases the reference count of a `GskShaderArgsBuilder` by one.
* *
* Returns: the passed in #GskShaderArgsBuilder * Returns: the passed in `GskShaderArgsBuilder`
*/ */
GskShaderArgsBuilder * GskShaderArgsBuilder *
gsk_shader_args_builder_ref (GskShaderArgsBuilder *builder) gsk_shader_args_builder_ref (GskShaderArgsBuilder *builder)
@ -1220,11 +1236,12 @@ gsk_shader_args_builder_ref (GskShaderArgsBuilder *builder)
/** /**
* gsk_shader_args_builder_set_float: * gsk_shader_args_builder_set_float:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform to * @value: value to set the uniform to
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of float type. * The uniform must be of float type.
*/ */
void void
@ -1247,11 +1264,12 @@ gsk_shader_args_builder_set_float (GskShaderArgsBuilder *builder,
/** /**
* gsk_shader_args_builder_set_int: * gsk_shader_args_builder_set_int:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform to * @value: value to set the uniform to
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of int type. * The uniform must be of int type.
*/ */
void void
@ -1274,11 +1292,12 @@ gsk_shader_args_builder_set_int (GskShaderArgsBuilder *builder,
/** /**
* gsk_shader_args_builder_set_uint: * gsk_shader_args_builder_set_uint:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform to * @value: value to set the uniform to
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of uint type. * The uniform must be of uint type.
*/ */
void void
@ -1301,11 +1320,12 @@ gsk_shader_args_builder_set_uint (GskShaderArgsBuilder *builder,
/** /**
* gsk_shader_args_builder_set_bool: * gsk_shader_args_builder_set_bool:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform to * @value: value to set the uniform to
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of bool type. * The uniform must be of bool type.
*/ */
void void
@ -1328,11 +1348,12 @@ gsk_shader_args_builder_set_bool (GskShaderArgsBuilder *builder,
/** /**
* gsk_shader_args_builder_set_vec2: * gsk_shader_args_builder_set_vec2:
* @builder: A #GskShaderArgsBuilder * @builder: A `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform too * @value: value to set the uniform too
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of vec2 type. * The uniform must be of vec2 type.
*/ */
void void
@ -1355,11 +1376,12 @@ gsk_shader_args_builder_set_vec2 (GskShaderArgsBuilder *builder,
/** /**
* gsk_shader_args_builder_set_vec3: * gsk_shader_args_builder_set_vec3:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform too * @value: value to set the uniform too
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of vec3 type. * The uniform must be of vec3 type.
*/ */
void void
@ -1382,11 +1404,12 @@ gsk_shader_args_builder_set_vec3 (GskShaderArgsBuilder *builder,
/** /**
* gsk_shader_args_builder_set_vec4: * gsk_shader_args_builder_set_vec4:
* @builder: a #GskShaderArgsBuilder * @builder: a `GskShaderArgsBuilder`
* @idx: index of the uniform * @idx: index of the uniform
* @value: value to set the uniform too * @value: value to set the uniform too
* *
* Sets the value of the uniform @idx. * Sets the value of the uniform @idx.
*
* The uniform must be of vec4 type. * The uniform must be of vec4 type.
*/ */
void void

4
gsk/gskrendernode.h
View File

@ -98,8 +98,8 @@ struct _GskParseLocation
* @error: the error * @error: the error
* @user_data: user data * @user_data: user data
* *
* The type of callback that is called when a parse error occurs * Type of callback that is called when an error occurs
* during deserialization of node data. * during node deserialization.
*/ */
typedef void (* GskParseErrorFunc) (const GskParseLocation *start, typedef void (* GskParseErrorFunc) (const GskParseLocation *start,
const GskParseLocation *end, const GskParseLocation *end,

350
gsk/gskrendernodeimpl.c
View File

File diff suppressed because it is too large Load Diff

4
gsk/gsktransform.c
View File

@ -2125,7 +2125,9 @@ fail:
* @out_transform: (out): The location to put the transform in * @out_transform: (out): The location to put the transform in
* *
* Parses the given @string into a transform and puts it in * Parses the given @string into a transform and puts it in
* @out_transform. Strings printed via gsk_transform_to_string() * @out_transform.
*
* Strings printed via [method@Gsk.Transform.to_string]
* can be read in again successfully using this function. * can be read in again successfully using this function.
* *
* If @string does not describe a valid transform, %FALSE is * If @string does not describe a valid transform, %FALSE is

5
gsk/vulkan/gskvulkanrenderer.h
View File

@ -35,6 +35,11 @@ G_BEGIN_DECLS
#define GSK_IS_VULKAN_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_VULKAN_RENDERER)) #define GSK_IS_VULKAN_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GSK_TYPE_VULKAN_RENDERER))
#define GSK_VULKAN_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_VULKAN_RENDERER, GskVulkanRendererClass)) #define GSK_VULKAN_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GSK_TYPE_VULKAN_RENDERER, GskVulkanRendererClass))
/**
* GskVulkanRenderer:
*
* A GSK renderer that is using Vulkan.
*/
typedef struct _GskVulkanRenderer GskVulkanRenderer; typedef struct _GskVulkanRenderer GskVulkanRenderer;
typedef struct _GskVulkanRendererClass GskVulkanRendererClass; typedef struct _GskVulkanRendererClass GskVulkanRendererClass;