bpf::math::Color class
#include <Base/include/Framework/Math/Color.hpp>

Contents

Represents a color

Public static variables

static const Color Red
static const Color Green
static const Color Blue
static const Color White
static const Color Black
static const Color Yellow
static const Color Cyan

Constructors, destructors, conversion operators

Color()
Color(const uint8 r, const uint8 g, const uint8 b, const uint8 a = 255)
Color(const Color& other, const uint8 a)
Color(const uint8 grey) explicit
Color(fint rgb) explicit

Public functions

auto Pack() const -> fint noexcept
auto operator+(const Color& other) const -> Color
auto operator*(const Color& other) const -> Color
auto operator==(const Color& other) const -> bool
auto operator!=(const Color& other) const -> bool
auto Normalize() const -> Vector3f noexcept
auto NormalizeAlpha() const -> Vector4f noexcept

Public variables

uint8 R
uint8 G
uint8 B
uint8 A

Function documentation

bpf::math::Color::Color()

Constructs a Black Color

bpf::math::Color::Color(const uint8 r, const uint8 g, const uint8 b, const uint8 a = 255)

Parameters
r the red component
g the green component
b the blue component
a the alpha component

Constructs a Color from individual RGBA components

bpf::math::Color::Color(const Color& other, const uint8 a)

Parameters
other the other Color to copy RGB components from
a the new alpha value

Constructs a Color

bpf::math::Color::Color(const uint8 grey) explicit

Parameters
grey the grey scale value

Constructs a grey scale Color

bpf::math::Color::Color(fint rgb) explicit

Parameters
rgb the packed rgb integer

Constructs a Color from a packed rgb int

fint bpf::math::Color::Pack() const noexcept

Returns the packed color as integer

Pack this color into a single integer

Color bpf::math::Color::operator+(const Color& other) const

Parameters
other the color to blend with
Returns new Color

Blends two colors by addition

Color bpf::math::Color::operator*(const Color& other) const

Parameters
other the color to blend with
Returns new Color

Blends two colors by multiplication

bool bpf::math::Color::operator==(const Color& other) const

Parameters
other the color to compare with
Returns true if the two colors are equal, false otherwise

Compare two colors

bool bpf::math::Color::operator!=(const Color& other) const

Parameters
other the color to compare with
Returns false if the two colors are equal, true otherwise

Compare two colors

Vector3f bpf::math::Color::Normalize() const noexcept

Returns normalized RGB color as an order 3 float vector

Normalizes this color taking only R, G and B channels

Vector4f bpf::math::Color::NormalizeAlpha() const noexcept

Returns normalized RGBA color as an order 4 float vector

Normalizes this color taking all channels (supports alpha)

Variable documentation

static const Color bpf::math::Color::Red

The Red color

static const Color bpf::math::Color::Green

The Green color

static const Color bpf::math::Color::Blue

The Blue color

static const Color bpf::math::Color::White

The White color

static const Color bpf::math::Color::Black

The Black color

static const Color bpf::math::Color::Yellow

The Yellow color

static const Color bpf::math::Color::Cyan

The Cyan color

uint8 bpf::math::Color::R

R component

uint8 bpf::math::Color::G

G component

uint8 bpf::math::Color::B

B component

uint8 bpf::math::Color::A

A component