Renderer

abstract class Renderer(val gskRendererPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

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

Typically you will use a GskRenderer instance to repeatedly call method@Gsk.Renderer.render to update the contents of its associated class@Gdk.Surface.

It is necessary to realize a GskRenderer instance using method@Gsk.Renderer.realize before calling method@Gsk.Renderer.render, in order to create the appropriate windowing system resources needed to render the scene.

Skipped during bindings generation

  • method realized: Property has no getter nor setter

Inheritors

Constructors

Link copied to clipboard
constructor(surface: <Error class: unknown class>)

Creates an appropriate GskRenderer instance for the given @surface.

constructor(gskRendererPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class RendererImpl(pointer: <Error class: unknown class><<Error class: unknown class>>) : Renderer

The RendererImpl type represents a native instance of the abstract Renderer class.

Properties

Link copied to clipboard
val gskRendererPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open val surface: <Error class: unknown class>?

The surface associated with renderer.

Functions

Link copied to clipboard
open fun isRealized(): Boolean

Checks whether the @renderer is realized or not.

Link copied to clipboard
open fun realize(surface: <Error class: unknown class>? = null): <Error class: unknown class><Boolean>

Creates the resources needed by the @renderer to render the scene graph.

Link copied to clipboard
open fun realizeForDisplay(display: <Error class: unknown class>): <Error class: unknown class><Boolean>

Creates the resources needed by the @renderer to render the scene graph.

Link copied to clipboard
open fun render(root: RenderNode, region: <Error class: unknown class>? = null)

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

Link copied to clipboard
open fun renderTexture(root: RenderNode, viewport: <Error class: unknown class>? = null): <Error class: unknown class>

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

Link copied to clipboard
open fun unrealize()

Releases all the resources created by gsk_renderer_realize().