roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
roo_display::HAlign Class Reference

Horizontal alignment. More...

#include <alignment.h>

Inheritance diagram for roo_display::HAlign:
[legend]
Collaboration diagram for roo_display::HAlign:
[legend]

Public Member Functions

constexpr HAlign shiftBy (int16_t shift_by) const
 
constexpr HAlign toLeft () const
 
constexpr HAlign toCenter () const
 
constexpr HAlign toRight () const
 
constexpr HAlign toOrigin () const
 
- Public Member Functions inherited from roo_display::internal::AlignBase
constexpr AlignBase ()
 
constexpr AlignBase (Anchor dst, Anchor src, int16_t shift)
 
constexpr Anchor src () const
 
constexpr Anchor dst () const
 
constexpr int16_t shift () const
 
template<typename Dim >
Dim resolveOffset (Dim first_outer, Dim last_outer, Dim first_inner, Dim last_inner) const
 
bool operator== (AlignBase other) const
 
bool operator!= (AlignBase other) const
 

Additional Inherited Members

- Protected Attributes inherited from roo_display::internal::AlignBase
uint16_t rep_
 

Detailed Description

Horizontal alignment.

Consists of: 1) source anchor (left/center/right/origin) 2) destination anchor (left/center/right/origin) 3) absolute offset (padding)

Prefer using the constants and modifying them, e.g. kLeft.toCenter().shiftBy(5) aligns the left boundary of the source to be 5 pixels to the right of the destination center.

Definition at line 73 of file alignment.h.

Member Function Documentation

◆ shiftBy()

constexpr HAlign roo_display::HAlign::shiftBy ( int16_t  shift_by) const
inlineconstexpr

◆ toCenter()

constexpr HAlign roo_display::HAlign::toCenter ( ) const
inlineconstexpr

◆ toLeft()

constexpr HAlign roo_display::HAlign::toLeft ( ) const
inlineconstexpr

◆ toOrigin()

constexpr HAlign roo_display::HAlign::toOrigin ( ) const
inlineconstexpr

◆ toRight()

constexpr HAlign roo_display::HAlign::toRight ( ) const
inlineconstexpr

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