Struct Renderer

pub struct Renderer { /* private fields */ }

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

Typically you will use a Renderer instance to repeatedly call GskRendererExt::render() to update the contents of its associated gdk::Surface.

It is necessary to realize a Renderer instance using GskRendererExt::realize() before calling GskRendererExt::render(), in order to create the appropriate windowing system resources needed to render the scene.

This is an Abstract Base Class, you cannot instantiate it.

Properties

realized

Whether the renderer has been associated with a surface or draw context.

Readable

surface

The surface associated with renderer.

Readable

Implements

GskRendererExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl Renderer

pub const NONE: Option<&'static Renderer> = None

pub fn for_surface(surface: &Surface) -> Option<Renderer>

Creates an appropriate Renderer 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.

surface

a surface

Returns

the realized renderer

Trait Implementations

impl Clone for Renderer

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Renderer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Renderer

type ParamSpec = ParamSpecObject

type SetValue = Renderer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Renderer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Renderer

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Renderer

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Renderer

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Renderer

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Renderer

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Renderer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Renderer

impl IsA<Renderer> for BroadwayRenderer

Available on crate feature broadway only.

impl IsA<Renderer> for CairoRenderer

impl IsA<Renderer> for GLRenderer

Available on crate feature v4_2 only.

impl IsA<Renderer> for NglRenderer

Available on crate feature v4_2 only.

impl IsA<Renderer> for VulkanRenderer

Available on crate feature vulkan only.