Struct gsk4::RadialGradientNode

pub struct RadialGradientNode(_);

A render node for a radial gradient.

Implementations

impl RadialGradientNode

pub fn new(
    bounds: &Rect,
    center: &Point,
    hradius: f32,
    vradius: f32,
    start: f32,
    end: f32,
    color_stops: &[ColorStop]
) -> Self

Creates a RenderNode that draws a radial gradient.

The radial gradient starts around center. The size of the gradient is dictated by hradius in horizontal orientation and by vradius in vertial orientation.

bounds

the bounds of the node

center

the center of the gradient

hradius

the horizontal radius

vradius

the vertical radius

start

a percentage >= 0 that defines the start of the gradient around center

end

a percentage >= 0 that defines the end of the gradient around center

color_stops

a pointer to an array of ColorStop defining the gradient. The offsets of all color stops must be increasing. The first stop’s offset must be >= 0 and the last stop’s offset must be <= 1.

Returns

A new RenderNode

pub fn center(&self) -> Point

Retrieves the center pointer for the gradient.

Returns

the center point for the gradient

pub fn color_stops(&self) -> Vec<ColorStop>

Retrieves the color stops in the gradient.

Returns

the color stops in the gradient

pub fn end(&self) -> f32

Retrieves the end value for the gradient.

Returns

the end value for the gradient

pub fn hradius(&self) -> f32

Retrieves the horizonal radius for the gradient.

Returns

the horizontal radius for the gradient

pub fn n_color_stops(&self) -> usize

Retrieves the number of color stops in the gradient.

Returns

the number of color stops

pub fn start(&self) -> f32

Retrieves the start value for the gradient.

Returns

the start value for the gradient

pub fn vradius(&self) -> f32

Retrieves the vertical radius for the gradient.

Returns

the vertical radius for the gradient

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 RadialGradientNode

fn as_ref(&self) -> &RenderNode

Performs the conversion.

impl Clone for RadialGradientNode

fn clone(&self) -> RadialGradientNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RadialGradientNode

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

Formats the value using the given formatter.

impl Deref for RadialGradientNode

type Target = RenderNode

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for RadialGradientNode

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

Formats the value using the given formatter.

impl Hash for RadialGradientNode

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 RadialGradientNode

const NODE_TYPE: RenderNodeType

fn upcast(self) -> RenderNode

fn upcast_ref(&self) -> &RenderNode

impl Ord for RadialGradientNode

fn cmp(&self, other: &RadialGradientNode) -> 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<RadialGradientNode> for RadialGradientNode

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

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

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

This method tests for !=.

impl PartialOrd<RadialGradientNode> for RadialGradientNode

fn partial_cmp(&self, other: &RadialGradientNode) -> 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 RadialGradientNode

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for RadialGradientNode

impl StructuralEq for RadialGradientNode

impl StructuralPartialEq for RadialGradientNode