Struct sfml::graphics::Color

#[repr(C)]
pub struct Color {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: u8,
}

Utility type for manpulating RGBA colors

Color is a simple color type composed of 4 components: Red, Green, Blue, Alpha

Example

There are 3 basic ways to construct a color

use sfml::graphics::Color;
let color1 = Color::rgb(255, 0, 0); // from red/green/blue values
let color2 = Color::rgba(255, 255, 255, 128); // from red/green/blue/alpha (transparency)
let color3 = Color::GREEN; // from one of the associated color constants

Fields

r: u8

Red component

g: u8

Green component

b: u8

Blue component

a: u8

Alpha component (transparency)

Implementations

impl Color

pub const fn rgb(red: u8, green: u8, blue: u8) -> Self

Construct a color from its 3 RGB components

Arguments

• red - Red component (0 .. 255)
• green - -Green component (0 .. 255)
• blue - Blue component (0 .. 255)

Return Color object constructed from the components

pub const fn rgba(red: u8, green: u8, blue: u8, alpha: u8) -> Self

Construct a color from its 4 RGBA components

Arguments

• red - Red component (0 .. 255)
• green - -Green component (0 .. 255)
• blue - Blue component (0 .. 255)
• alpha - Alpha component (0 .. 255)

Return Color object constructed from the components

pub const BLACK: Self = _

Black predefined color

pub const WHITE: Self = _

White predefined color

pub const RED: Self = _

Red predefined color

pub const GREEN: Self = _

Green predefined color

pub const BLUE: Self = _

Blue predefined color

pub const YELLOW: Self = _

Yellow predefined color

pub const MAGENTA: Self = _

Magenta predefined color

pub const CYAN: Self = _

Cyan predifined color

pub const TRANSPARENT: Self = _

Tranparent predefined color

Trait Implementations

impl Add<Color> for Color

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

Calculate the component-wise saturated addition of two colors.

type Output = Color

The resulting type after applying the + operator.

impl AddAssign<Color> for Color

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the “default value” for a type.

impl From<Color> for IVec4

fn from(src: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Vec4

fn from(src: Color) -> Self

Converts to this type from the input type.

impl From<Color> for u32

fn from(src: Color) -> Self

Converts to this type from the input type.

impl From<u32> for Color

fn from(src: u32) -> Self

Construct the color from 32-bit unsigned integer.

The number should contain the components in RGBA order.

impl Mul<Color> for Color

fn mul(self, other: Color) -> Color

Calculate the component-wise modulated multiplication of two colors.

For each X in rgba, result.X = a.X * b.X / 255.

type Output = Color

The resulting type after applying the * operator.

impl MulAssign<Color> for Color

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq<Color> for Color

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

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

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.

impl Sub<Color> for Color

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

Component-wise subtraction of two colors. Components below 0 are clamped to 0.

type Output = Color

The resulting type after applying the - operator.

impl SubAssign<Color> for Color

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Color

impl Eq for Color

impl StructuralEq for Color

impl StructuralPartialEq for Color