Struct RadialGradient 

pub struct RadialGradient {
    pub spread: Spread,
    /* private fields */
}

A data structure to represent a radial gradient.

Fields

spread: Spread

The gradient Spread

Implementations

impl RadialGradient

pub fn new( colors: ColorGradient, center: LayerOffset, radius: f32, focal_point: Option<LayerOffset>, focal_radius: Option<f32>, spread: Option<Spread>, ) -> RadialGradient

Creates a radial gradient from colors, center, radius, and optional focal settings.

Focal values are clamped to remain within the outer gradient circle.

pub fn get_center(&self) -> LayerOffset

The center (Offset) of the gradient (relative to the Layer.offset).

pub fn set_center(&mut self, val: LayerOffset)

Sets the gradient center.

Updating the center resets the focal point and focal radius to the new origin.

pub fn get_radius(&self) -> f32

The radius of the gradient.

pub fn set_radius(&mut self, val: f32)

Sets the gradient radius.

pub fn get_focal_point(&self) -> LayerOffset

The focal point (Offset) of the gradient (relative to the Layer.offset).

pub fn set_focal_point(&mut self, val: LayerOffset)

Sets the focal point used to bias the radial gradient.

pub fn get_focal_radius(&self) -> f32

Returns the focal radius.

pub fn set_focal_radius(&mut self, val: f32)

Sets the focal radius.

The value is clamped to remain within the outer gradient circle.

pub fn get_color_at(&self, x: u32, y: u32) -> SolidColor

A helper function for renderers to get the color at a certain point.

The given x and y values are the coordinate of the pixel in the Layer (relative to Layer::offset).

Trait Implementations

impl Clone for RadialGradient

fn clone(&self) -> RadialGradient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RadialGradient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RadialGradient

fn deserialize<__D>( __deserializer: __D, ) -> Result<RadialGradient, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RadialGradient> for ColorKind

fn from(val: RadialGradient) -> ColorKind

Converts to this type from the input type.

impl Serialize for RadialGradient

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.