libtcod
Loading...
Searching...
No Matches
tcod::ColorRGB Struct Reference

A C++ RGB color, used to handle conversions between color types. More...

#include <color.hpp>

Inheritance diagram for tcod::ColorRGB:
TCOD_ColorRGB

Public Member Functions

constexpr ColorRGB () noexcept
 Default construct a black ColorRGB object.
 
constexpr ColorRGB (uint8_t red, uint8_t green, uint8_t blue) noexcept
 Construct a ColorRGB object with the provided color.
 
constexpr ColorRGB (const TCOD_ColorRGB &rhs) noexcept
 Construct a ColorRGB object from an TCOD_ColorRGB struct.
 
constexpr ColorRGB (const TCOD_ColorRGBA &rhs) noexcept
 Construct a ColorRGB object from an RGBA color, truncating the alpha.
 
constexpr operator const TCOD_ColorRGBA () const noexcept
 Allow implicit casts to RGBA colors, where alpha=255 is implied.
 
constexpr operator TCOD_ColorRGB * () noexcept
 Allow explicit casts to a TCOD_ColorRGB pointer.
 
constexpr operator const TCOD_ColorRGB * () const noexcept
 Allow explicit casts to a const TCOD_ColorRGB pointer.
 
- Public Member Functions inherited from TCOD_ColorRGB
constexpr bool operator== (const TCOD_ColorRGB &rhs) const noexcept
 
constexpr bool operator!= (const TCOD_ColorRGB &rhs) const noexcept
 
template<class Archive>
void serialize (Archive &archive)
 

Additional Inherited Members

- Public Attributes inherited from TCOD_ColorRGB
uint8_t r
 
uint8_t g
 
uint8_t b
 

Detailed Description

A C++ RGB color, used to handle conversions between color types.

embed:rst:leading-asterisk
 .. versionadded:: 1.19

Constructor & Destructor Documentation

◆ ColorRGB()

tcod::ColorRGB::ColorRGB ( )
inlineconstexprnoexcept

Default construct a black ColorRGB object.

RGB values are zero.


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