ra8_ui.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* ===========================================================================
 * Compile-time limits
 * ===========================================================================
 */

typedef enum : uint16_t {
  k_ra8_ui_nav_max_depth = 8U, 
} ra8_ui_limits_t;
 
/* ===========================================================================
 * Geometry + hit-testing
 * ===========================================================================
 */

typedef struct {
  int32_t x; 
  int32_t y; 
  int32_t w; 
  int32_t h; 
} ra8_ui_rect_t;

typedef struct {
  ra8_ui_rect_t rect;      
  uint16_t      action_id; 
  uint16_t      reserved;  
} ra8_ui_target_t;

bool ra8_ui_rect_contains(const ra8_ui_rect_t* r, int32_t px, int32_t py);

[[nodiscard]] ra8_err_t ra8_ui_hit_test(const ra8_ui_target_t* targets,
                                        uint16_t               count,
                                        int32_t                px,
                                        int32_t                py,
                                        uint16_t*              out_action,
                                        bool*                  out_hit);
 
/* ===========================================================================
 * Screen-stack navigation
 * ===========================================================================
 */

typedef struct {
  uint16_t stack[k_ra8_ui_nav_max_depth]; 
  uint8_t  depth;                         
  uint8_t  reserved[3];                   
} ra8_ui_nav_t;

[[nodiscard]] ra8_err_t ra8_ui_nav_init(ra8_ui_nav_t* nav, uint16_t root_screen);

[[nodiscard]] ra8_err_t ra8_ui_nav_push(ra8_ui_nav_t* nav, uint16_t screen);

[[nodiscard]] ra8_err_t ra8_ui_nav_pop(ra8_ui_nav_t* nav, uint16_t* out_screen);

[[nodiscard]] ra8_err_t ra8_ui_nav_replace(ra8_ui_nav_t* nav, uint16_t screen);

[[nodiscard]] ra8_err_t ra8_ui_nav_top(const ra8_ui_nav_t* nav, uint16_t* out_screen);
 
/* ===========================================================================
 * Paging
 * ===========================================================================
 */

typedef struct {
  uint16_t current; 
  uint16_t total;   
} ra8_ui_pager_t;

[[nodiscard]] ra8_err_t ra8_ui_pager_init(ra8_ui_pager_t* p, uint16_t total);

[[nodiscard]] ra8_err_t ra8_ui_pager_next(ra8_ui_pager_t* p, bool* out_changed);

[[nodiscard]] ra8_err_t ra8_ui_pager_prev(ra8_ui_pager_t* p, bool* out_changed);

[[nodiscard]] ra8_err_t ra8_ui_pager_goto(ra8_ui_pager_t* p, uint16_t page, bool* out_changed);
 
#ifdef __cplusplus
}
#endif