Struct tiny_skia::Color

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

An RGBA color value, holding four floating point components.

Guarantees

  • All values are in 0..=1 range.

Implementations§

source§

impl Color

source

pub const TRANSPARENT: Color = _

A transparent color.

source

pub const BLACK: Color = _

A black color.

source

pub const WHITE: Color = _

A white color.

source

pub fn from_rgba(r: f32, g: f32, b: f32, a: f32) -> Option<Self>

Creates a new color from 4 components.

All values must be in 0..=1 range.

source

pub fn from_rgba8(r: u8, g: u8, b: u8, a: u8) -> Self

Creates a new color from 4 components.

u8 will be divided by 255 to get the float component.

Examples found in repository?
examples/linear_gradient.rs (line 9)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
fn main() {
    let mut paint = Paint::default();
    paint.shader = LinearGradient::new(
        Point::from_xy(100.0, 100.0),
        Point::from_xy(900.0, 900.0),
        vec![
            GradientStop::new(0.0, Color::from_rgba8(50, 127, 150, 200)),
            GradientStop::new(1.0, Color::from_rgba8(220, 140, 75, 180)),
        ],
        SpreadMode::Pad,
        Transform::identity(),
    )
    .unwrap();

    let mut pb = PathBuilder::new();
    pb.move_to(60.0, 60.0);
    pb.line_to(160.0, 940.0);
    pb.cubic_to(380.0, 840.0, 660.0, 800.0, 940.0, 800.0);
    pb.cubic_to(740.0, 460.0, 440.0, 160.0, 60.0, 60.0);
    pb.close();
    let path = pb.finish().unwrap();

    let mut pixmap = Pixmap::new(1000, 1000).unwrap();
    pixmap.fill_path(
        &path,
        &paint,
        FillRule::Winding,
        Transform::identity(),
        None,
    );
    pixmap.save_png("image.png").unwrap();
}
source

pub fn red(&self) -> f32

Returns color’s red component.

The value is guarantee to be in a 0..=1 range.

source

pub fn green(&self) -> f32

Returns color’s green component.

The value is guarantee to be in a 0..=1 range.

source

pub fn blue(&self) -> f32

Returns color’s blue component.

The value is guarantee to be in a 0..=1 range.

source

pub fn alpha(&self) -> f32

Returns color’s alpha component.

The value is guarantee to be in a 0..=1 range.

source

pub fn set_red(&mut self, c: f32)

Sets the red component value.

The new value will be clipped to the 0..=1 range.

source

pub fn set_green(&mut self, c: f32)

Sets the green component value.

The new value will be clipped to the 0..=1 range.

source

pub fn set_blue(&mut self, c: f32)

Sets the blue component value.

The new value will be clipped to the 0..=1 range.

source

pub fn set_alpha(&mut self, c: f32)

Sets the alpha component value.

The new value will be clipped to the 0..=1 range.

source

pub fn apply_opacity(&mut self, opacity: f32)

Shifts color’s opacity.

Essentially, multiplies color’s alpha by opacity.

opacity will be clamped to the 0..=1 range first. The final alpha will also be clamped.

source

pub fn is_opaque(&self) -> bool

Check that color is opaque.

Alpha == 1.0

source

pub fn premultiply(&self) -> PremultipliedColor

Converts into a premultiplied color.

source

pub fn to_color_u8(&self) -> ColorU8

Converts into ColorU8.

Trait Implementations§

source§

impl Clone for Color

source§

fn clone(&self) -> Color

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Color

source§

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

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

impl PartialEq<Color> for Color

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Color

source§

impl StructuralPartialEq for Color

Auto Trait Implementations§

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnwindSafe for Color

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere 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, U> TryFrom<U> for Twhere 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 Twhere 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.