ra8_drw.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_drw_regs.h"
#include "ra8_err.h"
 
/* =============================================================================
 * Configuration / runtime data structures
 * =============================================================================
 */

typedef struct {
  uintptr_t             framebuffer_addr;       
  uint16_t              pitch_px;               
  ra8_drw_writeformat_t format;                 
  bool                  enable_caches;          
  bool                  enable_buffered_writes; 
} ra8_drw_config_t;

typedef struct {
  int16_t  x;              
  int16_t  y;              
  uint16_t width_px;       
  uint16_t height_px;      
  uint32_t color_argb8888; 
} ra8_drw_rect_t;

typedef struct {
  bool    use_alpha_channel; 
  bool    src_factor;        
  bool    dst_factor;        
  bool    src_invert;        
  bool    dst_invert;        
  bool    src_factor_alpha;  
  bool    dst_factor_alpha;  
  bool    src_invert_alpha;  
  bool    dst_invert_alpha;  
  bool    use_color2_dst;    
  uint8_t global_alpha;      
} ra8_drw_blend_t;

typedef struct {
  uintptr_t            base_addr;        
  uint16_t             pitch_px;         
  uint16_t             u_mask;           
  uint16_t             v_mask;           
  ra8_drw_readformat_t format;           
  bool                 clamp_x;          
  bool                 clamp_y;          
  bool                 filter_x;         
  bool                 filter_y;         
  bool                 enable_clut;      
  bool                 clut_565;         
  bool                 enable_color_key; 
  uint32_t             color_key_rgb;    
  bool                 enable_rle;       
  ra8_drw_rlepixel_t   rle_pixel_width;  
  uint8_t              clut_offset;      
} ra8_drw_texture_t;

typedef struct {
  int16_t  x0;             
  int16_t  y0;             
  int16_t  x1;             
  int16_t  y1;             
  uint16_t width_px;       
  uint32_t color_argb8888; 
} ra8_drw_line_t;

typedef struct {
  int16_t  x0;             
  int16_t  y0;             
  int16_t  x1;             
  int16_t  y1;             
  int16_t  x2;             
  int16_t  y2;             
  uint32_t color_argb8888; 
} ra8_drw_triangle_t;

typedef struct {
  uint32_t color1_argb8888; 
  uint32_t color2_argb8888; 
} ra8_drw_gradient_t;

typedef struct {
  uint32_t* buf;        
  uint32_t  cap_words;  
  uint32_t  count;      
  bool      overflow;   
  bool      terminated; 
} ra8_drw_dlist_t;

typedef void (*ra8_drw_event_fn_t)(void* ctx, uint32_t status_mask);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_init(const ra8_drw_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_drw_deinit(void);
 
/* =============================================================================
 * Status / IRQ
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_get_status(uint32_t* out_mask);

[[nodiscard]] ra8_err_t ra8_drw_get_hwrevision(uint32_t* out);

[[nodiscard]] ra8_err_t ra8_drw_clear_status(uint32_t mask);

[[nodiscard]] ra8_err_t ra8_drw_set_irq_enables(uint32_t enable_mask);

[[nodiscard]] ra8_err_t ra8_drw_attach_handler(ra8_drw_event_fn_t fn, void* ctx);

void ra8_drw_dispatch(void);

[[nodiscard]] ra8_err_t ra8_drw_wait_idle(uint32_t poll_budget);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_drw_exit_stop(void);

[[nodiscard]] ra8_err_t ra8_drw_reset(void);
 
/* =============================================================================
 * Cache control
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_cache_flush(bool flush_fb, bool flush_texture);
 
/* =============================================================================
 * Surface / blend / colour
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_set_gradient(const ra8_drw_gradient_t* grad);

[[nodiscard]] ra8_err_t ra8_drw_set_pattern(uint8_t pattern_byte);

[[nodiscard]] ra8_err_t ra8_drw_set_pattern_enable(bool enable, bool source_from_l5);

[[nodiscard]] ra8_err_t ra8_drw_set_blend(const ra8_drw_blend_t* blend);

[[nodiscard]] ra8_err_t ra8_drw_set_color_key(uint32_t key_rgb, bool enable);
 
/* =============================================================================
 * Texture
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_set_texture(const ra8_drw_texture_t* tex);

[[nodiscard]] ra8_err_t ra8_drw_clear_texture(void);

[[nodiscard]] ra8_err_t
ra8_drw_load_clut(uint8_t start_index, const uint32_t* entries, uint32_t count);
 
/* =============================================================================
 * Drawing primitives
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_fill_rect(const ra8_drw_rect_t* rect);

[[nodiscard]] ra8_err_t ra8_drw_blit_textured_rect(const ra8_drw_rect_t* rect);

[[nodiscard]] ra8_err_t ra8_drw_draw_line(const ra8_drw_line_t* line);

[[nodiscard]] ra8_err_t ra8_drw_draw_triangle(const ra8_drw_triangle_t* tri);
 
/* =============================================================================
 * Display list mode
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_run_dlist(const uint32_t* dlist_addr);
 
/* =============================================================================
 * Performance counters
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_drw_perf_arm(ra8_drw_perftrigger_t event_ctr1,
                                         ra8_drw_perftrigger_t event_ctr2);

[[nodiscard]] ra8_err_t ra8_drw_perf_read(ra8_drw_perfcounter_id_t id, uint32_t* out);

[[nodiscard]] ra8_err_t ra8_drw_perf_reset(ra8_drw_perfcounter_id_t id);
 
#ifdef __cplusplus
}
#endif