sm2.h

Go to the documentation of this file.

// -*- coding: utf-8-unix -*-
/*
 * Copyright (c) 2021-2025 Daishi Mori (mori0091)
 *
 * This software is released under the MIT License.\n
 * See https://github.com/mori0091/libmsx/blob/main/LICENSE
 *
 * GitHub libmsx project\n
 * https://github.com/mori0091/libmsx
 */
#ifndef SM2_H_
#define SM2_H_
 
#include "sm2_cfg.h"
 
#include <sprite.h>
#include <sprite_color.h>
 
#define sm2_Slice(T) \
  struct {           \
    T * ptr;         \
    uint8_t len;     \
  }
 
#define SM2_SLICE(a) {.ptr = (a), .len = sizeof(a)/sizeof((a)[0])}
 
typedef struct sm2_Cel {
  uint8_t depth;
  uint32_t addr;
} sm2_Cel;
 
typedef struct sm2_Frame {
  size_t duration;
  sm2_Slice(const uint8_t) cel_ids;
} sm2_Frame;
 
typedef struct sm2_SpriteSheet {
  sm2_Slice(const sm2_Frame) frames;
  sm2_Slice(const sm2_Cel) cels;
} sm2_SpriteSheet;
 
enum SM2_Direction {
  SM2_FORWARD,
  SM2_REVERSE,
  SM2_PINGPONG,
  SM2_PINGPONG_REVERSE,
};
 
typedef struct sm2_FrameTag {
  uint8_t from;              
  uint8_t to;                
  uint8_t direction;         
  size_t repeats;            
} sm2_FrameTag;
 
typedef struct sm2_Sprite {
  const sm2_SpriteSheet * sheet; 
  const sm2_FrameTag * tag;      
  uint8_t curr_frame;            
  uint8_t curr_direction;        
  size_t remaining_duration;     
  size_t repeats;                
} sm2_Sprite;
 
void sm2_init(void);
 
void sm2_init_sprite(sm2_Sprite * s, const sm2_SpriteSheet * sheet, const sm2_FrameTag * tag);
 
void sm2_update_sprite(sm2_Sprite * s);
 
inline void sm2_update_sprites(sm2_Sprite ss[], size_t num) {
  while (num--) {
    sm2_update_sprite(ss);
    ss++;
  }
}
 
void sm2_flush(void);
 
void sm2_add_sprite(const sm2_Sprite * s, int x, int y);
 
void sm2_add_cel(const sm2_Cel * cel, int x, int y);
 
void sm2_reserve(uint8_t n);
 
uint8_t sm2_get_reserved(void);
 
void sm2_put_sprite(uint8_t base_plane, const sm2_Sprite * s, int x, int y);
 
void sm2_put_cel(uint8_t base_plane, const sm2_Cel * cel, int x, int y);
 
#endif // SM2_H_