Color Class Reference

Class for storing color objects. More...

#include <Color.hpp>

Public Member Functions
MYGL_EXPORT	Color () noexcept
	Default constructor, creates a white color.
MYGL_EXPORT	Color (uint8_t r, uint8_t g, uint8_t b, uint8_t alpha=255) noexcept
	Creates a color from individual componenets.
MYGL_EXPORT	Color (const std::string &hexColor, uint8_t alpha=255)
	Creates a color from an hexadecimal color code.
MYGL_EXPORT glm::ivec4	get () const noexcept
	Gives the color as a glm::ivec4.
MYGL_EXPORT glm::vec4	getNormalized () const noexcept
	Gives the color with its components normalized (float between 0 and 1)
MYGL_EXPORT int	getRed () const noexcept
MYGL_EXPORT int	getGreen () const noexcept
MYGL_EXPORT int	getBlue () const noexcept
MYGL_EXPORT int	getAlpha () const noexcept
MYGL_EXPORT void	setRed (uint8_t red) noexcept
	Sets the color's red component.
MYGL_EXPORT void	setGreen (uint8_t green) noexcept
	Sets the color's green component.
MYGL_EXPORT void	setBlue (uint8_t blue) noexcept
	Sets the color's blue component.
MYGL_EXPORT void	setAlpha (uint8_t alpha) noexcept
	Sets the color's alpha component.

Static Public Attributes
static MYGL_EXPORT const Color	white
static MYGL_EXPORT const Color	black
static MYGL_EXPORT const Color	red
static MYGL_EXPORT const Color	green
static MYGL_EXPORT const Color	blue

Detailed Description

Class for storing color objects.

Definition at line 16 of file Color.hpp.

Constructor & Destructor Documentation

Color() [1/2]

MYGL_EXPORT Color ( uint8_t r, uint8_t g, uint8_t b, uint8_t alpha = 255 )

noexcept

Creates a color from individual componenets.

Parameters

r	The color's red component
g	The color's green component
b	The color's blue component
alpha	The transparency component, by default 255 (0 = transparent, 255 = opaque)

Color() [2/2]

MYGL_EXPORT Color	(	const std::string &	hexColor,
		uint8_t	alpha = 255 )

Creates a color from an hexadecimal color code.

Parameters

hexColor	The hex color code (without the '#')
alpha	The transparency component, by default 255 (0 = transparent, 255 = opaque)

Member Function Documentation

get()

MYGL_EXPORT glm::ivec4 get ( ) const

noexcept

Gives the color as a glm::ivec4.

Returns

A glm::ivec4 conataining the color's components

getAlpha()

MYGL_EXPORT int getAlpha ( ) const

noexcept

Returns

The color's alpha component

getBlue()

MYGL_EXPORT int getBlue ( ) const

noexcept

Returns

The color's blue component

getGreen()

MYGL_EXPORT int getGreen ( ) const

noexcept

Returns

The color's green component

getNormalized()

MYGL_EXPORT glm::vec4 getNormalized ( ) const

noexcept

Gives the color with its components normalized (float between 0 and 1)

Returns

A glm::vec4 containing the color's noramlized components

getRed()

MYGL_EXPORT int getRed ( ) const

noexcept

Returns

The color's red component

setAlpha()

MYGL_EXPORT void setAlpha ( uint8_t alpha )

noexcept

Sets the color's alpha component.

Parameters

alpha

The new alpha component

setBlue()

MYGL_EXPORT void setBlue ( uint8_t blue )

noexcept

Sets the color's blue component.

Parameters

blue	The new blue component

setGreen()

MYGL_EXPORT void setGreen ( uint8_t green )

noexcept

Sets the color's green component.

Parameters

green

The new green component

setRed()

MYGL_EXPORT void setRed ( uint8_t red )

noexcept

Sets the color's red component.

Parameters

red	The new red component

Member Data Documentation

black

MYGL_EXPORT const Color black

static

Definition at line 27 of file Color.hpp.

blue

MYGL_EXPORT const Color blue

static

Definition at line 30 of file Color.hpp.

green

MYGL_EXPORT const Color green

static

Definition at line 29 of file Color.hpp.

red

MYGL_EXPORT const Color red

static

Definition at line 28 of file Color.hpp.

white

MYGL_EXPORT const Color white

static

Definition at line 26 of file Color.hpp.

---

The documentation for this class was generated from the following file:

• Color.hpp