emu_presentation.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "board_overlay.h"
#include "ra8_attributes.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum : size_t {
  k_emu_presentation_max_panel_px = 4096U, 
  k_emu_presentation_tile_px      = 64U,   
  k_emu_presentation_max_scratch_bytes =
    2U * k_emu_presentation_tile_px * k_emu_presentation_tile_px * sizeof(uint16_t),
} emu_presentation_limit_t;

typedef enum : uint8_t {
  k_emu_presentation_ok = 0U,  
  k_emu_presentation_invalid,  
  k_emu_presentation_overflow, 
  k_emu_presentation_capacity, 
  k_emu_presentation_io,       
} emu_presentation_status_t;

typedef struct {
  size_t   panel_width;  
  size_t   panel_height; 
  uint32_t rotate_deg;   
  bool     active;       
} emu_presentation_spec_t;

typedef struct {
  emu_presentation_status_t status;                 
  size_t                    required_surface_bytes; 
  size_t                    required_scratch_bytes; 
  size_t                    supplied_scratch_bytes; 
  int                       os_error;               
} emu_presentation_result_t;

typedef struct {
  int       fd;               
  uint16_t  panel_width;      
  uint16_t  panel_height;     
  uint16_t  display_width;    
  uint16_t  display_height;   
  uint16_t  composite_width;  
  uint16_t  composite_height; 
  uint32_t  rotate_deg;       
  uint16_t* scratch;          
  size_t    scratch_bytes;    
  size_t    surface_bytes;    
} emu_presentation_workspace_t;

[[nodiscard]] emu_presentation_result_t
emu_presentation_requirements(const emu_presentation_spec_t* spec);

[[nodiscard]] emu_presentation_result_t
emu_presentation_open(const emu_presentation_spec_t* spec,
                      void*                          scratch,
                      size_t                         supplied_scratch_bytes,
                      emu_presentation_workspace_t*  workspace);

bool emu_presentation_close(emu_presentation_workspace_t* workspace);

bool emu_presentation_fill(void*    context,
                           uint16_t x,
                           uint16_t y,
                           uint16_t width,
                           uint16_t height,
                           uint16_t color);

bool emu_presentation_read(const emu_presentation_workspace_t* workspace,
                           size_t                              offset,
                           void*                               bytes,
                           size_t                              count);

bool emu_presentation_write(emu_presentation_workspace_t* workspace,
                            size_t                        offset,
                            const void*                   bytes,
                            size_t                        count);

bool emu_presentation_snapshot(emu_presentation_workspace_t* workspace, int* snapshot_fd);
 
#ifdef __cplusplus
}
#endif