OpenTTD Source 20260208-master-g43af8e94d0
ColourBGRA Union Reference

Packed colour union to access the alpha, red, green, and blue channels from a 32 bit number for little-endian systems. More...

#include <gfx_type.h>

Public Member Functions

constexpr ColourBGRA (uint8_t r, uint8_t g, uint8_t b, uint8_t a=0xFF)
 Create a new colour.
constexpr ColourBGRA (uint data=0)
 Create a new colour.
bool operator== (const ColourBGRA &other) const

Data Fields

uint32_t data
 Conversion of the channel information to a 32 bit number.
struct { 
   uint8_t   b 
   uint8_t   g 
   uint8_t   r 
   uint8_t   a 
 colour channels in LE order More...
}; 

Detailed Description

Packed colour union to access the alpha, red, green, and blue channels from a 32 bit number for little-endian systems.

Definition at line 215 of file gfx_type.h.

Constructor & Destructor Documentation

◆ ColourBGRA() [1/2]

ColourBGRA::ColourBGRA ( uint8_t r,
uint8_t g,
uint8_t b,
uint8_t a = 0xFF )
inlineconstexpr

Create a new colour.

Parameters
rThe channel for the red colour.
gThe channel for the green colour.
bThe channel for the blue colour.
aThe channel for the alpha/transparency.

Definition at line 228 of file gfx_type.h.

References a.

◆ ColourBGRA() [2/2]

ColourBGRA::ColourBGRA ( uint data = 0)
inlineconstexpr

Create a new colour.

Parameters
dataThe colour in the correct packed format.

Definition at line 234 of file gfx_type.h.

References data.

Member Function Documentation

◆ operator==()

bool ColourBGRA::operator== ( const ColourBGRA & other) const
inline

Definition at line 236 of file gfx_type.h.

Field Documentation

◆ a

uint8_t ColourBGRA::a

colour channels in LE order

Definition at line 218 of file gfx_type.h.

Referenced by ColourBGRA().

◆ b

uint8_t ColourBGRA::b

Definition at line 218 of file gfx_type.h.

◆ data

uint32_t ColourBGRA::data

Conversion of the channel information to a 32 bit number.

Definition at line 216 of file gfx_type.h.

Referenced by ColourBGRA().

◆ g

uint8_t ColourBGRA::g

Definition at line 218 of file gfx_type.h.

◆ r

uint8_t ColourBGRA::r

Definition at line 218 of file gfx_type.h.


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