IDisplay.h

Go to the documentation of this file.

#pragma once
 
#include "cdc_core/IService.h"
#include <cstdint>
 
namespace cdc::hal {

enum class RefreshMode : uint8_t {
    FULL,          // Full display refresh (multi-flash OTP waveform, slow, no ghosting)
    FAST,          // Full-screen refresh with the short waveform (single flash); clears most ghosting.
                   // Escalated to FULL after FEATURE_EPD_MAX_FASTS_BEFORE_FULL fast refreshes.
    PARTIAL,       // Partial refresh (fast, may ghost); escalated to FAST after
                   // FEATURE_EPD_MAX_PARTIALS_BEFORE_FAST consecutive partials
    PARTIAL_LIGHT  // Partial refresh never promoted; for tiny low-churn updates (e.g. lock-screen clock)
};

class IDisplay : public core::IService {
public:
    virtual ~IDisplay() = default;

    virtual void clear() = 0;

    virtual void flush(RefreshMode mode = RefreshMode::PARTIAL) = 0;

    virtual void flushSync(RefreshMode mode = RefreshMode::PARTIAL) = 0;

    virtual bool isBusy() const = 0;

    virtual uint16_t getWidth() const = 0;
    virtual uint16_t getHeight() const = 0;

    virtual void setBacklight(uint16_t level) = 0;

    virtual void saveBacklight() = 0;

    virtual uint16_t getBacklight() const = 0;

    virtual bool isBacklightOn() const = 0;

    virtual void backlightOn() = 0;

    virtual void backlightOff() = 0;

    virtual void* getNativeHandle() = 0;

    virtual void showSplash(const char* subtitle = nullptr) = 0;
 
    // === GFX Drawing Methods (avoid unsafe casts) ===

    virtual void drawPixel(int16_t x, int16_t y, uint16_t color) = 0;

    virtual void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color) = 0;

    virtual void drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color) = 0;

    virtual void fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color) = 0;

    virtual void setCursor(int16_t x, int16_t y) = 0;

    virtual void setTextColor(uint16_t color) = 0;

    virtual void setTextSize(uint8_t size) = 0;

    virtual void setFont(const void* font) = 0;

    virtual void print(const char* text) = 0;

    virtual void printf(const char* fmt, ...) = 0;
};
 
// Factory function to get display instance
IDisplay* getDisplayInstance();

void winkBacklight(uint8_t count = 2, uint16_t period_ms = 150);
 
} // namespace cdc::hal