:right-sidebar: True GLShader =================================================================== .. currentmodule:: gi.repository.Gsk .. class:: GLShader(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` A ``GskGLShader`` is a snippet of GLSL that is meant to run in the fragment shader of the rendering pipeline. A fragment shader gets the coordinates being rendered as input and 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 each instance of use). A shader can also receive up to 4 textures that it can use as input when producing the pixel data. ``GskGLShader`` is usually used with gtk_snapshot_push_gl_shader() to produce a :obj:`~gi.repository.Gsk.GLShaderNode` in the rendering hierarchy, and then its input textures are constructed by rendering the child nodes to textures before rendering the shader node itself. (You can pass texture nodes as children if you want to directly use a texture as input). The actual shader code is GLSL code that gets combined with some other code into the fragment shader. Since the exact capabilities of the GPU driver differs between different OpenGL drivers and hardware, GTK adds some defines that you can use to ensure your GLSL code runs on as many drivers as it can. If the OpenGL driver is GLES, then the shader language version is set to 100, and GSK_GLES will be defined in the shader. Otherwise, if the OpenGL driver does not support the 3.2 core profile, then the shader will run with language version 110 for GL2 and 130 for GL3, and GSK_LEGACY will be defined in the shader. If the OpenGL driver supports the 3.2 code profile, it will be used, the shader language version is set to 150, and GSK_GL3 will be defined in the shader. The main function the shader must implement is: .. code-block:: glsl :dedent: void mainImage(out vec4 fragColor, in vec2 fragCoord, in vec2 resolution, in vec2 uv) Where the input ``fragCoord`` is the coordinate of the pixel we're currently rendering, relative to the boundary rectangle that was specified in the ``GskGLShaderNode``\, and ``resolution`` is the width and 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 coordinates that can be used to index a texture at the corresponding point. These coordinates are in the [0..1]x[0..1] region, with 0, 0 being in the lower left corder (which is typical for OpenGL). The output ``fragColor`` should be a RGBA color (with premultiplied alpha) that will be used as the output for the specified pixel location. Note that this output will be automatically clipped to the clip region of the glshader node. In addition to the function arguments the shader can define up to 4 uniforms for textures which must be called u_textureN (i.e. u_texture1 to u_texture4) as well as any custom uniforms you want of types int, uint, bool, float, vec2, vec3 or vec4. All textures sources contain premultiplied alpha colors, but if some there are outer sources of colors there is a gsk_premultiply() helper to compute premultiplication when needed. Note that GTK parses the uniform declarations, so each uniform has to be on a line by itself with no other code, like so: .. code-block:: glsl :dedent: uniform float u_time; uniform vec3 u_color; uniform sampler2D u_texture1; uniform sampler2D u_texture2; GTK uses the "gsk" namespace in the symbols it uses in the 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: .. code-block:: glsl :dedent: vec4 GskTexture(sampler2D sampler, vec2 texCoords); This samples a texture (e.g. u_texture1) at the specified coordinates, and contains some helper ifdefs to ensure that it works on all OpenGL versions. You can compile the shader yourself using :obj:`~gi.repository.Gsk.GLShader.compile`\, otherwise the GSK renderer will do it when it handling the glshader node. If errors occurs, the returned ``error`` will include the glsl sources, so you can see what GSK was passing to the compiler. You can also set GSK_DEBUG=shaders in the environment to see the sources and other relevant information about all shaders that GSK is handling. An example shader -------------------------------------------------------------------------------- .. code-block:: glsl :dedent: uniform float position; uniform sampler2D u_texture1; uniform sampler2D u_texture2; void mainImage(out vec4 fragColor, in vec2 fragCoord, in vec2 resolution, in vec2 uv) { vec4 source1 = GskTexture(u_texture1, uv); vec4 source2 = GskTexture(u_texture2, uv); fragColor = position * source1 + (1.0 - position) * source2; } Deprecation -------------------------------------------------------------------------------- This feature was deprecated in GTK 4.16 after the new rendering infrastructure introduced in 4.14 did not support it. The lack of Vulkan integration would have made it a very hard feature to support. If you want to use OpenGL directly, you should look at `GtkGLArea <../gtk4/class.GLArea.html>`__ which uses a different approach and is still well supported. Constructors ------------ .. rst-class:: interim-class .. class:: GLShader :no-index: .. classmethod:: new_from_bytes(sourcecode: ~gi.repository.GLib.Bytes) -> ~gi.repository.Gsk.GLShader Creates a ``GskGLShader`` that will render pixels using the specified code. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param sourcecode: GLSL sourcecode for the shader, as a ``GBytes`` .. classmethod:: new_from_resource(resource_path: str) -> ~gi.repository.Gsk.GLShader Creates a ``GskGLShader`` that will render pixels using the specified code. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param resource_path: path to a resource that contains the GLSL sourcecode for the shader Methods ------- .. rst-class:: interim-class .. class:: GLShader :no-index: .. method:: compile(renderer: ~gi.repository.Gsk.Renderer) -> bool Tries to compile the ``shader`` for the given ``renderer``\. If there is a problem, this function returns :const:`False` and reports 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 change the current GL context) and requires the renderer to be set up. This means that the widget has to be realized. Commonly you want to call this from the realize signal of a widget, or during widget snapshot. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param renderer: a ``GskRenderer`` .. method:: find_uniform_by_name(name: str) -> int Looks for a uniform by the name ``name``\, and returns the index of the uniform, or -1 if it was not found. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param name: uniform name .. method:: get_arg_bool(args: ~gi.repository.GLib.Bytes, idx: int) -> bool Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of bool type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform .. method:: get_arg_float(args: ~gi.repository.GLib.Bytes, idx: int) -> float Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of float type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform .. method:: get_arg_int(args: ~gi.repository.GLib.Bytes, idx: int) -> int Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of int type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform .. method:: get_arg_uint(args: ~gi.repository.GLib.Bytes, idx: int) -> int Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of uint type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform .. method:: get_arg_vec2(args: ~gi.repository.GLib.Bytes, idx: int, out_value: ~gi.repository.Graphene.Vec2) -> None Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of vec2 type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform :param out_value: location to store the uniform value in .. method:: get_arg_vec3(args: ~gi.repository.GLib.Bytes, idx: int, out_value: ~gi.repository.Graphene.Vec3) -> None Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of vec3 type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform :param out_value: location to store the uniform value in .. method:: get_arg_vec4(args: ~gi.repository.GLib.Bytes, idx: int, out_value: ~gi.repository.Graphene.Vec4) -> None Gets the value of the uniform ``idx`` in the ``args`` block. The uniform must be of vec4 type. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param args: uniform arguments :param idx: index of the uniform :param out_value: location to store set the uniform value in .. method:: get_args_size() -> int Get the size of the data block used to specify arguments for this shader. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. .. method:: get_n_textures() -> int Returns the number of textures that the shader requires. This can be used to check that the a passed shader works in your usecase. It is determined by looking at the highest u_textureN value that the shader defines. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. .. method:: get_n_uniforms() -> int Get the number of declared uniforms for this shader. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. .. method:: get_resource() -> str | None Gets the resource path for the GLSL sourcecode being used to render this shader. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. .. method:: get_source() -> ~gi.repository.GLib.Bytes Gets the GLSL sourcecode being used to render this shader. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. .. method:: get_uniform_name(idx: int) -> str Get the name of the declared uniform for this shader at index ``idx``\. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param idx: index of the uniform .. method:: get_uniform_offset(idx: int) -> int Get the offset into the data block where data for this uniforms is stored. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param idx: index of the uniform .. method:: get_uniform_type(idx: int) -> ~gi.repository.Gsk.GLUniformType Get the type of the declared uniform for this shader at index ``idx``\. .. deprecated:: 4.16 GTK's new Vulkan-focused rendering does not support this feature. Use `GtkGLArea <../gtk4/class.GLArea.html>`__ for OpenGL rendering. :param idx: index of the uniform Properties ---------- .. rst-class:: interim-class .. class:: GLShader :no-index: .. attribute:: props.resource :type: str The type of the None singleton. .. attribute:: props.source :type: ~gi.repository.GLib.Bytes The type of the None singleton.