ISF15ACP4 Driver 1.0.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces | Typedefs | Enumerations | Functions | Variables
isf15acp4_types.hpp File Reference

Shared types, constants, and color utilities for NKK SmartDisplay OLED drivers. More...

#include <cstddef>
#include <cstdint>
Include dependency graph for isf15acp4_types.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  isf15acp4::DisplayGeometry
 Compile-time display geometry for a product variant. More...
 
struct  isf15acp4::Point
 2D point in display coordinates. More...
 
struct  isf15acp4::Rect
 Axis-aligned rectangle in display coordinates (inclusive bounds). More...
 

Namespaces

namespace  isf15acp4
 
namespace  isf15acp4::colors
 Common preset colors.
 

Typedefs

using isf15acp4::Color565 = uint16_t
 16-bit RGB565 color value (R5G6B5).
 

Enumerations

enum class  isf15acp4::ProductVariant : uint8_t { isf15acp4::Isf15acp4 = 0 , isf15acp4::Isc15anp4 = 1 , isf15acp4::Isc01p = 2 }
 Supported NKK SmartDisplay OLED product variants. More...
 
enum class  isf15acp4::Error : uint16_t {
  isf15acp4::None = 0 , isf15acp4::SpiWrite = 1 << 0 , isf15acp4::GpioControl = 1 << 1 , isf15acp4::InvalidParam = 1 << 2 ,
  isf15acp4::NotInitialized = 1 << 3 , isf15acp4::OutOfRange = 1 << 4 , isf15acp4::PowerSequence = 1 << 5
}
 Driver error flags (bitmask). More...
 
enum class  isf15acp4::DisplayState : uint8_t { isf15acp4::Off = 0 , isf15acp4::On = 1 , isf15acp4::Dim = 2 }
 Display power/visibility state. More...
 

Functions

constexpr const DisplayGeometry & isf15acp4::GetGeometry (ProductVariant variant) noexcept
 Get geometry metadata for a product variant.
 
constexpr Color565 isf15acp4::MakeColor565 (uint8_t r, uint8_t g, uint8_t b) noexcept
 Build an RGB565 color from 8-bit RGB channels.
 
Color565 isf15acp4::BmpPixelToColor565 (const uint8_t *bgr) noexcept
 Convert a 24-bit BMP pixel (BGR byte order) to RGB565.
 

Variables

constexpr DisplayGeometry isf15acp4::kGeometryIsf15acp4
 
constexpr DisplayGeometry isf15acp4::kGeometryIsc15anp4
 
constexpr DisplayGeometry isf15acp4::kGeometryIsc01p
 
constexpr Color565 isf15acp4::colors::Black = MakeColor565(0, 0, 0)
 
constexpr Color565 isf15acp4::colors::White = MakeColor565(255, 255, 255)
 
constexpr Color565 isf15acp4::colors::Red = MakeColor565(255, 0, 0)
 
constexpr Color565 isf15acp4::colors::Green = MakeColor565(0, 255, 0)
 
constexpr Color565 isf15acp4::colors::Blue = MakeColor565(0, 0, 255)
 
constexpr Color565 isf15acp4::colors::Yellow = MakeColor565(255, 255, 0)
 
constexpr Color565 isf15acp4::colors::Cyan = MakeColor565(0, 255, 255)
 
constexpr Color565 isf15acp4::colors::Magenta = MakeColor565(255, 0, 255)
 
constexpr Color565 isf15acp4::colors::Orange = MakeColor565(255, 165, 0)
 
constexpr Color565 isf15acp4::colors::Gray = MakeColor565(128, 128, 128)
 

Detailed Description

Shared types, constants, and color utilities for NKK SmartDisplay OLED drivers.