Struct cat_engine_basement::graphics::core::blending::Blending

pub struct Blending { /* fields omitted */ }

A wrapper for blending functions.

Blending is disabled by default.

The default blending constant colour is [0f32;4].

The default blending functions for Source are BlendingFunction::One.

The default blending functions for Destination are BlendingFunction::Zero.

The default blending equations are BlendingEquation::Addition.

Implementations

impl Blending

pub const fn new() -> Blending

pub fn load(&mut self, library: &OpenGraphicsLibrary)

impl Blending

pub fn enable(&self)

Enables blending.

pub fn disable(&self)

Disables blending.

pub fn is_enabled(&self) -> bool

Checks whether blending is enabled.

impl Blending

pub fn set_blending_colour(&self, [red, greed, blue, alpha]: Colour)

Sets the blending constant colour.

pub fn get_blending_colour(&self) -> Colour

Returns the blending constant colour.

pub fn write_blending_colour(&self, colour: &mut Colour)

Writes the blending constant colour to colour.

impl Blending

pub fn set_function(
    &self,
    sourse_factor: BlendingFunction,
    destination_factor: BlendingFunction
)

Sets the blending functions.

pub fn set_function_separate(
    &self,
    sourse_factor_rgb: BlendingFunction,
    destination_factor_rgb: BlendingFunction,
    sourse_factor_alpha: BlendingFunction,
    destination_factor_alpha: BlendingFunction
)

Sets the blending functions for the RBG and Alpha colour components separately.

pub fn get_function_src_rgb(&self) -> BlendingFunction

Returns the source blending function for the RBG colour components.

pub fn write_function_src_rgb(&self, function: &mut BlendingFunction)

Writes the source blending function for the RBG colour components to function.

pub fn get_function_src_alpha(&self) -> BlendingFunction

Returns the source blending function for the Alpha colour component.

pub fn write_function_src_alpha(&self, function: &mut BlendingFunction)

Writes the souse blending function for the Alpha colour component to the function.

pub fn get_function_dst_rgb(&self) -> BlendingFunction

Returns the destination blending function for the RBG colour components.

pub fn write_function_dst_rgb(&self, function: &mut BlendingFunction)

Writes the destination blending function for the RBG colour components to function.

pub fn get_function_dst_alpha(&self) -> BlendingFunction

Returns the destination blending function for the Alpha colour component.

pub fn write_function_dst_alpha(&self, function: &mut BlendingFunction)

Writes the blending function for the Alpha colour component to function.

impl Blending

pub fn set_equation(&self, equation: BlendingEquation)

Sets the equation used for both the RGB blending equation and the Alpha blend equation.

pub fn set_equation_separate(
    &self,
    equation_rgb: BlendingEquation,
    equation_alpha: BlendingEquation
)

Sets the equation for the RGB blending equation and the Alpha blend equation sepatately.

pub fn get_equation_rbg(&self) -> BlendingEquation

Returns the RGB blending equation.

pub fn write_equation_rbg(&self, equation: &mut BlendingEquation)

Writes the RGB blending equation to equation.

pub fn get_equation_alpha(&self) -> BlendingEquation

Returns the Alpha blending equation.

pub fn write_equation_alpha(&self, equation: &mut BlendingEquation)

Writes the Alpha blending equation to equation.