libepaper 2.0.0
A C++23 library for controlling Waveshare e-paper displays on Raspberry Pi, featuring transparent sleep/wake management and a fluent builder API.
Loading...
Searching...
No Matches
Enumerations | Functions | Variables
epaper::internal Namespace Reference

Enumerations

enum class  PlaneCount : std::uint8_t { One , Two , Three }
 Type-safe enumeration for framebuffer plane counts. More...
 

Functions

constexpr auto plane_count_value (PlaneCount count) noexcept -> std::size_t
 
auto transform_coordinates (std::size_t x, std::size_t y, std::size_t width, std::size_t height, Orientation orientation) -> std::pair< std::size_t, std::size_t >
 

Variables

constexpr std::size_t PLANE_COUNT_ONE = 1
 Number of planes for single-plane displays (BW, Gray4, Spectra6)
 
constexpr std::size_t PLANE_COUNT_TWO = 2
 Number of planes for dual-plane displays (BWR, BWY)
 
constexpr std::size_t PLANE_COUNT_THREE = 3
 Number of planes for triple-plane displays (reserved for future modes)
 

Enumeration Type Documentation

◆ PlaneCount

enum class epaper::internal::PlaneCount : std::uint8_t
strong

Type-safe enumeration for framebuffer plane counts.

Used internally to represent the number of color planes in a framebuffer. Different display modes require different numbers of planes:

  • One: Monochrome modes (BlackWhite, Grayscale4, Spectra6)
  • Two: Dual-plane color modes (BWR, BWY) where base + accent planes
  • Three: Reserved for future multi-plane color modes
See also
MultiPlaneFramebuffer
Enumerator
One 

Single plane (monochrome or packed multi-color)

Two 

Dual plane (base + accent color)

Three 

Triple plane (reserved for future use)

Examples
/mnt/nas/libepaper/include/epaper/internal/internal.hpp.

Function Documentation

◆ plane_count_value()

constexpr auto epaper::internal::plane_count_value ( PlaneCount  count) -> std::size_t
constexprnoexcept

◆ transform_coordinates()

auto epaper::internal::transform_coordinates ( std::size_t  x,
std::size_t  y,
std::size_t  width,
std::size_t  height,
Orientation  orientation 
) -> std::pair<std::size_t, std::size_t>
inline
Examples
/mnt/nas/libepaper/include/epaper/internal/internal.hpp.
Here is the caller graph for this function:

Variable Documentation

◆ PLANE_COUNT_ONE

constexpr std::size_t epaper::internal::PLANE_COUNT_ONE = 1
inlineconstexpr

Number of planes for single-plane displays (BW, Gray4, Spectra6)

Examples
/mnt/nas/libepaper/include/epaper/core/framebuffer.hpp, and /mnt/nas/libepaper/include/epaper/internal/internal.hpp.

◆ PLANE_COUNT_THREE

constexpr std::size_t epaper::internal::PLANE_COUNT_THREE = 3
inlineconstexpr

Number of planes for triple-plane displays (reserved for future modes)

Examples
/mnt/nas/libepaper/include/epaper/internal/internal.hpp.

◆ PLANE_COUNT_TWO

constexpr std::size_t epaper::internal::PLANE_COUNT_TWO = 2
inlineconstexpr

Number of planes for dual-plane displays (BWR, BWY)

Examples
/mnt/nas/libepaper/include/epaper/internal/internal.hpp.