roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes
roo_display::FontProperties Class Reference

Metadata describing a font's encoding and spacing behavior. More...

#include <font.h>

Public Types

enum class  Charset { kAscii , kUnicodeBmp }
 Character set supported by the font. More...
 
enum class  Spacing { kProportional , kMonospace }
 Spacing behavior for glyph advances. More...
 
enum class  Smoothing { kNone , kGrayscale }
 Smoothing/anti-aliasing mode. More...
 
enum class  Kerning { kNone , kPairs }
 Kerning information availability. More...
 

Public Member Functions

 FontProperties ()=default
 
 FontProperties (FontProperties &&)=default
 
FontProperties & operator= (FontProperties &&)=default
 
 FontProperties (Charset charset, Spacing spacing, Smoothing smoothing, Kerning kerning)
 Construct font properties.
 
Charset charset () const
 Character set supported.
 
Spacing spacing () const
 Spacing behavior.
 
Smoothing smoothing () const
 Smoothing/anti-aliasing mode.
 
Kerning kerning () const
 Kerning mode.
 

Static Public Attributes

static constexpr Charset CHARSET_ASCII = Charset::kAscii
 
static constexpr Charset CHARSET_UNICODE_BMP = Charset::kUnicodeBmp
 
static constexpr Spacing SPACING_PROPORTIONAL = Spacing::kProportional
 
static constexpr Spacing SPACING_MONOSPACE = Spacing::kMonospace
 
static constexpr Smoothing SMOOTHING_NONE = Smoothing::kNone
 
static constexpr Smoothing SMOOTHING_GRAYSCALE = Smoothing::kGrayscale
 
static constexpr Kerning KERNING_NONE = Kerning::kNone
 
static constexpr Kerning KERNING_PAIRS = Kerning::kPairs
 

Detailed Description

Metadata describing a font's encoding and spacing behavior.

Definition at line 73 of file font.h.

Member Enumeration Documentation

◆ Charset

enum class roo_display::FontProperties::Charset
strong

Character set supported by the font.

Enumerator
kAscii 
kUnicodeBmp 

Definition at line 76 of file font.h.

◆ Kerning

enum class roo_display::FontProperties::Kerning
strong

Kerning information availability.

Enumerator
kNone 
kPairs 

Definition at line 88 of file font.h.

◆ Smoothing

enum class roo_display::FontProperties::Smoothing
strong

Smoothing/anti-aliasing mode.

Enumerator
kNone 
kGrayscale 

Definition at line 85 of file font.h.

◆ Spacing

enum class roo_display::FontProperties::Spacing
strong

Spacing behavior for glyph advances.

Enumerator
kProportional 
kMonospace 

Definition at line 82 of file font.h.

Constructor & Destructor Documentation

◆ FontProperties() [1/3]

roo_display::FontProperties::FontProperties ( )
default

◆ FontProperties() [2/3]

roo_display::FontProperties::FontProperties ( FontProperties &&  )
default

◆ FontProperties() [3/3]

roo_display::FontProperties::FontProperties ( Charset  charset,
Spacing  spacing,
Smoothing  smoothing,
Kerning  kerning 
)
inline

Construct font properties.

Definition at line 115 of file font.h.

Member Function Documentation

◆ charset()

Charset roo_display::FontProperties::charset ( ) const
inline

Character set supported.

Definition at line 123 of file font.h.

◆ kerning()

Kerning roo_display::FontProperties::kerning ( ) const
inline

Kerning mode.

Definition at line 129 of file font.h.

◆ operator=()

FontProperties & roo_display::FontProperties::operator= ( FontProperties &&  )
default

◆ smoothing()

Smoothing roo_display::FontProperties::smoothing ( ) const
inline

Smoothing/anti-aliasing mode.

Definition at line 127 of file font.h.

◆ spacing()

Spacing roo_display::FontProperties::spacing ( ) const
inline

Spacing behavior.

Definition at line 125 of file font.h.

Field Documentation

◆ CHARSET_ASCII

constexpr Charset roo_display::FontProperties::CHARSET_ASCII = Charset::kAscii
staticconstexpr

Definition at line 91 of file font.h.

◆ CHARSET_UNICODE_BMP

constexpr Charset roo_display::FontProperties::CHARSET_UNICODE_BMP = Charset::kUnicodeBmp
staticconstexpr

Definition at line 93 of file font.h.

◆ KERNING_NONE

constexpr Kerning roo_display::FontProperties::KERNING_NONE = Kerning::kNone
staticconstexpr

Definition at line 106 of file font.h.

◆ KERNING_PAIRS

constexpr Kerning roo_display::FontProperties::KERNING_PAIRS = Kerning::kPairs
staticconstexpr

Definition at line 108 of file font.h.

◆ SMOOTHING_GRAYSCALE

constexpr Smoothing roo_display::FontProperties::SMOOTHING_GRAYSCALE = Smoothing::kGrayscale
staticconstexpr

Definition at line 103 of file font.h.

◆ SMOOTHING_NONE

constexpr Smoothing roo_display::FontProperties::SMOOTHING_NONE = Smoothing::kNone
staticconstexpr

Definition at line 101 of file font.h.

◆ SPACING_MONOSPACE

constexpr Spacing roo_display::FontProperties::SPACING_MONOSPACE = Spacing::kMonospace
staticconstexpr

Definition at line 98 of file font.h.

◆ SPACING_PROPORTIONAL

constexpr Spacing roo_display::FontProperties::SPACING_PROPORTIONAL = Spacing::kProportional
staticconstexpr

Definition at line 96 of file font.h.

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