Struct tray_rust::film::color::Colorf

pub struct Colorf {
    pub r: f32,
    pub g: f32,
    pub b: f32,
    pub a: f32,
}

Colorf is a floating point RGBA color type a is typically used to store the weight of a color eg. in the render target for multisampling we need to track the weight to normalize in the end and is always initialized to 0

Fields

r: f32

g: f32

b: f32

a: f32

Methods

impl Colorf

pub fn new(r: f32, g: f32, b: f32) -> Colorf

Create an RGB color

pub fn with_alpha(r: f32, g: f32, b: f32, a: f32) -> Colorf

Create an RGB color

pub fn broadcast(r: f32) -> Colorf

Create an RGB color using the same value for all channels

pub fn black() -> Colorf

Create a black color

pub fn clamp(&self) -> Colorf

Clamp the color values between [0, 1]

pub fn luminance(&self) -> f32

Compute the luminance of the color

pub fn is_black(&self) -> bool

Check if the color is black

pub fn has_nans(&self) -> bool

Check if any of the color channels are NaN

pub fn has_infs(&self) -> bool

Check if any of the color channels are infinite

pub fn to_srgb(&self) -> Colorf

Convert the linear RGB color to sRGB

pub fn exp(&self) -> Colorf

Return the color with values { e^r, e^g, e^b }

Trait Implementations

impl Clone for Colorf

fn clone(&self) -> Colorf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Colorf

impl PartialEq<Colorf> for Colorf

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

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

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

This method tests for !=.

impl Debug for Colorf

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

Formats the value using the given formatter.

impl Div<Colorf> for Colorf

type Output = Colorf

The resulting type after applying the / operator.

fn div(self, rhs: Colorf) -> Colorf

Divide the channels of one color by another

impl Div<f32> for Colorf

type Output = Colorf

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Colorf

Divide the channels of the color by the float

impl Sub<Colorf> for Colorf

type Output = Colorf

The resulting type after applying the - operator.

fn sub(self, rhs: Colorf) -> Colorf

Subtract the two colors

impl Add<Colorf> for Colorf

type Output = Colorf

The resulting type after applying the + operator.

fn add(self, rhs: Colorf) -> Colorf

Add two colors together

impl Mul<Colorf> for Colorf

type Output = Colorf

The resulting type after applying the * operator.

fn mul(self, rhs: Colorf) -> Colorf

Multiply the two colors

impl Mul<f32> for Colorf

type Output = Colorf

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Colorf

Scale the color by the float

impl Mul<Colorf> for f32

type Output = Colorf

The resulting type after applying the * operator.

fn mul(self, rhs: Colorf) -> Colorf

Scale the color by the float

impl Neg for Colorf

type Output = Colorf

The resulting type after applying the - operator.

fn neg(self) -> Colorf

Negate the color channels

impl Index<usize> for Colorf

type Output = f32

The returned type after indexing.

fn index(&self, i: usize) -> &f32

Access the channels by index

• 0 = r
• 1 = g
• 2 = b
• 3 = a

impl IndexMut<usize> for Colorf

fn index_mut(&mut self, i: usize) -> &mut f32

Access the channels by index

• 0 = r
• 1 = g
• 2 = b
• 3 = a

impl StructuralPartialEq for Colorf