Package org.gnome.gsk

Class RenderNode

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gsk.RenderNode

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

BlendNode, BlurNode, BorderNode, CairoNode, ClipNode, ColorMatrixNode, ColorNode, ConicGradientNode, ContainerNode, CrossFadeNode, DebugNode, FillNode, GLShaderNode, InsetShadowNode, LinearGradientNode, MaskNode, OpacityNode, OutsetShadowNode, RadialGradientNode, RenderNode.RenderNodeImpl, RepeatingLinearGradientNode, RepeatingRadialGradientNode, RepeatNode, RoundedClipNode, ShadowNode, StrokeNode, SubsurfaceNode, TextNode, TextureNode, TextureScaleNode, TransformNode

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

GskRenderNode is the basic block in a scene graph to be rendered using Renderer.

Each node has a parent, except the top-level node; each node may have children nodes.

Each node has an associated drawing surface, which has the size of the rectangle set when creating it.

Render nodes are meant to be transient; once they have been associated to a Renderer it's safe to release any reference you have on them. All RenderNodes are immutable, you can only specify their properties during construction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderNode.RenderNodeImpl	The RenderNodeImpl type represents a native instance of the abstract RenderNode class.

Constructor Summary

Constructors

Constructor	Description
RenderNode(MemorySegment address)	Create a RenderNode proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected RenderNode	asParent()	Returns this instance as if it were its parent type.
static RenderNode	deserialize(Bytes bytes, @Nullable ParseErrorFunc errorFunc)	Loads data previously created via serialize().
void	draw(org.freedesktop.cairo.Context cr)	Draw the contents of this RenderNode to the given cairo context.
void	getBounds(Rect bounds)	Retrieves the boundaries of the this RenderNode.
RenderNodeType	getNodeType()	Returns the type of the this RenderNode.
boolean	getOpaqueRect(Rect outOpaque)	Gets an opaque rectangle inside the node that GTK can determine to be fully opaque.
static Type	getType()	Get the GType of the RenderNode class
RenderNode	ref()	Acquires a reference on the given GskRenderNode.
Bytes	serialize()	Serializes the this RenderNode for later deserialization via gsk_render_node_deserialize().
void	unref()	Releases a reference on the given GskRenderNode.
boolean	writeToFile(String filename)	This function is equivalent to calling serialize() followed by GLib.fileSetContents(java.lang.String, byte[]).

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

RenderNode

public RenderNode(MemorySegment address)

Create a RenderNode proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the RenderNode class

Returns:

the GType

asParent

protected RenderNode 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.

deserialize

public static RenderNode deserialize(Bytes bytes,
 @Nullable
 @Nullable ParseErrorFunc errorFunc)

Loads data previously created via serialize().

For a discussion of the supported format, see that function.

Parameters:

bytes - the bytes containing the data

errorFunc - Callback on parsing errors

Returns:

a new GskRenderNode

draw

public void draw(org.freedesktop.cairo.Context cr)

Draw the contents of this RenderNode to the given cairo context.

Typically, you'll use this function to implement fallback rendering of GskRenderNodes on an intermediate Cairo context, instead of using the drawing context associated to a Surface's rendering buffer.

For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail.

Parameters:

cr - cairo context to draw to

getBounds

public void getBounds(Rect bounds)

Retrieves the boundaries of the this RenderNode.

The node will not draw outside of its boundaries.

Parameters:

bounds - return location for the boundaries

getNodeType

public RenderNodeType getNodeType()

Returns the type of the this RenderNode.

Returns:

the type of the GskRenderNode

getOpaqueRect

public boolean getOpaqueRect(Rect outOpaque)

Gets an opaque rectangle inside the node that GTK can determine to be fully opaque.

There is no guarantee that this is indeed the largest opaque rectangle or that regions outside the rectangle are not opaque. This function is a best effort with that goal.

The rectangle will be fully contained in the bounds of the node.

Parameters:

outOpaque - return location for the opaque rect

Returns:

true if part or all of the rendernode is opaque, false if no opaque region could be found.

ref

public RenderNode ref()

Acquires a reference on the given GskRenderNode.

Returns:

the GskRenderNode with an additional reference

serialize

public Bytes serialize()

Serializes the this RenderNode for later deserialization via gsk_render_node_deserialize(). No guarantees are made about the format used other than that the same version of GTK will be able to deserialize the result of a call to gsk_render_node_serialize() and gsk_render_node_deserialize() will correctly reject files it cannot open that were created with previous versions of GTK.

The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format.

Returns:

a GBytes representing the node.

unref

public void unref()

Releases a reference on the given GskRenderNode.

If the reference was the last, the resources associated to the this RenderNode are freed.

writeToFile

public boolean writeToFile(String filename)
                    throws GErrorException

This function is equivalent to calling serialize() followed by GLib.fileSetContents(java.lang.String, byte[]).

See those two functions for details on the arguments.

It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection.

Parameters:

filename - the file to save it to.

Returns:

true if saving was successful

Throws:

GErrorException - see GError