描画ユニット系コア for WinDX8 CDrawUnit_WinDX8 Reference

Document generated at 2003/10/26 23:33:16

書式 
CDrawUnit_WinDX8* CreateDrawUnit_WinDX8()
引数 
なし
戻り値 
CDrawUnit_WinDX8 オブジェクトへのポインタ
解説 
CDrawUnit_WinDX8 オブジェクトへのポインタを返します。
既に構築されたオブジェクトが存在する場合は、新規に
オブジェクトは作成されず、既存のオブジェクトへのポインタが
返ります。
 
 
書式 
void DeleteDrawUnit_WinDX8()
引数 
なし
戻り値 
なし
解説 
すでに構築されている CDrawUnit_WinDX8 オブジェクトを破棄します。
構築されていない状態で呼ばれても安全です。
 
 
書式 
CDrawUnit_WinDX8()
引数 
なし
戻り値 
なし
解説 
コンストラクタ
 
 
書式 
~CDrawUnit_WinDX8()
引数 
なし
戻り値 
なし
解説 
デストラクタ
 
 
書式 
BOOL SetDefault()
引数 
なし
戻り値 
成功：TRUE
失敗：FALSE
解説 
コンストラクタレベルでの初期値設定
 
 
書式 
BOOL Initialize(  SDUDeviceInfo* pDeviceInfo
                , long  lSizeX , long lSizeY
                , BOOL  bFullScreen , DWORD dwRefreshRate )
引数 
SDUDeviceInfo* pDeviceInfo  DrawUnitのデバイス情報構造体へのポインタ
long  lSizeX                画面幅(pixel)
long  lSizeY                画面高さ(pixel)
BOOL  bFullScreen           フルスクリーンにするか否か
DWORD dwRefreshRate         リフレッシュレート(Hz)
戻り値 
成功：TRUE
失敗：FALSE
解説 
オブジェクトを初期化し、画面を初期化し、描画可能な状態にします。
 
 
書式 
BOOL Initialize()
引数 
なし
戻り値 
なし
解説 
デバイス以外の情報を初期化します。
 
 
書式 
void Release()
引数 
なし
戻り値 
なし
解説 
オブジェクトの内容を破棄し、初期状態に戻します。
 
 
書式 
DWORD GetRefreshRate()
引数 
なし
戻り値 
画面のリフレッシュレート。
不明のときは 0。
解説 
画面の初期化関数で設定されたリフレッシュレートを返します。
リフレッシュレートの設定に失敗した場合は 0 を返します。
 
 
書式 
BOOL IsFullScreen()
引数 
なし
戻り値 
        フルスクリーン：TRUE
フルスクリーンではない：FALSE
解説 
現在の画面モードを返します。
フルスクリーンの場合に TRUE を返します。
この関数は、DirectX7 インターフェイス用にのみ実装されて
います。
DirectX8 インターフェイス用には、空の関数のみが定義されて
います。
 
 
書式 
BOOL ClearScreen()
引数 
なし
戻り値 
なし
解説 
現在表示中の画面をクリアします。
この関数は、DirectX7 インターフェイス向けのもののみ
実装済みです。
DirectX8 インターフェイスでは、空の関数のみが定義されています。
 
 
書式 
BOOL SaveScreenShot( const char* pFileName )
引数 
const char* pFileName       ファイル名へのポインタ
戻り値 
成功：TRUE
失敗：FALSE
解説 
画面のスクリーンショットをとります。
 
 
書式 
long AddBitmapIdent(
          const char* pFName
        , cosnt char* pIdent
        , DWORD dwColorKey = 0x00000000 )
引数 
const char* pFileName       ファイル名へのポインタ
const char* pIdent          画像につける名前
DWORD       dwColorKey      カラーキー指定(ARGB)
戻り値 
追加されたビットマップのインデックス番号。
エラーのときは -1。
解説 
ビットマップを追加します。
 
 
書式 
long AddBitmap(
          const char* pFName
        , DWORD dwColorKey = 0x00000000 )
引数 
const char* pFileName       ファイル名へのポインタ
DWORD       dwColorKey      カラーキー指定(ARGB)
戻り値 
追加されたビットマップのインデックス番号。
エラーのときは -1。
解説 
ビットマップを追加します。
 
 
書式 
long GetBitmapIndex( const char* pIdent )
引数 
const char* pIdent          ビットマップ画像につけられた名前
戻り値 
成功：ビットマップのインデックス番号
失敗：-1
解説 
pIdent で識別されるビットマップのインデックス番号を返します。
 
 
書式 
long GetBitmapCount()
引数 
なし
戻り値 
登録されているビットマップの数
エラーの場合は -1
解説 
登録されているビットマップの数を返します。
 
 
書式 
long AddSpriteIdent(
          const char* pBMPIdent
        , long lX1 , long lY1
        , long lX2 , long lY2
        , long lXo , long lYo
        , long* pPageOnBMP )
引数 
const char* pBMPIdent       ビットマップ画像の識別子
long        lX1             矩形の左上Ｘ座標
long        lY1             矩形の左上Ｙ座標
long        lX2             矩形の右下Ｘ座標
long        lY2             矩形の右下Ｙ座標
long        lXo             スプライトの中心点Ｘ座標
long        lYo             スプライトの中心点Ｙ座標
long*       pPageOnBMP      ビットマップ上でのインデックス番号を
                            受け取るためのポインタ。
                            NULLの場合は無視される。
戻り値 
成功：スプライトの通しインデックス番号
失敗：-1
解説 
ビットマップに対して矩形を指定し、その領域をスプライトとして
定義します。
スプライトは、(lXo,lYo)を中心として描画されます。また、
回転中心も(lXo,lYo)になります。
戻り値として、登録されたスプライトのインデックス番号が
返りますが、pPageOnBMP に NULL 以外の値を与えると
ビットマップごとのインデックス番号を取得することができます。
 
 
書式 
long AddSprite(
          long lBMPIndex
        , long lX1 , long lY1
        , long lX2 , long lY2
        , long lXo , long lYo
        , long* pPageOnBMP )
引数 
long        lBMPIndex       ビットマップ画像のインデックス番号
long        lX1             矩形の左上Ｘ座標
long        lY1             矩形の左上Ｙ座標
long        lX2             矩形の右下Ｘ座標
long        lY2             矩形の右下Ｙ座標
long        lXo             スプライトの中心点Ｘ座標
long        lYo             スプライトの中心点Ｙ座標
long*       pPageOnBMP      ビットマップ上でのインデックス番号を
                            受け取るためのポインタ。
                            NULLの場合は無視される。
戻り値 
成功：スプライトの通しインデックス番号
失敗：-1
解説 
ビットマップに対して矩形を指定し、その領域をスプライトとして
定義します。
スプライトは、(lXo,lYo)を中心として描画されます。また、
回転中心も(lXo,lYo)になります。
戻り値として、登録されたスプライトのインデックス番号が
返りますが、pPageOnBMP に NULL 以外の値を与えると
ビットマップごとのインデックス番号を取得することができます。
 
 
書式 
void DrawSprite(
          long lLayer , long lIndex , long lX , long lY
        , float fRotation=0.0f
        , DWORD dwDiffuse = 0xFFFFFFFF )
引数 
long  lLayer                描画先レイヤー番号
long  lIndex                スプライトのインデックス番号
long  lX                    描画先Ｘ座標
long  lY                    描画先Ｙ座標
float fRotation             回転角度（ラジアン）
DWORD dwDiffuse             ディフューズ色（ARGB）
戻り値 
なし
解説 
スプライトの描画をキューイングします。
この関数を実行しても、すぐには画面に描画されません。
DrawLayers() を実行したときに、はじめてVRAMに画像が転送され、
Flip() が実行されたときに、画面上に表示されます。
 
 
書式 
void DrawSprite( CGDrawPack* pDrawPack )
引数 
CGDrawPack* pDrawPack       描画情報パッケージへのポインタ
戻り値 
なし
解説 
スプライトの描画をキューイングします。
この関数を実行しても、すぐには画面に描画されません。
DrawLayers() を実行したときに、はじめてVRAMに画像が転送され、
Flip() が実行されたときに、画面上に表示されます。
 
 
書式 
 long GetSpriteCount( long lBitmapIndex=-1 )
引数 
long lBitmapIndex           ビットマップのインデックス番号
戻り値 
登録されているスプライトの数
解説 
登録されているスプライトの数を返します。
lBitmapIndex に値を指定した場合は、ビットマップに対して登録
されている数を返します。
指定しなかった場合は、ビットマップに関係なく、全体で登録された
数を返します。
 
 
書式 
long AddGraphicIdent(
          const char* pBMPIdent
        , long lLocateX , long lLocateY
        , long lSizeX , long lSizeY
        , long* pIndexOnBMP = NULL )
引数 
const char* pBMPIdent       ビットマップ画像の識別子
long lLocateX               画面上でのＧＲＰウィンドウ左上位置Ｘ座標
long lLocateY               画面上でのＧＲＰウィンドウ左上位置Ｙ座標
long lSizeX                 ＧＲＰウィンドウのＸサイズ
long lSizeY                 ＧＲＰウィンドウのＹサイズ
long* pIndexOnBMP           ビットマップ上でのＧＲＰのインデックス番号
戻り値 
成功：グラフィック画面のインデックス番号
失敗：-1
解説 
グラフィック画面を新規に追加します。
pBMPIdent で識別されるビットマップ画像を用いたグラフィック画面を
画面上(lLocateX,lLocateY)の位置に表示します。
ウィンドウサイズは(lSizeX,lSizeY)になります。
返り値のインデックス番号は、グラフィック画面の通しインデックスに
なります。
pIndexOnBMP に格納先のポインタを与えると、指定ビットマップ上での
インデックス番号を取得することができます。
 
 
書式 
long AddGraphic(
          long lBMPIndex
        , long lLocateX , long lLocateY
        , long lSizeX , long lSizeY
        , long* pIndexOnBMP = 0 )
引数 
long lBMPIndex              ビットマップ画像のインデックス番号
long lLocateX               画面上でのＧＲＰウィンドウ左上位置Ｘ座標
long lLocateY               画面上でのＧＲＰウィンドウ左上位置Ｙ座標
long lSizeX                 ＧＲＰウィンドウのＸサイズ
long lSizeY                 ＧＲＰウィンドウのＹサイズ
long* pIndexOnBMP           ビットマップ上でのＧＲＰのインデックス番号
戻り値 
成功：グラフィック画面のインデックス番号
失敗：-1
解説 
グラフィック画面を新規に追加します。
pBMPIndex で識別されるビットマップ画像を用いたグラフィック画面を
画面上(lLocateX,lLocateY)の位置に表示します。
ウィンドウサイズは(lSizeX,lSizeY)になります。
返り値のインデックス番号は、グラフィック画面の通しインデックスに
なります。
pIndexOnBMP に格納先のポインタを与えると、指定ビットマップ上での
インデックス番号を取得することができます。
 
 
書式 
BOOL SetGraphicView( long lGRPIndex , RECT& rRect )
引数 
long  lGRPIndex             グラフィック画面の通しインデックス番号
RECT& rRect                 グラフィック画面のビューウィンドウ矩形
戻り値 
成功：TRUE
失敗：FALSE
解説 
仮想グラフィック画面のビューウィンドウ領域を指定します。
 
 
書式 
BOOL SetLoopMode( long lGRPIndex , BOOL bLoopX , BOOL bLoopY )
引数 
long lGRPIndex              グラフィック画面の通しインデックス番号
BOOL bLoopX                 Ｘ方向ループマッピングモード
BOOL bLoopY                 Ｙ方向ループマッピングモード
戻り値 
成功：TRUE
失敗：FALSE
解説 
仮想グラフィック画面のループマッピングモードを設定します。
指定した軸方向に対して、球座標系を仕様するようになります。
（未実装）
 
 
書式 
BOOL GetLoopModeX( long lGRPIndex )
引数 
long lGRPIndex              グラフィック画面の通しインデックス番号
戻り値 
成功：TRUE
失敗：FALSE
解説 
仮想グラフィック画面のループマッピングモードを取得します。
（未実装）
 
 
書式 
BOOL GetLoopModeY( long lGRPIndex )
引数 
long lGRPIndex              グラフィック画面の通しインデックス番号
戻り値 
成功：TRUE
失敗：FALSE
解説 
仮想グラフィック画面のループマッピングモードを取得します。
（未実装）
 
 
書式 
void DrawGraphic(     long lLayer
                    , long lGRPIndex
                    , long lX , long lY
                    , DWORD dwDiffuse = 0xFFFFFFFF )
引数 
long  lLayer                レイヤー番号
long  lGRPIndex             仮想グラフィック画面の通しインデックス番号
long  lX                    ビューポイントのＸ座標
long  lY                    ビューポイントのＹ座標
DWORD dwDiffuse             ディフューズ色（ARGB）
戻り値 
なし
解説 
仮想グラフィック画面の描画をキューイングします。
この関数を実行しても、すぐには画面に描画されません。
DrawLayers() を実行したときに、はじめてVRAMに画像が転送され、
Flip() が実行されたときに、画面上に表示されます。
 
 
書式 
void DrawGraphic( CGDrawPack* pDrawPack )
引数 
CGDrawPack* pDrawPack       描画情報パッケージへのポインタ
戻り値 
なし
解説 
仮想グラフィック画面の描画をキューイングします。
この関数を実行しても、すぐには画面に描画されません。
DrawLayers() を実行したときに、はじめてVRAMに画像が転送され、
Flip() が実行されたときに、画面上に表示されます。
 
 
書式 
long GetGraphicCount( long lBitmapIndex=-1 )
引数 
long lBitmapIndex           ビットマップのインデックス番号
戻り値 
登録されているグラフィック画面の数
解説 
登録されているグラフィック画面の数を返します。
lBitmapIndex に値を指定した場合は、ビットマップに対しての
登録数を返します。
指定しなかった場合は、ビットマップに関係なく、全体で登録された
数を返します。
 
 
書式 
BOOL EasyPalette( const char* pFileName )
引数 
const char* pFileName       パレットファイル名(*.rq)へのポインタ
戻り値 
成功：TRUE
失敗：FALSE
    ※この関数はダミー関数なので、常に TRUE を返します。
解説 
互換性を保つためのダミー関数です。
本来は 256色の画面モードにおいて、パレットを画面に反映する
ための関数ですが、DirectX8 では 256色 モードをサポートしません。
この関数は、常に TRUE を返し、実際には何の処理も行いません。
 
 
書式 
BOOL SetLayers( long lLayers )
引数 
long lLayers                レイヤー数
戻り値 
成功：TRUE
失敗：FALSE
解説 
使用するレイヤー数を指定します。
キューイングされているデータは解放されます。
 
 
書式 
long AddDrawPack( CGDrawPack* pDrawPack )
引数 
CGDrawPack* pDrawPack       描画情報パッケージへのポインタ
戻り値 
成功：登録されたパッケージのインデックス番号
失敗：-1
解説 
描画情報パッケージをキューイングします。
 
 
書式 
void ResetDrawPack()
引数 
なし
戻り値 
なし
解説 
現在キューイングされている描画情報パッケージを全て解放します。
 
 
書式 
BOOL DrawLayers()
引数 
なし
戻り値 
成功：TRUE
失敗：FALSE
解説 
キューイングされた描画情報パッケージを描画します。
 
 
書式 
BOOL Flip()
引数 
なし
戻り値 
成功：TRUE
失敗：FALSE
解説 
画面をフリップします。
 
 
書式 
BOOL DrawDrawPack( CGDrawPack* pDrawPack )
引数 
CGDrawaPack* pDrawPack      描画情報パッケージへのポインタ
戻り値 
成功：TRUE
失敗：FALSE
解説 
描画情報パッケージの内容を描画します。
この関数では、レイヤー情報は参照されません。この関数の
呼び出しもとで管理されることを前提としています。
 
 
書式 
BOOL DrawSpritePack( CGDrawPack* pDrawPack )
引数 
CGDrawPack* pDrawPack       描画パッケージへのポインタ
戻り値 
成功：TRUE
失敗：FALSE
解説 
スプライトの描画情報パッケージの内容に沿って描画を実行します。
 
 
書式 
BOOL DrawGraphicPack( CGDrawPack* pDrawPack )
引数 
CGDrawPack* pDrawPack       描画情報パッケージへのポインタ
戻り値 
成功：TRUE
失敗：FALSE
解説 
グラフィックの描画情報パッケージの内容に沿って描画を実行します。

BACK