pico8.h

Go to the documentation of this file.

 
#pragma once
#include <vector>
#include <span> 
#include <b8/type.h>
#include <b8/assert.h>
#include <b8/ppu.h>
#include <b8/misc.h>
#include <trace.h>
#include <handle.h>
#include <submath.h>
#include <stdarg.h>
#include <memory>
#include <optional> 
 
/*
  TODO: Comparison table with original PICO-8
  TODO: Standardize naming with tget / tset
  TODO: Implement sset(x, y, [col]) -- Sets the color of a pixel on the sprite sheet
*/
namespace pico8 {
 
#define MUST(cond, errcode) \
    do { \
        if (!(cond)) { \
            seterr(errcode); \
            return; \
        } \
    } while(0)
 
#define MUST_RETURN(cond, errcode, retval) \
    do { \
        if (!(cond)) { \
            seterr(errcode); \
            return (retval); \
        } \
    } while(0)
 
 
 
  enum Color {
    BLACK,          
    DARK_BLUE,      
    DARK_PURPLE,    
    DARK_GREEN,     
    BROWN,          
    DARK_GREY,      
    LIGHT_GREY,     
    WHITE,          
    RED,            
    ORANGE,         
    YELLOW,         
    GREEN,          
    BLUE,           
    LAVENDER,       
    PINK,           
    LIGHT_PEACH,    
    CURRENT         
  };
 
  enum  BgPal {
    BG_PAL_0,
    BG_PAL_1,
    BG_PAL_2,
    BG_PAL_3,
    /* --- */
    BG_PAL_CURRENT
  };
 
  enum Error {
    NO_ERROR,           
    NOT_DURING_DRAWING, 
    INVALID_PARAM,      
    NOT_INITIALIZED,
    EMPTY_SPAN
  };
  void  seterr( Error error );
 
  enum MouseBtn {
    LEFT      = 1<<0,
    RIGHT     = 1<<1,  // Right button (currently unused, reserved for future use)
  };
 
  enum Button {
    BUTTON_LEFT  = 0, 
    BUTTON_RIGHT = 1, 
    BUTTON_UP    = 2, 
    BUTTON_DOWN  = 3, 
    BUTTON_O     = 4, 
    BUTTON_X     = 5, 
    BUTTON_MOUSE_LEFT = 6,
    /* --- */
    BUTTON_ANY   = 0x10,
    /* --- */
    BUTTON_MAX
    // Note: Unlike PICO-8, BEEP-8 is primarily designed for smartphone use.
    // These buttons are only functional on PC platforms and referencing them is discouraged
    // for applications intended to run on mobile devices.
  };
 
  void cls(Color color = BLACK);
 
  Color color(Color color);
 
  void rectfill(fx8 x0, fx8 y0, fx8 x1, fx8 y1, Color color = CURRENT);
 
  void pset(fx8 x0, fx8 y0, Color color = CURRENT);
 
  void  rect(fx8 x0, fx8 y0, fx8 x1, fx8 y1, Color color = CURRENT);
 
  void  line(fx8 x0,fx8 y0,fx8 x1,fx8 y1, Color color = CURRENT );
 
  void  line(const Line& ln, Color color = CURRENT);
 
  void  poly(const Poly& pol, Color color = CURRENT);
 
  void  poly(fx8 x0, fx8 y0, fx8 x1, fx8 y1, fx8 x2, fx8 y2, Color color = CURRENT);
 
  void spr(int n, fx8 x = fx8(0), fx8 y = fx8(0), u8 w = 1, u8 h = 1, bool flip_x = false, bool flip_y = false, u8 selpal = 0);
 
  void sprb(u8 bank, int n, fx8 x = fx8(0), fx8 y = fx8(0), u8 w = 1, u8 h = 1, bool flip_x = false, bool flip_y = false, u8 selpal = 0);
 
  void lsp(u8 bank,const uint8_t* srcimg);
 
  void setpal(int palsel, const std::array<unsigned char, 16>& pidx);
 
  void pal( Color c0 , Color c1 , u8 palsel=0 );
 
  const Vec& camera(fx8 camera_x = fx8(0), fx8 camera_y = fx8(0));
 
  int setz(int otz);
 
  int getz();
 
  int maxz();
 
  void circ(fx8 x, fx8 y, fx8 r = fx8(4), Color col = CURRENT);
 
  void circfill(fx8 x, fx8 y, fx8 r = fx8(4), Color col = CURRENT);
 
  const Rect& clip(fx8 x, fx8 y, fx8 w, fx8 h);
 
  const Rect& clip(const Rect& rc);
 
  const Rect& clip();
 
  struct SprCursor {
    int x; 
    int y; 
    Color color; 
    int z; 
 
    inline void Reset() {
        x = y = z = 0;
        color = CURRENT;
    }
 
    SprCursor(){ Reset(); }
  };
 
  const SprCursor& scursor(int x = 0, int y = 0, Color color = CURRENT, int z = 0);
 
  void sprint(const std::string_view format, ...);
 
  void sprint(int x, int y, Color color, std::string_view format, ...);
 
  struct BgCursor {
    int x; 
    int y; 
    BgPal pal; 
 
    inline void Reset() {
      x = y = 0;
      pal = BG_PAL_CURRENT;
    }
    BgCursor(){
      Reset();
    }
  };
 
  const BgCursor& cursor(int x = 0, int y = 0, BgPal pal = BG_PAL_CURRENT);
 
  void print(std::string_view format, ...);
  
  void dprint(std::string_view format, ...);
 
  void dprintenable(bool enable);
 
  void print(int x, int y, BgPal pal, std::string_view format, ...);
 
  void fset(u8 sprite_index, u8 flag_index = 0xff, u8 value = 0, u8 sprite_pattern_bank = 0);
 
  u8 fget(u8 sprite_index, u8 flag_index = 0xff, u8 sprite_pattern_bank = 0);
 
 
  enum  BgIndex{ BG_0, BG_1, BG_2, BG_3 , BG_MAX };
  enum  BgTiles{
    TILES_8   = 1<<3,
    TILES_16  = 1<<4,
    TILES_32  = 1<<5,
    TILES_64  = 1<<6,
    TILES_128 = 1<<7,
    TILES_256 = 1<<8,
    TILES_512 = 1<<9,
    TILES_1024= 1<<10,
    TILES_2048= 1<<11,
  };
  using BgTilesPtr = std::shared_ptr<std::vector<b8PpuBgTile>>;
 
  void  mapsetup(BgTiles wtile, BgTiles htile, std::optional<BgTilesPtr> tiles = std::nullopt , u8 uwrap = B8_PPU_BG_WRAP_CLAMP, u8 vwrap = B8_PPU_BG_WRAP_CLAMP , BgIndex index = BG_0 );
 
  void  map(s16 upix,s16 vpix, BgIndex index = BG_0 );
 
  inline  void  mapdraw(s16 upix,s16 vpix, BgIndex index = BG_0 ){
    pico8::map(upix,vpix,index);
  }
 
  b8PpuBgTile mgett(u32 x, u32 y, BgIndex index = BG_0);
 
  u16 mget(u32 x, u32 y, BgIndex index = BG_0);
 
  void mset(u32 x, u32 y, u8 v, u8 bank = 0, BgIndex index = BG_0, uint8_t pal = 0);
 
  void  msett(u32 x,u32 y,b8PpuBgTile tile,BgIndex index = BG_0 );
 
  void mcls(b8PpuBgTile tile = b8PpuBgTile{0, 0, 0, 0, 0}, BgIndex index = BG_0);
 
  u32 btn(Button button=BUTTON_ANY, u8 player = 0);
 
  bool btnp(Button button, u8 player=0);
 
  u32 btnr(Button button, u8 player=0);
 
  s32 stat(int index);
 
  fx8 mousex();
 
  fx8 mousey();
 
  u32 mousestatus();
 
  fx8 cos(fx8 rad);
 
  fx8 sin(fx8 rad);
 
  fx8 atan2(fx8 y, fx8 x);
  
  fx8 abs(fx8 x);
 
  fx8 flr(fx8 x);
 
  fx8 cel(fx8 x);
 
  fx8 max(fx8 x, fx8 y);
 
  fx8 min(fx8 x, fx8 y);
 
  fx8 mid( fx8 first, fx8 second, fx8 third );
 
  inline  fx8 clamp( fx8 first, fx8 second, fx8 third ){
    return pico8::mid(first,second,third);
  }
 
  fx8 sgn(fx8 x);
 
  fx8 sqrt(fx8 x);
 
  fx8 rnd(fx8 x = fx8(1.0));
 
  u32 rndu();
 
  fx8 rndi(fx8 x);
 
  fx8 rndf(fx8 x0, fx8 x1);
 
  template <typename T>
  const T& rndt(std::span<const T> sp) {
      static const T dummy_value{};
      if (sp.empty()) return dummy_value;
      std::size_t index = qmod( std::rand() , sp.size() );
      return sp[index];
  }
 
  template <typename T, std::size_t N>
  const T& rndt(const T (&arr)[N]) {
      return rndt(std::span<const T>(arr));
  }
 
  void  srand(u32 seed );
 
  fx8 resw();
 
  fx8 resh();
 
  Color sget(u8 x, u8 y , u8 bank = 0 );
 
  class ImplPico8;
 
  class Pico8 {
      friend class ImplPico8;
      ImplPico8* _impl;  
      virtual void _init(){}   
      virtual void _update(){} 
      virtual void _draw(){}   
 
  public:
      void run();
  };
}