Package org.gnome.gsk

Class GLShaderNode

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gsk.RenderNode

org.gnome.gsk.GLShaderNode

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class GLShaderNode
extends RenderNode

A render node using a GL shader when drawing its children nodes.

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gsk.RenderNode

RenderNode.RenderNodeImpl

Constructor Summary

Constructors

Constructor	Description
GLShaderNode(MemorySegment address)	Create a GLShaderNode proxy instance for the provided memory address.
GLShaderNode(GLShader shader, Rect bounds, Bytes args, @Nullable RenderNode[] children)	Deprecated. GTK's new Vulkan-focused rendering does not support this feature.

Method Summary

Modifier and Type	Method	Description
protected GLShaderNode	asParent()	Returns this instance as if it were its parent type.
Bytes	getArgs()	Deprecated. GTK's new Vulkan-focused rendering does not support this feature.
RenderNode	getChild(int idx)	Deprecated. GTK's new Vulkan-focused rendering does not support this feature.
int	getNChildren()	Deprecated. GTK's new Vulkan-focused rendering does not support this feature.
GLShader	getShader()	Gets shader code for the node.
static Type	getType()	Get the GType of the GLShaderNode class

Methods inherited from class org.gnome.gsk.RenderNode

deserialize, draw, getBounds, getNodeType, getOpaqueRect, ref, serialize, unref, writeToFile

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getMemoryLayout, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GLShaderNode

public GLShaderNode(MemorySegment address)

Create a GLShaderNode proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

GLShaderNode

@Deprecated
public GLShaderNode(GLShader shader,
 Rect bounds,
 Bytes args,
 @Nullable
 @Nullable RenderNode[] children)

Deprecated.

GTK's new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

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 GLShader.formatArgs(java.lang.Object...) or Gsk.ShaderArgsBuilder.

See GLShader for details about how the shader should be written.

All the children will be rendered into textures (if they aren't already 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 GLShader.compile(org.gnome.gsk.Renderer) to ensure the shader will work for the renderer before using it.

Parameters:

shader - the GskGLShader

bounds - the rectangle to render the shader into

args - Arguments for the uniforms

children - array of child nodes, these will be rendered to textures and used as input.

Method Details

getType

public static Type getType()

Get the GType of the GLShaderNode class

Returns:

the GType

asParent

protected GLShaderNode asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class RenderNode

getArgs

@Deprecated
public Bytes getArgs()

Deprecated.

GTK's new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

Gets args for the node.

Returns:

A GBytes with the uniform arguments

getChild

@Deprecated
public RenderNode getChild(int idx)

Deprecated.

GTK's new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

Gets one of the children.

Parameters:

idx - the position of the child to get

Returns:

the idx'th child of this GLShaderNode

getNChildren

@Deprecated
public int getNChildren()

Deprecated.

GTK's new Vulkan-focused rendering does not support this feature. Use GtkGLArea for OpenGL rendering.

Returns the number of children

Returns:

The number of children

getShader

public GLShader getShader()

Gets shader code for the node.

Returns:

the GskGLShader shader