F3DEX2_PosLight … 点光源をサポートした F3DEX2

本マイクロコードは F3DEX2-2.08 を元に作成されており、F3DEX2 用のディス プレイリストのソースはそのまま使用できます。ただし点光源を使う場合、従 来の平行光源用のものに関しても、ライト構造体のデータの作成方法が若干異 なります。

本マイクロコードでは、ライトのタイプに「点光源」か、従来通りの「平行光 源」のどちらかを選ぶことができます。従来通り、使えるアンビエントライト は 1 つ、ディフューズライトは 7 つまでで、ディフューズライトの内訳として、 点光源なのか平行光源なのか個別に指定可能です。ただし、点光源は平行光源 よりも RSP の処理に時間がかかります。頂点の数にも比例して時間がかかり ます。

点光源の光線方向は全方向です。スポットライトではありません。工夫次第で、 上の画面例のようにスペキュラハイライトのような効果を出すことが可能です。

ジオメトリモードに G_LIGHTING_POSITIONAL が追加されています。これはジ オメトリモード G_LIGHTING が指定されている場合にのみ参照されます。 どちらも、マイクロコード起動時にはクリアされています。

点光源のライトデータを RSP へロードする方法は、従来と同じように g*SPSetLights# などを使うことができます。このときロードする構造体は Lights# ではなく PosLights# になります。

PosLights# 構造体は Lights# 構造体を改造したものです。どちらの構造体も 同じバイト数ですが、構成が異なります。色指定に関する部分だけは互換性が あります。ライティング処理は従来同様 g*SPVertex 処理時に行われます。

静的な PosLights# 構造体を定義するためのマクロ gdSPDefPosLights# が用 意されています。これは静的な Lights# 構造体を定義するマクロ gdSPDefLights# に対応するものです。

本マイクロコードは F3DEX2-2.08 に機能を追加したものです。ライトに関す るもの以外のディスプレイリストは F3DEX2 の決まりに従って作成してくださ い。

ディスプレイリストに関わるソースでインクルードされているはずの N64 OS 付属 <PR/gbi.h> に続いて、専用 GBI ファイル gbi-poslight.h を追加インクルードしてください。

<PR/gbi.h> は <ultra64.h> からインクルードされています。 つまり

#include <ultra64.h>

#include <ultra64.h>
#include "gbi-poslight.h"

次に、spec ファイルで

	include "/usr/lib/PR/gspF3DEX2.fifo.o"

	include "gspF3DEX2_PosLight.fifo.o"

  OSTask task;
  extern u64 gspF3DEX2_PosLight_fifoTextStart[],
             gspF3DEX2_PosLight_fifoDataStart[];
  task.t.ucode =      gspF3DEX2_PosLight_fifoTextStart;
  task.t.ucode_data = gspF3DEX2_PosLight_fifoDataStart;

なお、ゲームに特化したマイクロコードの場合 extern 宣言は

/* Zelda - F3DZEX2, F3DZEX2.NoN, L3DZEX2 */
extern u64 gspF3DZEX2_PosLight_fifoTextStart[],
           gspF3DZEX2_PosLight_fifoTextEnd[];
extern u64 gspF3DZEX2_PosLight_fifoDataStart[],
           gspF3DZEX2_PosLight_fifoDataEnd[];
extern u64 gspF3DZEX2_PosLight_xbusTextStart[],
           gspF3DZEX2_PosLight_xbusTextEnd[];
extern u64 gspF3DZEX2_PosLight_xbusDataStart[],
           gspF3DZEX2_PosLight_xbusDataEnd[];

extern u64 gspF3DZEX2_NoN_PosLight_fifoTextStart[],
           gspF3DZEX2_NoN_PosLight_fifoTextEnd[];
extern u64 gspF3DZEX2_NoN_PosLight_fifoDataStart[],
           gspF3DZEX2_NoN_PosLight_fifoDataEnd[];
extern u64 gspF3DZEX2_NoN_PosLight_xbusTextStart[],
           gspF3DZEX2_NoN_PosLight_xbusTextEnd[];
extern u64 gspF3DZEX2_NoN_PosLight_xbusDataStart[],
           gspF3DZEX2_NoN_PosLight_xbusDataEnd[];

extern u64 gspL3DZEX2_PosLight_fifoTextStart[],
           gspL3DZEX2_PosLight_fifoTextEnd[];
extern u64 gspL3DZEX2_PosLight_fifoDataStart[],
           gspL3DZEX2_PosLight_fifoDataEnd[];
extern u64 gspL3DZEX2_PosLight_xbusTextStart[],
           gspL3DZEX2_PosLight_xbusTextEnd[];
extern u64 gspL3DZEX2_PosLight_xbusDataStart[],
           gspL3DZEX2_PosLight_xbusDataEnd[];

/* Mario Paint/Artist - F3DPEX2, F3DPEX2.NoN, F3DPEX2.Rej,
 * F3DPLX2.Rej, L3DPEX2 */
extern u64 gspF3DPEX2_PosLight_fifoTextStart[],
           gspF3DPEX2_PosLight_fifoTextEnd[];
extern u64 gspF3DPEX2_PosLight_fifoDataStart[],
           gspF3DPEX2_PosLight_fifoDataEnd[];
extern u64 gspF3DPEX2_PosLight_xbusTextStart[],
           gspF3DPEX2_PosLight_xbusTextEnd[];
extern u64 gspF3DPEX2_PosLight_xbusDataStart[],
           gspF3DPEX2_PosLight_xbusDataEnd[];
extern u64 gspF3DPEX2_NoN_PosLight_fifoTextStart[],
           gspF3DPEX2_NoN_PosLight_fifoTextEnd[];
extern u64 gspF3DPEX2_NoN_PosLight_fifoDataStart[],
           gspF3DPEX2_NoN_PosLight_fifoDataEnd[];
extern u64 gspF3DPEX2_NoN_PosLight_xbusTextStart[],
           gspF3DPEX2_NoN_PosLight_xbusTextEnd[];
extern u64 gspF3DPEX2_NoN_PosLight_xbusDataStart[],
           gspF3DPEX2_NoN_PosLight_xbusDataEnd[];
extern u64 gspF3DPEX2_Rej_PosLight_fifoTextStart[],
           gspF3DPEX2_Rej_PosLight_fifoTextEnd[];
extern u64 gspF3DPEX2_Rej_PosLight_fifoDataStart[],
           gspF3DPEX2_Rej_PosLight_fifoDataEnd[];
extern u64 gspF3DPEX2_Rej_PosLight_xbusTextStart[],
           gspF3DPEX2_Rej_PosLight_xbusTextEnd[];
extern u64 gspF3DPEX2_Rej_PosLight_xbusDataStart[],
           gspF3DPEX2_Rej_PosLight_xbusDataEnd[];
extern u64 gspF3DPLX2_Rej_PosLight_fifoTextStart[],
           gspF3DPLX2_Rej_PosLight_fifoTextEnd[];
extern u64 gspF3DPLX2_Rej_PosLight_fifoDataStart[],
           gspF3DPLX2_Rej_PosLight_fifoDataEnd[];
extern u64 gspF3DPLX2_Rej_PosLight_xbusTextStart[],
           gspF3DPLX2_Rej_PosLight_xbusTextEnd[];
extern u64 gspF3DPLX2_Rej_PosLight_xbusDataStart[],
           gspF3DPLX2_Rej_PosLight_xbusDataEnd[];
extern u64 gspL3DPEX2_PosLight_fifoTextStart[],
           gspL3DPEX2_PosLight_fifoTextEnd[];
extern u64 gspL3DPEX2_PosLight_fifoDataStart[],
           gspL3DPEX2_PosLight_fifoDataEnd[];
extern u64 gspL3DPEX2_PosLight_xbusTextStart[],
           gspL3DPEX2_PosLight_xbusTextEnd[];
extern u64 gspL3DPEX2_PosLight_xbusDataStart[],
           gspL3DPEX2_PosLight_xbusDataEnd[];

F3DEX2_PosLight には FIFO 版と XBUS 版があります。

点光源を一回も使わない場合、本マイクロコードの動作は F3DEX2 と完全に 一致します。

ジオメトリモード G_LIGHTING_POSITIONAL はマイクロコード起動時にはクリ アされていますが、アプリケーションの都合などで、万が一 G_LIGHTING_POSITIONAL と同じ値を g*SPSetGeometryMode でセットしている 場合、(G_LIGHTING かつ G_LIGHTING_POSITIONAL) の条件が成立すると点光源 処理が始まってしまいます。 G_LIGHTING_POSITIONAL がクリアされている ことを確認してください。

そして、点光源を一回も使わない場合、(本マイクロコードも不要ですが…)平 行光源の使用に関わらず、以降の文章はすべて無視してください。

点光源を使ったり、点光源と平行光源を混在させたり、またそれらを切り替え て使用するときについて説明します。

シーンで使用するライトがすべて平行光源の場合、ジオメトリモード G_LIGHTING_POSITIONAL さえクリアされていれば、g*SPVertex 処理時にすべ てのライトを平行光源として処理します。あとは F3DEX2 と同様に使用できます。 もちろん、ジオメトリモード G_LIGHTING はセットされている必要があります。

パフォーマンス向上のためにも、ライトがすべて平行光源の場合は確実に G_LIGHTING_POSITIONAL をクリアしておくことをおすすめします。 G_LIGHTING_POSITIONAL がセットされていると、平行光源の処理も若干遅くな ります。

一つでも点光源が含まれる場合、g*SPVertex を処理する前にジオメトリモー ド G_LIGHTING_POSITIONAL と G_LIGHTING をセットしてください。それぞれ のライトが「点光源なのか、平行光源なのか」は、ライトデータのメンバ自身に 個別に設定できます。

点光源の場合、PosLight (PosLights# ではありません) 構造体のメンバ kc を 0 以外にします。

平行光源の場合、Light (Lights# ではありません) 構造体のメンバ pad1 を 0 にします。

PosLight 構造体のメンバ kc と Light 構造体のメンバ pad1 のバイトオフセッ トは同じです。RSP では、このバイトオフセットにあるバイトデータが 0 か どうかによって「点光源なのか、平行光源なのか」を g*SPVertex 処理の度に 決定します。

静的な点光源、平行光源を混在させたライトデータを定義するマクロは、バリ エーションが多いので全部は用意していません。

ライトデータは「アンビエント(+ディフューズ...)」で構成されます。そこで 「アンビエント」「ディフューズ(点光源)」「ディフューズ(平行光源)」を分 けて定義できるマクロが gbi-poslight.h に用意されています。以下の例や <PR/gbi.h> も参考にしてください。

/* 点光源 4 つからなる 静的ライトデータの定義
 * (メンバを書き換えるのでダブルバッファ) */
static PosLights4 test_poslight[2] = {
  gdSPDefPosLights4(0,0,0,
		    255,255,255, 1500,3000,500, 8,16,0,
		    255,000,000,    0,   0,  0, 8,16,0,
		    000,255,000, -500, 500,100, 8,16,0,
		    000,000,255,    0,-100,100, 8,16,0),

  gdSPDefPosLights4(0,0,0,
		    255,255,255, 1500,3000,500, 8,16,0,
		    255,000,000,    0,   0,  0, 8,16,0,
		    000,255,000, -500, 500,100, 8,16,0,
		    000,000,255,    0,-100,100, 8,16,0),
};

/* 点光源 3 つと平行光源 1 つからなる 静的ライトデータの定義
 * (ダブルバッファ) */
static PosLights4 test_poslight[2] = {
  { _gdSPDefAmbient(0,0,0),
    { _gdSPDefPosLight(255,255,255, 1500,3000,500, 8,16,0),
      _gdSPDefPosLight(255,000,000,    0,   0,  0, 8,16,0),
      _gdSPDefPosLight(000,255,000, -500, 500,100, 8,16,0),
      _gdSPDefInfLight(128,128,000,0,0,127)}},

  { _gdSPDefAmbient(0,0,0),
    { _gdSPDefPosLight(255,255,255, 1500,3000,500, 8,16,0),
      _gdSPDefPosLight(255,000,000,    0,   0,  0, 8,16,0),
      _gdSPDefPosLight(000,255,000, -500, 500,100, 8,16,0),
      _gdSPDefInfLight(128,128,000,0,0,127)}},
};
(データの内容と画面表示は多少異なります)

これらライトデータを RSP へロードするには gsSPSetLights4(test_poslight[dynamic_switch]) などとします。

_gdSPDefInfLight マクロが、従来の Light 構造体を PosLight 構造体の フォーマットに変換しています。こうすることで静的ライトデータは すべて PosLight 構造体であるかのように定義できます。

PosLight 構造体は gbi-poslight.h で以下のように定義されています。

typedef struct {
  unsigned char col[3];         /* diffuse light value (rgba) */
  unsigned char kc;             /* positional lighting enable flag & constant attenuation Kc */
  unsigned char colc[3];        /* copy of diffuse light value (rgba) */
  unsigned char kl;             /* linear attenuation Kl */
  short pos[3];                 /* light position x, y, z */
  unsigned char kq;             /* quadratic attenuation Kq */
  char reserved1;
} PosLight_t;

typedef union {
  PosLight_t p;
  Light_t    l;
  long long int force_structure_alignment[2];
} PosLight;

メンバ l.** は従来の平行光源を定義するときに使いますが、l.pad1 のみ必 ず 0 にしてください。付属マクロで静的に定義する場合は自動的にそうなり ます。

メンバ p.** が点光源を定義するときに使うものです。col, colc は光源の色 (R,G,B)を0 から 255 の範囲で入れます。従来と同様に、col, colc には同じ 色を入れるのが普通です。

ライトの色だけを直接変更する g*SPLightCol マクロは、従来は Alpha に該 当する部分には何を入れても問題ありませんでしたが、実際には l.pad1(もし くは p.kc) および l.pad2(もしくは p.kq) に同じ値を入れています。平行光 源のライト色変更なら Alpha 部分を 0 にしておけば問題ありませんが、点光 源のライト色の直接変更には問題があります。

そのため _g*SPLightColor2 マクロを用意しました。 このマクロの引数 col1, col2 の Alpha 部分を使って p.kc と p.kl の代入が 可能です。

その他のメンバ (p.kc, p.kl, p.kq) は次項で説明します。

点光源は、光源から頂点への距離が遠くなるほど暗くすることができます。 元の明るさを 1.0 として、それに減衰係数をかけることで暗くします。

減衰係数は通常 1.0 までの数で、光源と頂点との距離が遠いほど小さくなり、 0.0 に近づきます(暗くなります)。

ここで使用している減衰係数の算出式を、概念的に示すと以下のようになりま す。

  減衰係数 = 1.0/(Kc + Kl*D + Kq*D*D)

  Kc: 定数 (0.5 から約 16.5 まで)
  Kl: 一次定数 (0.0 から 約 0.5 まで)
  Kq: 二次定数 (0.0 から 約 0.000488 まで)
  D: 光源と、モデルビュー行列で変換された頂点との距離 (ワールド座標系)

概念的には OpenGL での減衰係数と同じですが、「距離 1.0」は ここでは「ワールド座標系での距離 65536」として扱っています。

その他、実装上の都合で Kc, Kl, Kq を 1 バイトに収めているため、値の範 囲が OpenGL のものよりもかなり小さいように見えますが、それなりに動作す るように調整したつもりです。(ご意見をお待ちしております)

PosLight 構造体のメンバ p.kc には (Kc - 0.5) を 4.4bit (整数部 4bit, 小数部 4bit の固定小数)に変換して unsigned char 型で与えます。

処理の都合上、Kc は 0.5 が最低値ですので、Kc を 1.0 にするためにはメン バ p.kc に 8 を与えます。Kc を 2.0 にするためには p.kc に (16+8) を与 えます。

Kc は基本的に 1.0 (p.kc=8)以上にします。それより小さいと、減衰係数が 1.0 を越えてしまい減衰計算がオーバーフローする場合がありますのでご注意 下さい。また p.kc は点光源フラグを兼ねていますので、平行光源として処理 しないよう 0 以外の値を入れてください。

Kl は距離の一乗にかかる係数です。p.kl に Kl*512 を unsigned char 型に 変換して与えます。p.kl は 0 から 255 までの値が使用可能です。

Kq は距離の二乗にかかる係数です。処理の都合上 (D*0x10)*(D*0x10) の上位 16bit を取り出しますので、D が 16 未満の場合 Kq*D*D は切り捨てられます。 p.kq には Kq*(8*65536) を unsigned char 型に変換して与えます。p.kq は0 から 255 までの値が使用可能です。

p.kc=8, p.kl=0, p.kq=0 とすれば、減衰係数=1.0、つまり距離による減衰は なくなります。そして各頂点の法線ベクトルと、点光源から頂点への光線ベク トルの角度(の内積)だけに応じて明るさが変わるようになります。

光源のワールド座標系における座標(x,y,z)を p.pos[0], p.pos[1], p.pos[2] に設定します。座標の範囲は -32768 .. +32767 ですが、頂点との距離を計算 するときに (p.pos[0]-頂点x) (y,z も同様) が 32767 を越えるとオーバーフ ローしますのでご注意下さい。

勝手で申し訳ございませんが、こちらでは全マイクロコードの、全機能の十分 な動作確認をしているわけではありません。何かございましたら川瀬までお知 らせ下さい。