:right-sidebar: True

GraphicsOffload
===================================================================

.. currentmodule:: gi.repository.Gtk


.. versionadded:: 4.14




.. class:: GraphicsOffload(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gdk.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 :obj:`~gi.repository.Gdk.Display.get_dmabuf_formats`)

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



Constructors
------------

.. rst-class:: interim-class

.. class:: GraphicsOffload
   :no-index:


   .. classmethod:: new(child: ~gi.repository.Gtk.Widget | None = None) -> ~gi.repository.Gtk.Widget

      Creates a new GtkGraphicsOffload widget.



      .. versionadded:: 4.14





      :param child: the child widget









Methods
-------

.. rst-class:: interim-class

.. class:: GraphicsOffload
   :no-index:


   .. method:: get_child() -> ~gi.repository.Gtk.Widget | None

      Gets the child of ``self``.



      .. versionadded:: 4.14








   .. method:: get_enabled() -> ~gi.repository.Gtk.GraphicsOffloadEnabled

      Returns whether offload is enabled for ``self``.



      .. versionadded:: 4.14








   .. method:: set_child(child: ~gi.repository.Gtk.Widget | None = None) -> None

      Sets the child of ``self``.



      .. versionadded:: 4.14





      :param child: the child widget





   .. method:: set_enabled(enabled: ~gi.repository.Gtk.GraphicsOffloadEnabled) -> None

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



      .. versionadded:: 4.14





      :param enabled: whether to enable offload









Properties
----------

.. rst-class:: interim-class

.. class:: GraphicsOffload
   :no-index:
   

   .. attribute:: props.child
      :type: ~gi.repository.Gtk.Widget

      The child widget.



      .. versionadded:: 4.14





   .. attribute:: props.enabled
      :type: ~gi.repository.Gtk.GraphicsOffloadEnabled

      Whether graphics offload is enabled.



      .. versionadded:: 4.14