Struct gsk4::ShadowNode

pub struct ShadowNode(_);

A render node drawing one or more shadows behind its single child node.

Implementations

impl ShadowNode

pub fn new<P: AsRef<RenderNode>>(child: &P, shadows: &[Shadow]) -> Self

Creates a RenderNode that will draw a child with the given shadows below it.

child

The node to draw

shadows

The shadows to apply

Returns

A new RenderNode

pub fn shadow(&self, i: usize) -> Option<Shadow>

Retrieves the shadow data at the given index i.

i

the given index

Returns

the shadow data

pub fn child(&self) -> RenderNode

Retrieves the child RenderNode of the shadow self.

Returns

the child render node

pub fn n_shadows(&self) -> usize

Retrieves the number of shadows in the self.

Returns

the number of shadows.

Methods from Deref<Target = RenderNode>

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

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

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

pub fn node_type(&self) -> RenderNodeType

Returns the type of the self.

Returns

the type of the RenderNode

pub fn serialize(&self) -> Bytes

Serializes the self for later deserialization via 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 serialize() and 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.

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

This function is equivalent to calling serialize() followed by g_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

Trait Implementations

impl AsRef<RenderNode> for ShadowNode

fn as_ref(&self) -> &RenderNode

Performs the conversion.

impl Clone for ShadowNode

fn clone(&self) -> ShadowNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShadowNode

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

Formats the value using the given formatter.

impl Deref for ShadowNode

type Target = RenderNode

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ShadowNode

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

Formats the value using the given formatter.

impl Hash for ShadowNode

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IsRenderNode for ShadowNode

const NODE_TYPE: RenderNodeType

fn upcast(self) -> RenderNode

fn upcast_ref(&self) -> &RenderNode

impl Ord for ShadowNode

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ShadowNode> for ShadowNode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ShadowNode> for ShadowNode

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for ShadowNode

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShadowNode

impl StructuralEq for ShadowNode

impl StructuralPartialEq for ShadowNode