xbasip: X-BASIC like package for micropython-x68k

xbasipパッケージ

spriteモジュール

• sp_init()

  • スプライトとBGを初期化します。パターンやパレットも初期化されます。

• sp_clr(code1=None, code2=None)

  • パターンコードcode1～code2まで（code2を含む）のパターンを初期化します。
  • code1 -- 開始パターンコード（0～255）
  • code2 -- 終了パターンコード（0～255）
  • code1のみを指定した場合はcode1だけ、また引数をすべて省略した場合は全パターン（0～255）が初期化されます。また、パターンコードの指定をtupleで与えることもできます。

• sp_color(pal, color, pal_blk=1, vsync=False)

  • スプライトとBGのパレットを設定します。
  • pal -- パレット番号（0～15）
  • color -- カラーコード
    • 0～65535 : 64K色コード（0b_GGGGG_RRRRR_BBBBB_L：RGB各5ビット、L輝度1ビット）
  • pal_blk -- パレットブロック（1～15）
  • vsync -- Trueに設定すると垂直帰線期間まで待ってから処理します
  • 戻り値 -- 設定前のカラーコード

• sp_on(sp1=None, sp2=None, prio=3, vsync=False)

  • スプライトプレーンsp1～sp2まで（sp2を含む）のスプライトを表示します。
  • sp1 -- 開始スプライトプレーン（0～127）
  • sp2 -- 終了スプライトプレーン（0～127）
  • prio -- プライオリティ
    • 0 : 表示しない
    • 1 : BG0＞BG1＞SP
    • 2 : BG0＞SP＞BG0
    • 3 : SP＞BG0＞BG1
  • vsync -- Trueに設定すると垂直帰線期間まで待ってから処理します
  • sp1のみを指定した場合はsp1だけ、また引数をすべて省略した場合は全スプライトプレーン（0～127）が表示されます。また、スプライトプレーンの指定をtupleで与えることもできます。

• sp_off(sp1=None, sp2=None, vsync=False)

  • スプライトプレーンsp1～sp2まで（sp2を含む）のスプライトを非表示にします。
  • sp1 -- 開始スプライトプレーン（0～127）
  • sp2 -- 終了スプライトプレーン（0～127）
  • vsync -- Trueに設定すると垂直帰線期間まで待ってから処理します
  • sp1のみを指定した場合はsp1だけ、また引数をすべて省略した場合は全スプライトプレーン（0～127）を非表示にします。また、スプライトプレーンの指定をtupleで与えることもできます。

• sp_def(code, buf, pat_size=1)

  • パターンを定義します。
  • code -- パターンコード（0～255）
    • BG実画面2枚の場合 : 16×16画素パターンは最大128個
    • BG実画面1枚の場合 : 16×16画素パターンは最大192個
    • BG実画面0枚の場合 : 16×16画素パターンは最大256個
    • 16×16画素パターン1つの領域に8×8画素パターン4つを定義できる（ただしパターン総数は256個まで）
    • 16×16画素パターンのパターンコードNは、8×8画素パターンのパターンコード4N～4N＋3の領域と重なっている
  • buf -- パターンデータ（bytearrayもしくはbytes）。1バイトあたり2画素
    • 32バイト : 8×8画素の場合
    • 128バイト : 16×16画素の場合
  • pat_size -- パターンサイズ
    • 0 : 8×8画素
    • 1 : 16×16画素。横16画素ずつの並び
    • 2 : 16×16画素。横8画素ずつの並び

• sp_pat(code, buf=None, pat_size=1)

  • パターンを読み出します。
  • code -- パターンコード（0～255）
  • buf -- パターンデータ（bytearrayもしくはbytes）。1バイトあたり2画素。省略時は内部で確保します
    • 32バイト : 8×8画素の場合
    • 128バイト : 16×16画素の場合
  • pat_size -- パターンサイズ
    • 0 : 8×8画素
    • 1 : 16×16画素。横16画素ずつの並び
    • 2 : 16×16画素。横8画素ずつの並び
  • 戻り値 -- パターンデータを返します

• sp_move(sp, x, y, code, vsync=False)

  • パターンをスプライトプレーンに割り当て、指定した位置に表示します。
  • sp -- スプライトプレーン（0～127）
  • x -- X座標（-16～1007）。表示画面左上は座標(0,0)。sp_set()と異なるので注意
  • y -- Y座標（-16～1007）
  • code -- パターンコード（0～255）
  • vsync -- Trueに設定すると垂直帰線期間まで待ってから処理します

• sp_set(sp, x, y, code_ex, prio, vsync=False)

  • パターンをスプライトプレーンに割り当て、指定した位置に表示します。
  • sp -- スプライトプレーン（0～127）
  • x -- X座標（0～1023）。表示画面左上は座標(16,16)。sp_move()と異なるので注意
  • y -- Y座標（0～1023）
  • code_ex -- 拡張パターンコード
    • bit 15 : 垂直反転
    • bit 14 : 水平反転
    • bit 8～11 : パレットブロック（1～15）
    • bit 0～7 : パターンコード（0～255）
  • prio -- プライオリティ
    • 0 : 表示しない
    • 1 : BG0＞BG1＞SP
    • 2 : BG0＞SP＞BG0
    • 3 : SP＞BG0＞BG1
  • vsync -- Trueに設定すると垂直帰線期間まで待ってから処理します

• sp_disp(disp_on=True)

  • スプライト画面の表示/非表示を設定します。
  • disp_on
    • True : 表示
    • False : 非表示

• sp_stat(sp)

  • スプライトプレーンの状態を読み出します。
  • sp -- スプライトプレーン（0～127）
  • 戻り値 -- (x, y, code_ex, prio)。tupleで返します。sp_set()の設定値に相当します
    • x : X座標（0～1023）
    • y : Y座標（0～1023）
    • code_ex : 拡張パターンコード
    • prio : プライオリティ

• sp_code(code, hrev, vrev, pal_blk)

  • パターンコードを拡張パターンコードに変換します。
  • code -- パターンコード（0～255）
  • hrev -- 水平反転（0、1）
  • vrev -- 垂直反転（0、1）
  • pal_blk -- パレットブロック（1～15）
  • 戻り値 -- 拡張パターンコード
    • bit 15 : 垂直反転
    • bit 14 : 水平反転
    • bit 8～11 : パレットブロック（1～15）
    • bit 0～7 : パターンコード（0～255）

• bg_set(bg, page, disp_on=True)

  • BG表示画面にBG実画面を割り当てます。
  • bg -- BG表示画面（0、1）
  • page -- BG実画面（0、1）
  • disp_on
    • True : 表示ON
    • False : 表示OFF

• bg_scroll(bg, x, y, vsync=0)

  • BG表示画面の左上に対応するBG実画面の座標を設定します。
  • bg -- BG表示画面（0、1）
  • x -- スクロールX座標。BG表示画面の左上に対応するBG実画面のX座標（画素単位）
    • 0～511 : 表示画面サイズが256×256画素の場合
    • 0～1023 : 表示画面サイズが512×512画素の場合
  • y -- スクロールY座標。BG表示画面の左上に対応するBG実画面のY座標（画素単位）
    • 0～511 : 表示画面サイズが256×256画素の場合
    • 0～1023 : 表示画面サイズが512×512画素の場合

• bg_fill(page, code_ex)

  • BG実画面をパターンで埋めつくします。
  • page -- BG実画面（0、1）
  • code_ex -- 拡張パターンコード
    • bit 15 : 垂直反転
    • bit 14 : 水平反転
    • bit 8～11 : パレットブロック（1～15）
    • bit 0～7 : パターンコード（0～255）

• bg_get(page, x, y)

  • BG実画面から指定座標のパターンコードを取得します。
  • page -- BG実画面（0、1）
  • x -- X座標（0～63）
  • y -- Y座標（0～63）
  • 戻り値 -- 拡張パターンコード

• bg_put(page, x, y, code_ex)

  • BG実画面の指定座標にパターンを描画します。
  • page -- BG実画面（0、1）
  • x -- X座標（0～63）
  • y -- Y座標（0～63）
  • code_ex -- 拡張パターンコード

• bg_stat(bg) -- returns: (x, y, page, disp_on)

  • BG表示画面の状態を取得します。
  • bg -- BG表示画面（0、1）
  • 戻り値 -- (x, y, page, disp_on)。tupleで返します

    • x : スクロールX座標

    • y : スクロールY座標

    • page : BG実画面（0、1）

    • disp_on : 表示状態（0、1）

    • 16×16画素パターン1つの領域に8×8画素パターン4つを定義できる（ただしパターン総数は256個まで）

    • 16×16画素パターンのパターンコードNは、8×8画素パターンのパターンコード4N～4N＋3の領域と重なっている

X68000メモ

BG画面

• 表示画面

  • 512×512画素×1層

    16×16画素16色×32×32パターン

  • 256×256画素×2層

    8×8画素16色×32×32パターン

• 実画面

  • 1024×1024画素16色（表示画面が512×512画素の場合）

    16×16画素×64×64パターン×1ページ

  • 512×512画素16色（表示画面が256×256画素の場合）

    8×8画素×64×64パターン×2ページ。BG実画面を1ページのみ使用する場合は、ページ0ではなくページ1を使うとパターン領域を拡張できる（下記パターンの項目参照）。

スプライト画面

• 表示画面

  • 512×512画素

    16×16画素16色×128スプライトプレーン

  • 256×256画素

    16×16画素16色×128スプライトプレーン

• 実画面（仮想座標系）

  • 1024x1024ドット

  表示画面の左上隅(0,0)は、sp_set()では実画面(16,16)の位置、sp_move()では実画面(0,0)の位置。

パターン定義

• BG実画面2枚の場合

  8×8画素×最大256個、16×16画素×最大128個

• BG実画面1枚の場合

  8×8画素×最大256個、16×16画素×最大192個

• BG実画面0枚の場合

  8×8画素×最大256個、16×16画素×最大256個

16×16画素パターン1つの領域に8×8画素パターン4つを定義できる（ただしパターン総数は256個まで）。16×16画素パターンのパターンコードNは、8×8画素パターンのパターンコード4N～4N＋3の領域と重なっている。