Package org.gnome.gtk

Class GraphicsOffload

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.GraphicsOffload

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

@Generated("io.github.jwharm.JavaGI")
public class GraphicsOffload
extends Widget
implements Accessible, Buildable, ConstraintTarget

A widget that allows to bypass gsk rendering for its child by passing the content directly to the compositor.

Graphics offload is an optimization to reduce overhead and battery use that is most useful for video content. It only works on some platforms and in certain situations. GTK will automatically fall back to normal rendering if it doesn't.

Graphics offload is most efficient if there are no controls drawn on top of the video content.

You should consider using graphics offload for your main widget if it shows frequently changing content (such as a video, or a VM display) and you provide the content in the form of dmabuf textures (see DmabufTextureBuilder), in particular if it may be fullscreen.

Numerous factors can prohibit graphics offload:

• Unsupported platforms. Currently, graphics offload only works on Linux with Wayland.

• Clipping, such as rounded corners that cause the video content to not be rectangular

• Unsupported dmabuf formats (see Display.getDmabufFormats())

• Translucent video content (content with an alpha channel, even if it isn't used)

• Transforms that are more complex than translations and scales

• Filters such as opacity, grayscale or similar

To investigate problems related graphics offload, GTK offers debug flags to print out information about graphics offload and dmabuf use:

GDK_DEBUG=offload GDK_DEBUG=dmabuf

The GTK inspector provides a visual debugging tool for graphics offload.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphicsOffload.Builder<B extends GraphicsOffload.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	GraphicsOffload.GraphicsOffloadClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
GraphicsOffload()	Calls GraphicsOffload(org.gnome.gtk.Widget) with child = null
GraphicsOffload(MemorySegment address)	Create a GraphicsOffload proxy instance for the provided memory address.
GraphicsOffload(@Nullable Widget child)	Creates a new GtkGraphicsOffload widget.

Method Summary

Modifier and Type	Method	Description
protected GraphicsOffload	asParent()	Returns this instance as if it were its parent type.
static GraphicsOffload.Builder<? extends GraphicsOffload.Builder>	builder()	A GraphicsOffload.Builder object constructs a GraphicsOffload with the specified properties.
boolean	getBlackBackground()	Returns whether the widget draws a black background.
Widget	getChild()	Gets the child of this GraphicsOffload.
GraphicsOffloadEnabled	getEnabled()	Returns whether offload is enabled for this GraphicsOffload.
static Type	getType()	Get the GType of the GraphicsOffload class
void	setBlackBackground(boolean value)	Sets whether this GtkGraphicsOffload widget will draw a black background.
void	setChild(@Nullable Widget child)	Sets the child of this GraphicsOffload.
void	setEnabled(GraphicsOffloadEnabled enabled)	Sets whether this GtkGraphicsOffload widget will attempt to offload the content of its child widget.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

GraphicsOffload

public GraphicsOffload(MemorySegment address)

Create a GraphicsOffload proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

GraphicsOffload

public GraphicsOffload(@Nullable
 @Nullable Widget child)

Creates a new GtkGraphicsOffload widget.

Parameters:

child - the child widget

GraphicsOffload

public GraphicsOffload()

Calls GraphicsOffload(org.gnome.gtk.Widget) with child = null

Method Details

getType

public static Type getType()

Get the GType of the GraphicsOffload class

Returns:

the GType

asParent

protected GraphicsOffload 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 Widget

getBlackBackground

public boolean getBlackBackground()

Returns whether the widget draws a black background.

See setBlackBackground(boolean).

Returns:

TRUE if black background is drawn

getChild

public Widget getChild()

Gets the child of this GraphicsOffload.

Returns:

the child widget

getEnabled

public GraphicsOffloadEnabled getEnabled()

Returns whether offload is enabled for this GraphicsOffload.

Returns:

whether offload is enabled

setBlackBackground

public void setBlackBackground(boolean value)

Sets whether this GtkGraphicsOffload widget will draw a black background.

A main use case for this is _letterboxing_ where black bars are visible next to the content if the aspect ratio of the content does not match the dimensions of the monitor.

Using this property for letterboxing instead of CSS allows compositors to show content with maximum efficiency, using direct scanout to avoid extra copies in the compositor.

On Wayland, this is implemented using the single-pixel buffer protocol.

Parameters:

value - whether to draw a black background behind the content

setChild

public void setChild(@Nullable
 @Nullable Widget child)

Sets the child of this GraphicsOffload.

Parameters:

child - the child widget

setEnabled

public void setEnabled(GraphicsOffloadEnabled enabled)

Sets whether this GtkGraphicsOffload widget will attempt to offload the content of its child widget.

Parameters:

enabled - whether to enable offload

builder

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

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