Package org.gnome.gsk

Class Renderer

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gsk.Renderer

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

BroadwayRenderer, CairoRenderer, GLRenderer, NglRenderer, Renderer.RendererImpl, VulkanRenderer

@Generated("io.github.jwharm.JavaGI")
public abstract class Renderer
extends GObject

GskRenderer is a class that renders a scene graph defined via a tree of RenderNode instances.

Typically you will use a GskRenderer instance to repeatedly call render(org.gnome.gsk.RenderNode, org.freedesktop.cairo.Region) to update the contents of its associated Surface.

It is necessary to realize a GskRenderer instance using realize(org.gnome.gdk.Surface) before calling render(org.gnome.gsk.RenderNode, org.freedesktop.cairo.Region), in order to create the appropriate windowing system resources needed to render the scene.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Renderer.Builder<B extends Renderer.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Renderer.RendererClass
static class	Renderer.RendererImpl	The RendererImpl type represents a native instance of the abstract Renderer class.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Renderer	asParent()	Returns this instance as if it were its parent type.
static Renderer.Builder<? extends Renderer.Builder>	builder()	A Renderer.Builder object constructs a Renderer with the specified properties.
static Renderer	forSurface(Surface surface)	Creates an appropriate GskRenderer instance for the given surface.
Surface	getSurface()	Retrieves the GdkSurface set using gsk_enderer_realize().
static Type	getType()	Get the GType of the Renderer class
boolean	isRealized()	Checks whether the this Renderer is realized or not.
boolean	realize(@Nullable Surface surface)	Creates the resources needed by the this Renderer to render the scene graph.
boolean	realizeForDisplay(Display display)	Creates the resources needed by the this Renderer to render the scene graph.
void	render(RenderNode root, @Nullable org.freedesktop.cairo.Region region)	Renders the scene graph, described by a tree of GskRenderNode instances to the renderer's surface, ensuring that the given region gets redrawn.
Texture	renderTexture(RenderNode root, @Nullable Rect viewport)	Renders the scene graph, described by a tree of GskRenderNode instances, to a GdkTexture.
void	unrealize()	Releases all the resources created by gsk_renderer_realize().

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, 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

Renderer

public Renderer(MemorySegment address)

Create a Renderer 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 Renderer class

Returns:

the GType

asParent

protected Renderer 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 GObject

forSurface

public static Renderer forSurface(Surface surface)

Creates an appropriate GskRenderer instance for the given surface.

If the GSK_RENDERER environment variable is set, GSK will try that renderer first, before trying the backend-specific default. The ultimate fallback is the cairo renderer.

The renderer will be realized before it is returned.

Parameters:

surface - a GdkSurface

Returns:

a GskRenderer

getSurface

public Surface getSurface()

Retrieves the GdkSurface set using gsk_enderer_realize().

If the renderer has not been realized yet, null will be returned.

Returns:

a GdkSurface

isRealized

public boolean isRealized()

Checks whether the this Renderer is realized or not.

Returns:

true if the GskRenderer was realized, and false otherwise

realize

public boolean realize(@Nullable
 @Nullable Surface surface)
                throws GErrorException

Creates the resources needed by the this Renderer to render the scene graph.

Since GTK 4.6, the surface may be NULL, which allows using renderers without having to create a surface. Since GTK 4.14, it is recommended to use realizeForDisplay(org.gnome.gdk.Display) instead.

Note that it is mandatory to call unrealize() before destroying the renderer.

Parameters:

surface - the GdkSurface renderer will be used on

Returns:

Whether the renderer was successfully realized

Throws:

GErrorException - see GError

realizeForDisplay

public boolean realizeForDisplay(Display display)
                          throws GErrorException

Creates the resources needed by the this Renderer to render the scene graph.

Note that it is mandatory to call unrealize() before destroying the renderer.

Parameters:

display - the GdkDisplay renderer will be used on

Returns:

Whether the renderer was successfully realized

Throws:

GErrorException - see GError

render

public void render(RenderNode root,
 @Nullable
 @Nullable org.freedesktop.cairo.Region region)

Renders the scene graph, described by a tree of GskRenderNode instances to the renderer's surface, ensuring that the given region gets redrawn.

If the renderer has no associated surface, this function does nothing.

Renderers must ensure that changes of the contents given by the root node as well as the area given by region are redrawn. They are however free to not redraw any pixel outside of region if they can guarantee that it didn't change.

The this Renderer will acquire a reference on the GskRenderNode tree while the rendering is in progress.

Parameters:

root - a GskRenderNode

region - the cairo_region_t that must be redrawn or null for the whole window

renderTexture

public Texture renderTexture(RenderNode root,
 @Nullable
 @Nullable Rect viewport)

Renders the scene graph, described by a tree of GskRenderNode instances, to a GdkTexture.

The this Renderer will acquire a reference on the GskRenderNode tree while the rendering is in progress.

If you want to apply any transformations to root, you should put it into a transform node and pass that node instead.

Parameters:

root - a GskRenderNode

viewport - the section to draw or null to use root's bounds

Returns:

a GdkTexture with the rendered contents of root.

unrealize

public void unrealize()

Releases all the resources created by gsk_renderer_realize().

builder

public static Renderer.Builder<? extends Renderer.Builder> builder()

A Renderer.Builder object constructs a Renderer with the specified properties. Use the various set...() methods to set properties, and finish construction with Renderer.Builder.build().