clutchlog  0.16
clutchlog::fmt::color_16M Struct Reference

Abstract base class for 16M colors objects (24-bits ANSI). More...

#include <clutchlog.h>

+ Inheritance diagram for clutchlog::fmt::color_16M:
+ Collaboration diagram for clutchlog::fmt::color_16M:

Detailed Description

Abstract base class for 16M colors objects (24-bits ANSI).

Definition at line 586 of file clutchlog.h.

Public Member Functions

 color_16M (ground t)
 Constructor. More...
 
 color_16M (ground t, short r, short g, short b)
 Numeric triplet constructor. More...
 
 color_16M (ground t, const std::string &srgb)
 Hex triplet string constructor. More...
 
bool is_set () const
 Returns true if the underying representation encodes an existing color.
 
std::ostream & print_on (std::ostream &os) const
 Print the color RGB triplet on the given stream.
 
- Public Member Functions inherited from clutchlog::fmt::color
 color (ansi a, ground g)
 Constructor. More...
 

Public Attributes

short red
 The encoded RGB indices. More...
 
short green
 
short blue
 
- Public Attributes inherited from clutchlog::fmt::color
ansi mode
 
enum clutchlog::fmt::color::ground type
 Type of color (foreground or background).
 

Additional Inherited Members

- Public Types inherited from clutchlog::fmt::color
enum  ground { fore = 38, back = 48 }
 Codes for representing foreground or background.
 

Constructor & Destructor Documentation

◆ color_16M() [1/3]

clutchlog::fmt::color_16M::color_16M ( ground  t)
inline

Constructor.

Parameters
tForeground or background tag.

Definition at line 595 of file clutchlog.h.

◆ color_16M() [2/3]

clutchlog::fmt::color_16M::color_16M ( ground  t,
short  r,
short  g,
short  b 
)
inline

Numeric triplet constructor.

Parameters
tForeground or background tag.
rRed color component.
gGreen color component.
bBlue color component.

Definition at line 604 of file clutchlog.h.

◆ color_16M() [3/3]

clutchlog::fmt::color_16M::color_16M ( ground  t,
const std::string &  srgb 
)
inline

Hex triplet string constructor.

Note
If the given string is ill-formed, it will silently encode a "no color".
Parameters
tForeground or background tag.
srgbA "web color" hexadecimal triplet of two characters, starting with a leading number sign (e.g. "#0055ff").

Definition at line 614 of file clutchlog.h.

References red.

Member Data Documentation

◆ red

short clutchlog::fmt::color_16M::red

The encoded RGB indices.

"No color" is encoded as -1.

Definition at line 590 of file clutchlog.h.

Referenced by color_16M(), is_set(), and print_on().


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