ra8_display_pal.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* =============================================================================
 * Public enums
 * =============================================================================
 */

typedef enum : uint8_t {
  k_display_pixfmt_rgb565 = 0U, 
  k_display_pixfmt_rgb888 = 1U, 
  k_display_pixfmt_grey4  = 2U, 
  k_display_pixfmt_grey1  = 3U, 
} display_pixfmt_t;

typedef enum : uint8_t {
  k_display_refresh_fast    = 0U, 
  k_display_refresh_quality = 1U, 
  k_display_refresh_init    = 2U, 
} display_refresh_hint_t;
 
/* =============================================================================
 * Public structs
 * =============================================================================
 */

typedef struct {
  uint16_t         width_px;                
  uint16_t         height_px;               
  display_pixfmt_t pixfmt;                  
  uint32_t         stride_bytes;            
  uint32_t         refresh_latency_us_typ;  
  bool             supports_partial_update; 
  bool             continuous_refresh;      
} display_caps_t;

typedef struct {
  void*            pixels;       
  uint16_t         width_px;     
  uint16_t         height_px;    
  uint32_t         stride_bytes; 
  display_pixfmt_t pixfmt;       
} display_fb_t;

typedef struct {
  uint16_t x; 
  uint16_t y; 
  uint16_t w; 
  uint16_t h; 
} display_rect_t;

typedef struct display_backend_iface display_backend_iface_t;

typedef struct display_handle display_handle_t;

typedef struct {
  const display_backend_iface_t* iface;
  void* framebuffer;
  uint32_t framebuffer_bytes;
  uint16_t width_px;
  uint16_t height_px;
  display_pixfmt_t pixfmt;
  const void* panel_timing;
} display_cfg_t;
 
/* =============================================================================
 * Public API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t display_init(const display_cfg_t* cfg, display_handle_t** out_handle);

[[nodiscard]] ra8_err_t display_get_caps(const display_handle_t* d, display_caps_t* out);

[[nodiscard]] ra8_err_t display_get_framebuffer(const display_handle_t* d, display_fb_t* out);

[[nodiscard]] ra8_err_t
display_flush(const display_handle_t* d, display_rect_t rect, display_refresh_hint_t hint);

[[nodiscard]] ra8_err_t display_clear(const display_handle_t* d, uint32_t color);

[[nodiscard]] ra8_err_t display_deinit(const display_handle_t* d);

display_rect_t display_full_rect(const display_handle_t* d);
 
#ifdef __cplusplus
}
#endif