Struct gsk4::RenderNode

source ·
pub struct RenderNode { /* private fields */ }
Expand description

RenderNode is the basic block in a scene graph to be rendered using Renderer.

Each node has a parent, except the top-level node; each node may have children nodes.

Each node has an associated drawing surface, which has the size of the rectangle set when creating it.

Render nodes are meant to be transient; once they have been associated to a Renderer it’s safe to release any reference you have on them. All RenderNodes are immutable, you can only specify their properties during construction.

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

GLib type: Shared boxed type with reference counted clone semantics.

Implementations§

source§

impl RenderNode

source

pub fn as_ptr(&self) -> *mut GskRenderNode

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GskRenderNode) -> &Self

Borrows the underlying C value.

source§

impl RenderNode

source

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

source

pub fn draw(&self, cr: &Context)

Draw the contents of @self to the given cairo context.

Typically, you’ll use this function to implement fallback rendering of RenderNodes on an intermediate Cairo context, instead of using the drawing context associated to a gdk::Surface’s rendering buffer.

For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail.

§cr

cairo context to draw to

source

pub fn bounds(&self) -> Rect

Retrieves the boundaries of the @self.

The node will not draw outside of its boundaries.

§Returns
§bounds

return location for the boundaries

source

pub fn node_type(&self) -> RenderNodeType

Returns the type of the @self.

§Returns

the type of the RenderNode

source

pub fn opaque_rect(&self) -> Option<Rect>

Available on crate feature v4_16 only.

Gets an opaque rectangle inside the node that GTK can determine to be fully opaque.

There is no guarantee that this is indeed the largest opaque rectangle or that regions outside the rectangle are not opaque. This function is a best effort with that goal.

The rectangle will be fully contained in the bounds of the node.

§Returns

true if part or all of the rendernode is opaque, false if no opaque region could be found.

source

pub fn serialize(&self) -> Bytes

Serializes the @self for later deserialization via gsk_render_node_deserialize(). No guarantees are made about the format used other than that the same version of GTK will be able to deserialize the result of a call to gsk_render_node_serialize() and gsk_render_node_deserialize() will correctly reject files it cannot open that were created with previous versions of GTK.

The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format.

§Returns

a GBytes representing the node.

source

pub fn write_to_file(&self, filename: impl AsRef<Path>) -> Result<(), Error>

This function is equivalent to calling serialize() followed by file_set_contents().

See those two functions for details on the arguments.

It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection.

§filename

the file to save it to.

§Returns

true if saving was successful

source§

impl RenderNode

source

pub fn is<T: IsRenderNode>(&self) -> bool

source

pub fn type_(&self) -> Type

source

pub fn deserialize(bytes: &Bytes) -> Option<Self>

Loads data previously created via serialize().

For a discussion of the supported format, see that function.

§bytes

the bytes containing the data

§error_func

Callback on parsing errors

§Returns

a new RenderNode

source

pub fn deserialize_with_error_func<P: FnMut(&ParseLocation, &ParseLocation, &Error)>( bytes: &Bytes, error_func: P, ) -> Option<Self>

source

pub fn downcast<T: IsRenderNode>(self) -> Result<T, Self>

source

pub fn downcast_ref<T: IsRenderNode>(&self) -> Option<&T>

Trait Implementations§

source§

impl AsRef<RenderNode> for BlendNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for BlurNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for BorderNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for CairoNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for ClipNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for ColorMatrixNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for ColorNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for ConicGradientNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for ContainerNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for CrossFadeNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for DebugNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for FillNode

Available on crate feature v4_14 only.
source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for GLShaderNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for InsetShadowNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for LinearGradientNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for MaskNode

Available on crate feature v4_10 only.
source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for OpacityNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for OutsetShadowNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for RadialGradientNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for RepeatNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for RepeatingLinearGradientNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for RepeatingRadialGradientNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for RoundedClipNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for ShadowNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for StrokeNode

Available on crate feature v4_14 only.
source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for TextNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for TextureNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for TextureScaleNode

Available on crate feature v4_10 only.
source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RenderNode> for TransformNode

source§

fn as_ref(&self) -> &RenderNode

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for RenderNode

source§

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RenderNode

source§

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

Formats the value using the given formatter. Read more
source§

impl StaticType for RenderNode

source§

fn static_type() -> Type

Returns the type identifier of Self.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize, ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize, ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.