IDirect3DDevice9

IDirect3DDevice9 (d3d9.h) アプリケーションは、IDirect3DDevice9 インターフェースのメソッドを使用して、DrawPrimitive ベースのレンダリングとリソースの作成を行います。

IDirect3DDevice9 インターフェースは、IDirect3D9::CreateDevice メソッドを呼び出して取得します。

このインターフェースは、すべての COM インターフェースと同様に、IUnknown インターフェースのメソッドを継承します。

LPDIRECT3DDEVICE9 型と PDIRECT3DDEVICE9 型は、IDirect3DDevice9 インターフェースへのポインターとして定義されています。

typedef struct IDirect3DDevice9 *LPDIRECT3DDEVICE9, *PDIRECT3DDEVICE9;

IDirect3DDevice9::TestCooperativeLevel メソッド (d3d9.h) は、ウィンドウモードまたはフルスクリーンのアプリケーションにおける Direct3D デバイスの現在の協調レベルの状態を報告します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK であり、デバイスが動作可能で呼び出し元のアプリケーションが処理を継続できることを示します。 メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_DEVICELOST、D3DERR_DEVICENOTRESET、D3DERR_DRIVERINTERNALERROR。

デバイスがロストしており、現時点では復元できない場合、IDirect3DDevice9::TestCooperativeLevel は戻り値 D3DERR_DEVICELOST を返します。たとえば、フルスクリーンのデバイスがフォーカスを失った場合がこれに該当します。アプリケーションがデバイスのロストを検出した場合は、処理を一時停止し、戻り値 D3DERR_DEVICENOTRESET が返されるまで IDirect3DDevice9::TestCooperativeLevel を定期的に呼び出してください。その後、IDirect3DDevice9::Reset を呼び出してデバイスのリセットを試み、成功した場合は必要なリソースを復元して通常の動作を再開できます。なお、デバイスが「ロスト」または「未リセット」のいずれかの状態にある場合、IDirect3DDevice9::Present は D3DERR_DEVICELOST を返します。

IDirect3DDevice9::TestCooperativeLevel の呼び出しは、リセット対象のデバイスを作成したスレッドとは異なるスレッドから行われた場合に失敗します。

IDirect3DDevice9::GetAvailableTextureMem メソッド (d3d9.h) は、利用可能なテクスチャーメモリ量の推定値を返します。

型: UINT

この関数は、利用可能なテクスチャーメモリの推定値を返します。

返される値は最も近い MB 単位に丸められます。これは、アライメントやリソースごとの消費量に影響するその他の要因により、ビデオメモリの推定値が決して正確にはならないという事実を反映するためです。アプリケーションはこの値を使用して、ミップマップを何レベル分まで割り当てるかといった大規模なリソースの判断のためにメモリの空き状況を大まかに見積もることはできますが、別のリソースを割り当てるだけのメモリが残っているかといった小規模な判断にこの値を使用することはできません。

IDirect3DDevice9::EvictManagedResources メソッド (d3d9.h) は、Direct3D が管理するリソースとドライバーが管理するリソースの両方を含む、すべてのマネージドリソースを破棄します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_OUTOFVIDEOMEMORY、D3DERR_COMMAND_UNPARSED のいずれかになります。

この関数が破棄するのは、リソースの D3DPOOL_DEFAULT のコピーだけです。システムメモリ上のリソースのコピーは保持されます。D3DPOOL を参照してください。

IDirect3DDevice9::GetDirect3D メソッド (d3d9.h) は、このデバイスを作成した Direct3D オブジェクトのインスタンスへのインターフェースを返します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

IDirect3DDevice9::GetDirect3D を呼び出すと、IDirect3D9 インターフェースの内部参照カウントが増加します。この IDirect3D9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::GetDeviceCaps メソッド (d3d9.h) は、レンダリングデバイスの機能を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

デバイスがソフトウェア頂点処理モードで使用されている場合、IDirect3DDevice9::GetDeviceCaps はソフトウェア頂点パイプラインの機能を取得します。

IDirect3DDevice9::GetDisplayMode メソッド (d3d9.h) は、ディスプレイモードの空間解像度、色解像度、およびリフレッシュレートを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

IDirect3DDevice9::GetCreationParameters メソッド (d3d9.h) は、デバイスの作成パラメーターを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。

引数が無効な場合は D3DERR_INVALIDCALL が返されます。

返された D3DDEVICE_CREATION_PARAMETERS 構造体の AdapterOrdinal メンバーに問い合わせることで、このデバイスが表すアダプターの序数を取得できます。

IDirect3DDevice9::SetCursorProperties メソッド (d3d9.h) は、カーソルのプロパティを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

次のいずれかの条件に該当する場合、オペレーティングシステムのカーソルが作成され使用されます。

• ハードウェアが D3DCURSORCAPS_COLOR (D3DCURSORCAPS を参照) を設定しており、カーソルのサイズが 32x32 (オペレーティングシステムにおけるカーソルサイズ) である場合。
• アプリケーションがウィンドウモードで実行されている場合。

アプリケーションでは常に WM_MOUSEMOVE イベントを捕捉し、DXSetCursorPosition を呼び出すことを推奨します。

Direct3D のカーソル関数は、ハードウェアに応じて GDI カーソルまたはソフトウェアエミュレーションのいずれかを使用します。通常、ユーザーは WM_SETCURSOR メッセージに応答したいと考えます。たとえば、次のようにメッセージハンドラーを記述します。

case WM_SETCURSOR:
// Turn off window cursor. 
SetCursor( NULL );
m_pd3dDevice->ShowCursor( TRUE );
return TRUE; // Prevent Windows from setting cursor to window class cursor.
break;

また、カーソルを変更したい場合は IDirect3DDevice9::SetCursorProperties メソッドを呼び出します。

アプリケーションは、D3DCAPS9 構造体の該当するメンバーを調べることで、カーソルに対してどのようなハードウェアサポートが利用できるかを判別できます。通常、ハードウェアは 32x32 のカーソルのみをサポートし、ウィンドウモードではシステムが 32x32 のカーソルのみをサポートする場合があります。この場合でも IDirect3DDevice9::SetCursorProperties は成功しますが、カーソルはそのサイズに縮小される可能性があります。ホットスポットも適切にスケーリングされます。

カーソルはデバイスがロストすると失われます。このメソッドは、デバイスのリセット後に呼び出す必要があります。

IDirect3DDevice9::SetCursorPosition メソッド (d3d9.h) は、カーソルの位置と更新オプションを設定します。

フルスクリーンモードで実行している場合、スクリーン空間座標は現在のディスプレイモードに合わせて適切にスケーリングされたバックバッファー座標になります。ウィンドウモードで実行している場合、スクリーン空間座標はデスクトップ座標になります。カーソルイメージは、指定された位置から SetCursorProperties メソッドで指定されたホットスポットのオフセットを減算した位置に描画されます。

ShowCursor によってカーソルが非表示にされている場合、カーソルは描画されません。

IDirect3DDevice9::ShowCursor メソッド (d3d9helper.h) は、カーソルを表示または非表示にします。

型: BOOL

直前までカーソルが表示されていたかどうかを示す値。直前までカーソルが表示されていた場合は TRUE、表示されていなかった場合は FALSE です。

Direct3D のカーソル関数は、ハードウェアに応じて GDI カーソルまたはソフトウェアエミュレーションのいずれかを使用します。通常、ユーザーは WM_SETCURSOR メッセージに応答したいと考えます。たとえば、次のようにメッセージハンドラーを記述します。

    
case WM_SETCURSOR:

// Turn off window cursor 
    
SetCursor( NULL );
    
m_pd3dDevice->ShowCursor( TRUE );
    
return TRUE; // prevent Windows from setting cursor to window class cursor
    
break;

また、カーソルを変更したい場合は IDirect3DDevice9::SetCursorProperties メソッドを呼び出します。詳細については、DirectX Graphics C/C++ サンプルのコードを参照してください。

IDirect3DDevice9::CreateAdditionalSwapChain メソッド (d3d9.h) は、複数のビューをレンダリングするための追加のスワップチェーンを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_NOTAVAILABLE、D3DERR_DEVICELOST、D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

Direct3D 9 ではスワップチェーンがデバイスのプロパティとして 1 つ存在するため、各デバイスには常に少なくとも 1 つのスワップチェーン (暗黙のスワップチェーン) があります。

なお、1 つのデバイスがサポートできるフルスクリーンのスワップチェーンは 1 つだけです。

IDirect3D9::CreateDevice、IDirect3DDevice9::Reset、および CreateAdditionalSwapChain を呼び出す際、ウィンドウモードのバックバッファーフォーマットには D3DFMT_UNKNOWN を指定できます。つまり、ウィンドウモードで CreateDevice を呼び出す前に、アプリケーションが現在のデスクトップのフォーマットを問い合わせる必要はありません。フルスクリーンモードの場合は、バックバッファーのフォーマットを指定する必要があります。

IDirect3DDevice9::GetSwapChain メソッド (d3d9.h) は、スワップチェーンへのポインターを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetNumberOfSwapChains メソッド (d3d9.h) は、暗黙のスワップチェーンの数を取得します。

型: UINT

暗黙のスワップチェーンの数。「解説」を参照してください。

暗黙のスワップチェーンは、IDirect3D9::CreateDevice の実行中にデバイスによって作成されます。このメソッドは、CreateDevice によって作成されたスワップチェーンの数を返します。

アプリケーションは、IDirect3DDevice9::CreateAdditionalSwapChain を使用して追加のスワップチェーンを作成できます。

IDirect3DDevice9::Reset メソッド (d3d9.h) は、スワップチェーンの種類、サイズ、およびフォーマットをリセットします。

型: HRESULT

返される可能性のある値: D3D_OK、D3DERR_DEVICELOST、D3DERR_DEVICEREMOVED、D3DERR_DRIVERINTERNALERROR、D3DERR_OUTOFVIDEOMEMORY (D3DERR を参照)。

IDirect3DDevice9::Reset の呼び出しが失敗すると、デバイスはすでに「未リセット」状態 (IDirect3DDevice9::TestCooperativeLevel の呼び出しが D3DERR_DEVICENOTRESET を返すことで示されます) でない限り、「ロスト」状態 (IDirect3DDevice9::TestCooperativeLevel の呼び出しが D3DERR_DEVICELOST を返すことで示されます) になります。ロストデバイスの文脈における IDirect3DDevice9::Reset の使用については、IDirect3DDevice9::TestCooperativeLevel および ロストデバイス (Direct3D 9) を参照してください。

IDirect3DDevice9::Reset を呼び出すと、すべてのテクスチャーメモリサーフェスが失われ、マネージドテクスチャーがビデオメモリからフラッシュされ、すべての状態情報が失われます。デバイスに対して IDirect3DDevice9::Reset メソッドを呼び出す前に、アプリケーションはそのデバイスに関連付けられた明示的なレンダーターゲット、深度ステンシルサーフェス、追加のスワップチェーン、ステートブロック、および D3DPOOL_DEFAULT のリソースをすべて解放しておく必要があります。

スワップチェーンにはフルスクリーンとウィンドウの 2 種類があります。新しいスワップチェーンがフルスクリーンの場合、アダプターは新しいサイズに一致するディスプレイモードに設定されます。

Direct3D 9 のアプリケーションでは、この呼び出しの最中に (たとえばこの呼び出しから戻る前に) メッセージが送信されることがあります。アプリケーションは、このときに Direct3D を呼び出さないように注意する必要があります。さらに、IDirect3DDevice9::Reset が失敗した場合に呼び出せる有効なメソッドは、IDirect3DDevice9::Reset、IDirect3DDevice9::TestCooperativeLevel、および各種の Release メンバー関数だけです。それ以外のメソッドを呼び出すと例外が発生する可能性があります。

IDirect3DDevice9::Reset の呼び出しは、リセット対象のデバイスを作成したスレッドとは異なるスレッドから行われた場合に失敗します。

Direct3D 9 では、ピクセルシェーダーと頂点シェーダーは IDirect3DDevice9::Reset の呼び出し後も保持されます。アプリケーションが明示的に再作成する必要はありません。

IDirect3D9::CreateDevice、IDirect3DDevice9::Reset、IDirect3DDevice9::CreateAdditionalSwapChain を呼び出す際、ウィンドウモードのバックバッファーフォーマットには D3DFMT_UNKNOWN を指定できます。つまり、ウィンドウモードで IDirect3D9::CreateDevice を呼び出す前に、アプリケーションが現在のデスクトップのフォーマットを問い合わせる必要はありません。フルスクリーンモードの場合は、バックバッファーのフォーマットを指定する必要があります。BackBufferCount を 0 に設定する (BackBufferCount = 0) と、バックバッファーは 1 つになります。

グループ内の複数のディスプレイアダプターをリセットする場合は、pPresentationParameters に、アダプターグループ内の各ディスプレイに対応する D3DPRESENT_PARAMETERS 構造体の配列へのポインターを設定します。

マルチヘッドデバイスが D3DCREATE_ADAPTERGROUP_DEVICE で作成された場合、IDirect3DDevice9::Reset には D3DPRESENT_PARAMETERS 構造体の配列が必要で、各構造体はフルスクリーン表示を指定しなければなりません。ウィンドウモードに戻すには、アプリケーションはデバイスを破棄し、マルチヘッドではないデバイスをウィンドウモードで再作成する必要があります。

IDirect3DDevice9::Present メソッド (d3d9.h) は、デバイスが所有するバックバッファー列のうち、次のバッファーの内容を表示します。

型: HRESULT

返される可能性のある値: D3D_OK または D3DERR_DEVICEREMOVED (D3DERR を参照)。

必要に応じて、転送元の矩形内のピクセルを対象ウィンドウのクライアント領域内の転送先矩形へ転送する際に、拡大縮小処理が適用されます。

レンダーターゲットが現在のレンダーターゲットでない場合 (追加のスワップチェーンを作成して得たバックバッファーなど) を除き、BeginScene と EndScene の対の間で Present を呼び出すと、D3DERR_INVALIDCALL を返して失敗します。これは Direct3D 9 での新しい動作です。

IDirect3DDevice9::GetBackBuffer メソッド (d3d9.h) は、デバイスのスワップチェーンからバックバッファーを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。BackBuffer がバックバッファーの総数以上である場合、この関数は失敗し D3DERR_INVALIDCALL を返します。

このメソッドを呼び出すと、IDirect3DSurface9 インターフェースの内部参照カウントが増加します。この IDirect3DSurface9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::GetRasterStatus メソッド (d3d9.h) は、スワップチェーンが表示されているモニターのラスターに関する情報を返します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。pRasterStatus が無効な場合、またはデバイスが現在のスキャンラインの読み取りをサポートしていない場合は D3DERR_INVALIDCALL が返されます。デバイスがスキャンラインの読み取りをサポートしているかどうかを判別するには、D3DCAPS9 の Caps メンバーに D3DCAPS_READ_SCANLINE フラグがあるかを確認してください。

IDirect3DDevice9::SetDialogBoxMode メソッド (d3d9.h) は、フルスクリーンモードのアプリケーションで GDI ダイアログボックスの使用を可能にします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。次の条件がすべて満たされていない場合、メソッドは失敗し、戻り値は D3DERR_INVALIDCALL になります。

• アプリケーションが GDI と互換性のあるバックバッファーフォーマット、すなわち D3DFMT_X1R5G5B5、D3DFMT_R5G6B5、D3DFMT_X8R8G8B8 のいずれかを指定している。
• アプリケーションがマルチサンプリングを指定していない。
• アプリケーションが D3DSWAPEFFECT_DISCARD を指定している。
• アプリケーションが D3DPRESENTFLAG_LOCKABLE_BACKBUFFER を指定している。
• アプリケーションが D3DCREATE_ADAPTERGROUP_DEVICE を指定していない。
• アプリケーションが BeginScene と EndScene の間にいない。

GDI ダイアログボックスは、デバイスウィンドウの子として作成する必要があります。また、親ウィンドウが子ウィンドウの再描画を管理できるようにするため、デバイスを作成したスレッドと同じスレッド内で作成してください。

このメソッドはウィンドウモードのアプリケーションには効果がありませんが、アプリケーションがデバイスをフルスクリーンモードにリセットした場合にはこの設定が反映されます。ウィンドウモードのアプリケーションで SetDialogBoxMode が成功した場合、その後フルスクリーンモードにリセットする際に、上記の制限に照らして検査が行われます。また、SetDialogBoxMode はスワップチェーン上のすべてのバックバッファーを破棄するため、アプリケーションはこの呼び出しの後、すべてのバックバッファーの内容を再描画することが期待されます。

IDirect3DDevice9::SetGammaRamp メソッド (d3d9.h) は、暗黙のスワップチェーンにガンマ補正ランプを設定します。

Direct3D 9 ではスワップチェーンがデバイスのプロパティとして 1 つ存在するため、各デバイスには常に少なくとも 1 つのスワップチェーン (暗黙のスワップチェーン) があります。ガンマランプは直ちに反映され、垂直同期を待つことはありません。

スワップチェーンの現在の表示モード (フルスクリーンまたはウィンドウ) でデバイスがガンマランプをサポートしていない場合でも、エラーは返されません。アプリケーションは、D3DCAPS9 構造体の Caps2 メンバーにある D3DCAPS2_FULLSCREENGAMMA および D3DCAPS2_CANCALIBRATEGAMMA の機能ビットを確認することで、デバイスの機能とキャリブレーターがインストールされているかどうかを判別できます。

ウィンドウモードでガンマ補正して表示する場合は、ハードウェアがこの機能をサポートしていれば IDirect3DSwapChain9::Present を使用してください。DirectX 8 では、SetGammaRamp はフルスクリーンモードのアプリケーションでのみガンマランプを設定します。ガンマ補正の詳細については、ガンマ (Direct3D 9) を参照してください。

IDirect3DDevice9::GetGammaRamp メソッド (d3d9.h) は、スワップチェーンのガンマ補正ランプを取得します。

IDirect3DDevice9::CreateTexture メソッド (d3d9.h) は、テクスチャーリソースを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、 D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

アプリケーションは、D3DUSAGE_AUTOGENMIPMAP を指定して IDirect3D9::CheckDeviceFormat を呼び出すことで、特定のフォーマットにおける ミップマップの自動生成 (Direct3D 9) のサポート状況を調べることができます。IDirect3D9::CheckDeviceFormat が D3DOK_NOAUTOGEN を返す場合、 IDirect3DDevice9::CreateTexture は成功しますが、1 レベルのテクスチャーを返します。

Windows Vista では、CreateTexture はシステムメモリのポインターからテクスチャーを作成でき、システムメモリの使用、割り当て、削除についてアプリケーションがより柔軟に制御できます。 たとえば、アプリケーションは GDI のシステムメモリビットマップのポインターを渡し、それをラップした Direct3D のテクスチャーインターフェースを取得できます。CreateTexture でシステムメモリの ポインターを使用する場合、次の制限があります。

• テクスチャーのピッチは、幅に 1 ピクセルあたりのバイト数を掛けた値と等しくなければなりません。
• ミップマップレベルが 1 つのテクスチャーのみがサポートされます。Levels 引数は 1 でなければなりません。
• Pool 引数は D3DPOOL_SYSTEMMEM でなければなりません。
• pSharedHandle 引数は、システムメモリのポインターを保持できるバッファーへの有効なポインターでなければなりません。*pSharedHandle は、 テクスチャーの幅 × テクスチャーの高さ × テクスチャーフォーマットの 1 ピクセルあたりのバイト数のサイズを持つシステムメモリへの有効なポインターでなければなりません。

IDirect3DDevice9::CreateVolumeTexture メソッド (d3d9.h) は、ボリュームテクスチャーリソースを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

IDirect3DDevice9::CreateCubeTexture メソッド (d3d9.h) は、キューブテクスチャーリソースを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

ミップマップ (テクスチャー) は、順次ダウンサンプリングされた (ミップマップ化された) サーフェスの集合です。一方、キューブテクスチャー (IDirect3DDevice9::CreateCubeTexture で作成) は、各面に 1 つずつ、計 6 つのテクスチャー (ミップマップ) の集合です。キューブテクスチャーにはすべての面が存在しなければなりません。また、キューブマップサーフェスは 3 つの次元 (x、y、z) すべてで同じピクセルサイズでなければなりません。

アプリケーションは、D3DUSAGE_AUTOGENMIPMAP を指定して IDirect3D9::CheckDeviceFormat を呼び出すことで、特定のフォーマットにおける ミップマップの自動生成 (Direct3D 9) のサポート状況を調べることができます。IDirect3D9::CheckDeviceFormat が D3DOK_NOAUTOGEN を返す場合、IDirect3DDevice9::CreateCubeTexture は成功しますが、1 レベルのテクスチャーを返します。

IDirect3DDevice9::CreateVertexBuffer メソッド (d3d9.h) は、頂点バッファーを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

頂点バッファーは、ハードウェア頂点処理とソフトウェア頂点処理のどちらでも使用できます。これは、デバイスと頂点バッファーの作成方法によって決まります。

デバイスの作成時、CreateDevice は動作フラグを使用して、頂点をハードウェアで処理するかソフトウェアで処理するかを決定します。次の 3 つの選択肢があります。

• D3DCREATE_HARDWARE_VERTEXPROCESSING を設定して、頂点をハードウェアで処理する。
• D3DCREATE_SOFTWARE_VERTEXPROCESSING を設定して、頂点をソフトウェアで処理する。
• D3DCREATE_MIXED_VERTEXPROCESSING を設定して、頂点をハードウェアまたはソフトウェアのいずれかで処理する。

頂点バッファーの作成時、CreateVertexBuffer は usage パラメーターを使用して、頂点をハードウェアで処理するかソフトウェアで処理するかを決定します。

• CreateDevice で D3DCREATE_HARDWARE_VERTEXPROCESSING を使用した場合、CreateVertexBuffer では 0 を使用しなければなりません。
• CreateDevice で D3DCREATE_SOFTWARE_VERTEXPROCESSING を使用した場合、CreateVertexBuffer では 0 または D3DUSAGE_SOFTWAREPROCESSING を使用しなければなりません。どちらの値でも、頂点はソフトウェアで処理されます。
• CreateDevice で D3DCREATE_MIXED_VERTEXPROCESSING を使用した場合、CreateVertexBuffer では 0 または D3DUSAGE_SOFTWAREPROCESSING のいずれも使用できます。

IDirect3DDevice9 インターフェースは、頂点バッファーオブジェクトに格納された頂点データを使用したプリミティブのレンダリングをサポートします。頂点バッファーは IDirect3DDevice9 から作成され、作成元の IDirect3DDevice9 オブジェクトでのみ使用できます。

FVF パラメーターに 0 以外の値 (有効な FVF コードでなければなりません) を設定すると、バッファーの内容が FVF コードによって特徴づけられることを示します。FVF コードを指定して作成された頂点バッファーは、FVF 頂点バッファーと呼ばれます。詳細については、FVF 頂点バッファー (Direct3D 9) を参照してください。

非 FVF バッファーは、マルチパスレンダリングや 1 パスでのマルチテクスチャーレンダリングにおいて、データをインターリーブするために使用できます。この場合、1 つのバッファーにジオメトリデータを格納し、他のバッファーにレンダリング対象の各テクスチャーのテクスチャー座標を格納します。レンダリング時には、ジオメトリデータを含むバッファーが、テクスチャー座標を含む各バッファーとインターリーブされます。代わりに FVF バッファーを使用すると、各バッファーにテクスチャーごとのテクスチャー座標データに加えて同一のジオメトリデータを格納する必要が生じます。その結果、採用する方式に応じて速度またはメモリのいずれかで不利になります。テクスチャー座標の詳細については、テクスチャー座標 (Direct3D 9) を参照してください。

IDirect3DDevice9::CreateIndexBuffer メソッド (d3d9.h) は、インデックスバッファーを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、D3DXERR_INVALIDDATA、E_OUTOFMEMORY。

インデックスバッファーは、インデックスを保持するために使用されるメモリリソースであり、サーフェスと頂点バッファーの両方に似ています。インデックスバッファーを使用すると、Direct3D は不要なデータコピーを回避し、想定される用途に最適なメモリ種別にバッファーを配置できます。

インデックスバッファーを使用するには、インデックスバッファーを作成してロックし、インデックスを書き込んでロックを解除し、IDirect3DDevice9::SetIndices に渡したうえで、頂点と頂点シェーダーを設定し、レンダリングのために IDirect3DDevice9::DrawIndexedPrimitive を呼び出します。

D3DCAPS9 構造体の MaxVertexIndex メンバーは、レンダリングに使用できるインデックスバッファーの種類を示します。

IDirect3DDevice9::CreateRenderTarget メソッド (d3d9.h) は、レンダーターゲットサーフェスを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_NOTAVAILABLE、D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

レンダーターゲットサーフェスは D3DPOOL_DEFAULT のメモリクラスに配置されます。

ロック可能なマルチサンプルレンダーターゲットの作成はサポートされていません。

IDirect3DDevice9::CreateDepthStencilSurface メソッド (d3d9.h) は、深度ステンシルリソースを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_NOTAVAILABLE、D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

深度ステンシルバッファーのメモリクラスは常に D3DPOOL_DEFAULT です。

IDirect3DDevice9::UpdateSurface メソッド (d3d9.h) は、あるサーフェスから別のサーフェスへ、矩形単位のピクセル領域をコピーします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL。

このメソッドは DirectX 8 の CopyRects に相当します。

この関数には次の制限があります。

• コピー元サーフェスは D3DPOOL_SYSTEMMEM で作成されている必要があります。
• コピー先サーフェスは D3DPOOL_DEFAULT で作成されている必要があります。
• どちらのサーフェスも、ロックされていたり、未解放のデバイスコンテキストを保持していたりしてはなりません。
• どちらのサーフェスもマルチサンプリングを指定して作成することはできません。両方のサーフェスで有効なフラグは D3DMULTISAMPLE_NONE のみです。
• サーフェスのフォーマットに深度ステンシルフォーマットは使用できません。
• コピー元とコピー先の矩形はサーフェス内に収まっている必要があります。
• 拡大や縮小は許可されません (両方の矩形は同じサイズでなければなりません)。
• コピー元のフォーマットはコピー先のフォーマットと一致している必要があります。

• ドライバーが要求されたコピーをサポートしていない場合は、ロックとコピーを使用してエミュレートされます。

D3DPOOL_DEFAULT のレンダーターゲットから D3DPOOL_SYSTEMMEM のサーフェスへデータをコピーする必要がある場合は、GetRenderTargetData を使用できます。

IDirect3DDevice9::UpdateTexture メソッド (d3d9.h) は、テクスチャーのダーティ部分を更新します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

テクスチャーの一部をダーティにするには、テクスチャーをロックするか、次のいずれかのメソッドを呼び出します。

• IDirect3DCubeTexture9::AddDirtyRect
• IDirect3DTexture9::AddDirtyRect
• IDirect3DVolumeTexture9::AddDirtyBox
• IDirect3DDevice9::UpdateSurface

パフォーマンス上の理由から、ダーティ領域はテクスチャーのレベル 0 についてのみ記録されます。サブレベルについては、対応する (スケーリングされた) 矩形またはボックスもダーティであるとみなされます。ダーティ領域は、D3DLOCK_NO_DIRTY_UPDATE や D3DLOCK_READONLY を指定せずに LockRect または IDirect3DVolumeTexture9::LockBox を呼び出したときに自動的に記録されます。また、IDirect3DDevice9::UpdateSurface のコピー先サーフェスもダーティとしてマークされます。

テクスチャーの種類が異なる場合、最下位レベルのバッファーのサイズが異なる場合、または対応するレベルが一致しない場合、このメソッドは失敗します。たとえば、次のサイズを持つ 6 レベルのコピー元テクスチャーを考えます。

32x16, 16x8, 8x4, 4x2, 2x1, 1x1

この 6 レベルのコピー元テクスチャーは、次の 1 レベルのコピー先に対するコピー元になれます。

1x1

また、次の 2 レベルのコピー先に対しても同様です。

2x1, 1x1

さらに、次の 3 レベルのコピー先に対しても同様です。

4x2, 2x1, 1x1

さらに、テクスチャーのフォーマットが異なる場合もこのメソッドは失敗します。コピー先テクスチャーのレベル数がコピー元より少ない場合は、一致するレベルのみがコピーされます。コピー元テクスチャーのレベル数がコピー先より少ない場合、このメソッドは失敗します。

コピー元テクスチャーにダーティ領域がある場合、コピーをその領域のみに限定して最適化できます。ただし、ダーティとマークされたバイトだけがコピーされることは保証されません。

コピー元とコピー先のサーフェスの組み合わせには次の可能性があります。

• pSourceTexture が自動生成でないミップマップで、pDestinationTexture が自動生成ミップマップの場合、一致する最上位レベルのみが更新され、コピー先のサブレベルは再生成されます。コピー元のその他のサブレベルは無視されます。
• pSourceTexture と pDestinationTexture の両方が自動生成ミップマップの場合、一致する最上位レベルのみが更新されます。コピー元のサブレベルは無視され、コピー先のサブレベルは再生成されます。
• pSourceTexture が自動生成ミップマップで、pDestinationTexture が自動生成でないミップマップの場合、UpdateTexture は失敗します。

IDirect3DDevice9::GetRenderTargetData メソッド (d3d9.h) は、レンダーターゲットのデータをデバイスメモリからシステムメモリへコピーします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_DRIVERINTERNALERROR、D3DERR_DEVICELOST、D3DERR_INVALIDCALL。

コピー先サーフェスは、オフスクリーンプレーンサーフェスか、D3DPOOL_SYSTEMMEM で作成されたテクスチャー (ミップマップまたはキューブテクスチャー) のレベルでなければなりません。

コピー元サーフェスは、通常のレンダーターゲットか、POOL_DEFAULT で作成されたレンダーターゲットテクスチャー (ミップマップまたはキューブテクスチャー) のレベルでなければなりません。

次の場合、このメソッドは失敗します。

• レンダーターゲットがマルチサンプリングされている。
• コピー元のレンダーターゲットとコピー先のサーフェスのサイズが異なる。
• コピー元のレンダーターゲットとコピー先のサーフェスのフォーマットが一致しない。

IDirect3DDevice9::GetFrontBufferData メソッド (d3d9.h) は、デバイスのフロントバッファーをアプリケーションが用意したシステムメモリのバッファーへコピーします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_DRIVERINTERNALERROR、D3DERR_DEVICELOST、D3DERR_INVALIDCALL

pDestSurface が指すバッファーには、標準の 32 ビット/ピクセルフォーマット D3DFMT_A8R8G8B8 に変換されたフロントバッファーの内容が格納されます。

アンチエイリアス処理されたスクリーンショットを取得できるのは、このメソッドだけです。

この関数は設計上きわめて低速であり、パフォーマンスが重要な処理経路では使用しないでください。

詳細については、ロストデバイスと取得データを参照してください。

IDirect3DDevice9::StretchRect メソッド (d3d9helper.h) は、コピー元矩形の内容をコピー先矩形へコピーします。コピーの際に、コピー元を拡大縮小したりフィルタリングしたりできます。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

StretchRect の制限事項

• ドライバーによってサポート状況が異なります。どのドライバーがどのコピー元・コピー先フォーマットをサポートするかについては、後述のドライバーサポートの節を参照してください。
• コピー元とコピー先のサーフェスは既定のメモリプールで作成されている必要があります。
• フィルタリングを指定する場合は、適切なフィルター機能を設定する必要があります (D3DCAPS9 の StretchRectFilterCaps を参照)。
• 同一サーフェス上のコピー元矩形とコピー先矩形の間での拡大縮小はサポートされません。
• コピー先サーフェスがオフスクリーンプレーンサーフェスで、コピー元がそうでない場合、拡大縮小はサポートされません。
• いずれかのサーフェスが圧縮フォーマットの場合、コピー元矩形とコピー先矩形の間で拡大縮小することはできません (圧縮テクスチャーの使用 (Direct3D 9) を参照)。
• 拡大縮小がサポートする色空間変換は、YUV から高精度 RGBA への変換のみです。色変換はソフトウェアエミュレーションではサポートされないため、IDirect3D9::CheckDeviceFormatConversion を使用してハードウェアの色変換サポートを確認してください。
• コピー元またはコピー先のサーフェスがテクスチャーサーフェス (またはキューブテクスチャーサーフェス) の場合、D3DDEVCAPS2_CAN_STRETCHRECT_FROM_TEXTURES をサポートする Direct3D 9 ドライバーを使用する必要があります (D3DDEVCAPS2 を参照)。

• コピー元とコピー先のサーフェスは、テクスチャーではないプレーンな深度ステンシルサーフェスでなければなりません (IDirect3DDevice9::CreateDepthStencilSurface を参照)。
• どちらのサーフェスも破棄可能 (discardable) であってはなりません。
• サーフェス全体をコピーする必要があります (つまり、部分矩形のコピーは許可されません)。
• フォーマット変換、拡大、縮小はサポートされません。
• StretchRect は BeginScene と EndScene の対の内部では呼び出せません。

StretchRect を使用して、あるレンダーターゲットから別のレンダーターゲットへコピーできます。コピー元のレンダーターゲットがマルチサンプルされている場合、コピー元レンダーターゲットがダウンサンプリングされます。たとえば次のようにします。

• マルチサンプルのレンダーターゲットを作成します。
• 同じサイズで、マルチサンプルではない 2 つ目のレンダーターゲットを作成します。
• (StretchRect を使用して) マルチサンプルのレンダーターゲットを 2 つ目のレンダーターゲットへコピーします。

ドライバーサポート

StretchRect で有効となるサーフェスの組み合わせには多くの制限があります。ドライバーが Direct3D 9 ドライバーかそれ以前のものか、また拡大縮小を伴う処理かどうかといった要因が関係します。アプリケーションがドライバーの世代を識別することは想定されていないため、ランタイムは Direct3D 9 レベル以降のドライバーに対して新しい機能ビット D3DDEVCAPS2_CAN_STRETCHRECT_FROM_TEXTURES (D3DDEVCAPS2 を参照) を自動的に設定します。

IDirect3DDevice9::ColorFill メソッド (d3d9.h) は、D3DPOOL_DEFAULT のサーフェスの矩形領域を指定した色で塗りつぶす機能をアプリケーションに提供します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

このメソッドを適用できるのは、レンダーターゲット、レンダーターゲットテクスチャーサーフェス、またはプール種別が D3DPOOL_DEFAULT のオフスクリーンプレーンサーフェスに限られます。

IDirect3DDevice9::ColorFill はすべてのフォーマットで動作します。ただし、リファレンスデバイスまたはソフトウェアデバイスを使用する場合にサポートされるフォーマットは、D3DFMT_X1R5G5B5、D3DFMT_A1R5G5B5、D3DFMT_R5G6B5、D3DFMT_X8R8G8B8、D3DFMT_A8R8G8B8、D3DFMT_YUY2、D3DFMT_G8R8_G8B8、D3DFMT_UYVY、D3DFMT_R8G8_B8G8、D3DFMT_R16F、D3DFMT_G16R16F、D3DFMT_A16B16G16R16F、D3DFMT_R32F、D3DFMT_G32R32F、D3DFMT_A32B32G32R32F のみです。

DirectX 7 または DirectX 8.x のドライバーを使用する場合、サポートされる YUV フォーマットは D3DFMT_UYVY と D3DFMT_YUY2 のみです。

IDirect3DDevice9::CreateOffscreenPlainSurface メソッド (d3d9.h) は、オフスクリーンサーフェスを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

D3DPOOL_SCRATCH を指定すると、DirectX 8.x の CreateImageSurface メソッドで作成されるサーフェスと同一の特性を持つサーフェスが返されます。

IDirect3DDevice9::StretchRect や IDirect3DDevice9::ColorFill と組み合わせて使用する場合は、D3DPOOL_DEFAULT が適切なプールです。

オフスクリーンプレーンサーフェスの作成時に D3DPOOL_MANAGED は使用できません。メモリプールの詳細については、D3DPOOL を参照してください。

オフスクリーンプレーンサーフェスは、プール種別にかかわらず常にロック可能です。

IDirect3DDevice9::SetRenderTarget メソッド (d3d9helper.h) は、デバイスに新しいカラーバッファーを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。 次のいずれかの場合、このメソッドは D3DERR_INVALIDCALL を返します。

• pRenderTarget = NULL かつ RenderTargetIndex = 0 の場合
• pRenderTarget が NULL 以外で、レンダーターゲットが無効な場合。

デバイスは複数のレンダーターゲットをサポートできます。デバイスがサポートするレンダーターゲットの数は、D3DCAPS9 の NumSimultaneousRTs メンバーに格納されています。複数レンダーターゲット (Direct3D 9) を参照してください。

新しいレンダーターゲットを設定すると、ビューポート (ビューポートとクリッピング (Direct3D 9) を参照) は新しいレンダーターゲットの全体サイズに設定されます。

一部のハードウェアでは、深度ステンシルバッファーとカラーバッファーの互換性が検査されます。検査が行われる場合でも、それはデバッグビルドでのみ実施されます。

このメソッドを使用する際の制限には次のものがあります。

• レンダーターゲットと深度ステンシルサーフェスのマルチサンプル種別は同じでなければなりません。
• レンダーターゲットと深度ステンシルサーフェスのフォーマットは互換性がなければなりません。IDirect3D9::CheckDepthStencilMatch を参照してください。
• 深度ステンシルサーフェスのサイズは、レンダーターゲットのサイズ以上でなければなりません。

キューブテクスチャーは、サーフェスの集合である点で他のサーフェスと異なります。キューブテクスチャーを指定して IDirect3DDevice9::SetRenderTarget を呼び出すには、IDirect3DCubeTexture9::GetCubeMapSurface を使用して個々の面を選択し、得られたサーフェスを IDirect3DDevice9::SetRenderTarget に渡す必要があります。

IDirect3DDevice9::GetRenderTarget メソッド (d3d9.h) は、レンダーターゲットサーフェスを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、引数のいずれかが無効であれば D3DERR_INVALIDCALL が、指定されたインデックスに利用可能なレンダーターゲットがなければ D3DERR_NOTFOUND が返されます。

通常、状態を返すメソッドは D3DCREATE_PUREDEVICE を指定して作成されたデバイスでは機能しません。ただし、このメソッドはインターフェースを返すため、ピュアデバイスでも機能します。

デバイスは現在、複数のレンダーターゲットをサポートできます。デバイスがサポートするレンダーターゲットの数は、D3DCAPS9 の NumSimultaneousRTs メンバーに格納されています。複数レンダーターゲット (Direct3D 9) を参照してください。

このメソッドを呼び出すと、IDirect3DSurface9 インターフェースの内部参照カウントが増加します。この IDirect3DSurface9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::SetDepthStencilSurface メソッド (d3d9.h) は、深度ステンシルサーフェスを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。 pZStencilSurface が NULL 以外の場合、ステンシルサーフェスが無効であれば戻り値は D3DERR_INVALIDCALL になります。

このメソッドを使用する際の制限には次のものがあります。

• レンダーターゲットと深度ステンシルサーフェスのマルチサンプル種別は同じでなければなりません。
• レンダーターゲットと深度ステンシルサーフェスのフォーマットは互換性がなければなりません。IDirect3D9::CheckDepthStencilMatch を参照してください。
• 深度ステンシルサーフェスのサイズは、レンダーターゲットのサイズ以上でなければなりません。

キューブテクスチャーは、サーフェスの集合である点で他のサーフェスと異なります。キューブテクスチャーを指定して IDirect3DDevice9::SetDepthStencilSurface を呼び出すには、IDirect3DCubeTexture9::GetCubeMapSurface を使用して個々の面を選択し、得られたサーフェスを IDirect3DDevice9::SetDepthStencilSurface に渡す必要があります。

IDirect3DDevice9::GetDepthStencilSurface メソッド (d3d9.h) は、Direct3DDevice オブジェクトが所有する深度ステンシルサーフェスを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。デバイスに深度ステンシルバッファーが関連付けられていない場合、戻り値は D3DERR_NOTFOUND になります。それ以外でメソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドを呼び出すと、IDirect3DSurface9 インターフェースの内部参照カウントが増加します。この IDirect3DSurface9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::BeginScene メソッド (d3d9.h) は、シーンを開始します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。IDirect3DDevice9::BeginScene を IDirect3DDevice9::BeginScene/IDirect3DDevice9::EndScene の対の内部で呼び出した場合、このメソッドは D3DERR_INVALIDCALL で失敗します。これは、 先に IDirect3DDevice9::EndScene を呼び出さずに IDirect3DDevice9::BeginScene を 2 回呼び出した場合にのみ発生します。

アプリケーションは、レンダリングを行う前に IDirect3DDevice9::BeginScene を呼び出し、レンダリングが完了して 再度 IDirect3DDevice9::BeginScene を呼び出す前に IDirect3DDevice9::EndScene を呼び出す必要があります。

IDirect3DDevice9::BeginScene が失敗した場合、デバイスはシーンを開始できなかったことになり、 IDirect3DDevice9::EndScene を呼び出す必要はありません。実際、直前の IDirect3DDevice9::BeginScene が失敗していた場合、 IDirect3DDevice9::EndScene の呼び出しは失敗します。これは、複数のスワップチェーンを作成するあらゆるアプリケーションに当てはまります。

表示 (IDirect3DDevice9::Present または IDirect3DSwapChain9::Present) の連続する呼び出しの間には、 IDirect3DDevice9::BeginScene/IDirect3DDevice9::EndScene の対が 1 つあるべきです。IDirect3DDevice9::BeginScene は レンダリングを行う前に 1 回呼び出し、IDirect3DDevice9::EndScene は 1 フレーム分のレンダリングをすべてランタイムへ送信した後に 1 回呼び出してください。表示の呼び出しの間に入れ子でない IDirect3DDevice9::BeginScene/IDirect3DDevice9::EndScene の対が複数あっても 問題はありませんが、対が 2 つ以上あるとパフォーマンスが低下する可能性があります。 CPU とグラフィックスアクセラレーターの並列性を最大化するには、 表示の呼び出しよりできるだけ早い段階で IDirect3DDevice9::EndScene を呼び出すのが有利です。

IDirect3DDevice9::EndScene メソッド (d3d9.h) は、IDirect3DDevice9::BeginScene の呼び出しによって開始されたシーンを終了します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。IDirect3DDevice9::BeginScene を IDirect3DDevice9::BeginScene/IDirect3DDevice9::EndScene の対の内部で呼び出した場合、このメソッドは D3DERR_INVALIDCALL で失敗します。これは、先に IDirect3DDevice9::EndScene を呼び出さずに IDirect3DDevice9::BeginScene を 2 回呼び出した場合にのみ発生します。

このメソッドが成功した時点で、シーンはドライバーによるレンダリングのためにキューに登録されています。これは同期的なメソッドではないため、このメソッドから戻った時点でシーンのレンダリングが完了していることは保証されません。

アプリケーションは、レンダリングを行う前に IDirect3DDevice9::BeginScene を呼び出し、レンダリングが完了して再度 IDirect3DDevice9::BeginScene を呼び出す前に IDirect3DDevice9::EndScene を呼び出す必要があります。

IDirect3DDevice9::BeginScene が失敗した場合、デバイスはシーンを開始できなかったことになり、IDirect3DDevice9::EndScene を呼び出す必要はありません。実際、直前の

IDirect3DDevice9::BeginScene が失敗していた場合、IDirect3DDevice9::EndScene の呼び出しは失敗します。これは、複数のスワップチェーンを作成するあらゆるアプリケーションに当てはまります。

表示 (IDirect3DDevice9::Present または IDirect3DSwapChain9::Present) の連続する呼び出しの間には、IDirect3DDevice9::BeginScene/IDirect3DDevice9::EndScene の対は多くとも 1 つであるべきです。IDirect3DDevice9::BeginScene はレンダリングを行う前に 1 回呼び出し、IDirect3DDevice9::EndScene は 1 フレーム分のレンダリングをすべてランタイムへ送信した後に 1 回呼び出してください。CPU とグラフィックスアクセラレーターの並列性を最大化するには、表示の呼び出しよりできるだけ早い段階で IDirect3DDevice9::EndScene を呼び出すのが有利です。

IDirect3DDevice9::Clear メソッド (d3d9.h) は、レンダーターゲット、複数のレンダーターゲット、ステンシルバッファー、深度バッファーなど、1 つ以上のサーフェスをクリアします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

このメソッドは、レンダーターゲット、MRT 内のすべてのレンダーターゲット、ステンシルバッファー、深度バッファーなどのサーフェスをクリアするために使用します。いくつのサーフェスがクリアされるかは Flags によって決まります。矩形の配列で定義したサーフェスの一部だけをクリアするには pRects を使用します。

次の場合、IDirect3DDevice9::Clear は失敗します。

• 深度バッファーが接続されていないレンダーターゲットで、深度バッファーまたはステンシルバッファーをクリアしようとした場合。
• 深度バッファーがステンシルデータを含んでいないときに、ステンシルバッファーをクリアしようとした場合。

IDirect3DDevice9::SetTransform メソッド (d3d9helper.h) は、変換に関連するデバイス状態を 1 つ設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL が返されます。

IDirect3DDevice9::GetTransform メソッド (d3d9.h) は、変換状態を表す行列を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他のフラグ値のいずれかを指定してデバイスを作成する必要があります。

IDirect3DDevice9::MultiplyTransform メソッド (d3d9.h) は、デバイスのワールド行列、ビュー行列、または射影行列に、指定した行列を乗算します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL になります。

乗算の順序は pMatrix × State です。

アプリケーションは、IDirect3DDevice9::MultiplyTransform メソッドを使用して変換の階層構造を扱うことができます。たとえば、腕を表すジオメトリと変換は次のような階層に構成できます。

    
    shoulder_transformation
    
    upper_arm geometry
    
    elbow transformation
    
    lower_arm geometry
    
    wrist transformation
    
    hand geometry

アプリケーションは、この階層をレンダリングするために次のような一連の呼び出しを行います。この疑似コードではすべてのパラメーターを示しているわけではありません。

IDirect3DDevice9::SetTransform(D3DTS_WORLDMATRIX(0), 
                               shoulder_transform)
IDirect3DDevice9::DrawPrimitive(upper_arm)
IDirect3DDevice9::MultiplyTransform(D3DTS_WORLDMATRIX(0), 
                                    elbow_transform)
IDirect3DDevice9::DrawPrimitive(lower_arm)
IDirect3DDevice9::MultiplyTransform(D3DTS_WORLDMATRIX(0), 
                                    wrist_transform)
IDirect3DDevice9::DrawPrimitive(hand)

IDirect3DDevice9::SetViewport メソッド (d3d9helper.h) は、デバイスのビューポートパラメーターを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合は D3DERR_INVALIDCALL を返します。これは pViewport が無効な場合、または pViewport がレンダーターゲットサーフェス内に存在し得ない領域を指定している場合に発生します。

Direct3D はビューポートに次の既定値を設定します。

D3DVIEWPORT9 vp;
vp.X      = 0;
vp.Y      = 0;
vp.Width  = RenderTarget.Width;
vp.Height = RenderTarget.Height;
vp.MinZ   = 0.0f;
vp.MaxZ   = 1.0f;

IDirect3DDevice9::SetViewport は、画面の一部に描画するために使用できます。ビューポートの設定を有効にするため、ジオメトリを描画する前に必ず呼び出してください。

1 つのシーン内に複数のビューを描画するには、ビューごとに IDirect3DDevice9::SetViewport とジオメトリの描画を繰り返します。

IDirect3DDevice9::GetViewport メソッド (d3d9.h) は、デバイスに現在設定されているビューポートパラメーターを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。pViewport パラメーターが無効な場合は D3DERR_INVALIDCALL が返されます。

通常、状態を返すメソッドは D3DCREATE_PUREDEVICE を指定して作成されたデバイスでは機能しません。ただし、このメソッドはピュアデバイスでも機能します。

IDirect3DDevice9::SetMaterial メソッド (d3d9.h) は、デバイスのマテリアルプロパティを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。pMaterial パラメーターが無効な場合は D3DERR_INVALIDCALL になります。

IDirect3DDevice9::GetMaterial メソッド (d3d9.h) は、デバイスの現在のマテリアルプロパティを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。pMaterial パラメーターが無効な場合は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他の値のいずれかを指定してデバイスを作成する必要があります。

IDirect3DDevice9::SetLight メソッド (d3d9.h) は、このデバイスに一組のライティングプロパティを割り当てます。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

ライトのプロパティを設定するには、D3DLIGHT9 構造体を用意してから IDirect3DDevice9::SetLight メソッドを呼び出します。

IDirect3DDevice9::SetLight メソッドは、デバイスが内部のライトプロパティ一覧のどの位置にそのプロパティ一式を配置するかを示すインデックスと、それらのプロパティを定義する用意済みの D3DLIGHT9 構造体のアドレスを受け取ります。ライトの照明プロパティを更新するには、必要に応じて新しい情報を指定して IDirect3DDevice9::SetLight を呼び出します。

プロパティが一度も割り当てられていないインデックスを指定して IDirect3DDevice9::SetLight メソッドを呼び出すたびに、システムはライティングプロパティ一式を格納するためのメモリを割り当てます。アプリケーションは多数のライトを設定し、そのうちの一部だけを同時に有効にできます。デバイスがサポートする有効なライトの最大数を判別するには、デバイスの機能を取得する際に D3DCAPS9 構造体の MaxActiveLights メンバーを確認してください。ライトが不要になった場合は、無効にするか、新しいライトプロパティ一式で上書きできます。

次の例では、距離によって減衰しない白色の点光源のプロパティを用意し、設定しています。

// Assume d3dDevice is a valid pointer to an IDirect3DDevice9 interface.
D3DLIGHT9 d3dLight;
HRESULT   hr;
    
// Initialize the structure.
ZeroMemory(&d3dLight, sizeof(d3dLight));
    
// Set up a white point light.
d3dLight.Type = D3DLIGHT_POINT;
d3dLight.Diffuse.r  = 1.0f;
d3dLight.Diffuse.g  = 1.0f;
d3dLight.Diffuse.b  = 1.0f;
d3dLight.Ambient.r  = 1.0f;
d3dLight.Ambient.g  = 1.0f;
d3dLight.Ambient.b  = 1.0f;
d3dLight.Specular.r = 1.0f;
d3dLight.Specular.g = 1.0f;
d3dLight.Specular.b = 1.0f;
    
// Position it high in the scene and behind the user.
// Remember, these coordinates are in world space, so
// the user could be anywhere in world space, too. 
// For the purposes of this example, assume the user
// is at the origin of world space.
d3dLight.Position.x = 0.0f;
d3dLight.Position.y = 1000.0f;
d3dLight.Position.z = -100.0f;
    
// Don't attenuate.
d3dLight.Attenuation0 = 1.0f; 
d3dLight.Range        = 1000.0f;
    
// Set the property information for the first light.
hr = d3dDevice->SetLight(0, &d3dLight);
if (SUCCEEDED(hr))
    // Handle Success
else
    // Handle failure

光源を有効にするには、デバイスに対して IDirect3DDevice9::LightEnable メソッドを呼び出します。

IDirect3DDevice9::GetLight メソッド (d3d9.h) は、このデバイスが使用しているライティングプロパティ一式を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他の値のいずれかを指定してデバイスを作成する必要があります。

既存の光源のすべてのプロパティを取得するには、デバイスに対して IDirect3DDevice9::GetLight メソッドを呼び出します。IDirect3DDevice9::GetLight メソッドを呼び出す際は、プロパティを取得する光源の 0 から始まるインデックスを第 1 引数に渡し、D3DLIGHT9 構造体のアドレスを第 2 引数に指定します。デバイスは、そのインデックスの光源に使用しているライティングプロパティを記述するように D3DLIGHT9 構造体を埋めます。

// Assume d3dDevice is a valid pointer to an IDirect3DDevice9 interface.
HRESULT hr;
D3DLight9 light;
    
// Get the property information for the first light.
hr = pd3dDevice->GetLight(0, &light);
if (SUCCEEDED(hr))
    // Handle Success
else
    // Handle failure

デバイスに割り当てられている光源の範囲外のインデックスを指定した場合、IDirect3DDevice9::GetLight メソッドは失敗し、D3DERR_INVALIDCALL を返します。

シーン内の光源にライトプロパティ一式を割り当てたら、デバイスに対して IDirect3DDevice9::LightEnable メソッドを呼び出すことでその光源を有効化できます。新しい光源は既定で無効になっています。IDirect3DDevice9::LightEnable メソッドは 2 つのパラメーターを受け取ります。第 1 引数にはこのメソッドの対象となる光源の 0 から始まるインデックスを設定し、第 2 引数にはライトを有効にする場合は TRUE、無効にする場合は FALSE を設定します。次のコード例は、デバイスの光源プロパティ一覧の最初の光源を有効にして、このメソッドの使い方を示しています。

// Assume d3dDevice is a valid pointer to an IDirect3DDevice9 interface.
HRESULT hr;
    
hr = pd3dDevice->LightEnable(0, TRUE);
if (SUCCEEDED(hr))
    // Handle Success
else
    // Handle failure

デバイスがサポートする有効なライトの最大数を判別するには、デバイスの機能を取得する際に D3DCAPS9 構造体の MaxActiveLights メンバーを確認してください。

IDirect3DDevice9::SetLight でプロパティが設定されていないライトを有効または無効にした場合、IDirect3DDevice9::LightEnable メソッドは次の表に示すプロパティを持つ光源を作成し、それを有効または無効にします。

IDirect3DDevice9::LightEnable メソッド (d3d9.h) は、デバイス内のライティングパラメーター一式を有効または無効にします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

LightIndex の値がデバイス内に割り当てられているライトプロパティ一式の範囲外である場合、IDirect3DDevice9::LightEnable メソッドは次のプロパティを持つ D3DLIGHT9 構造体で表される光源を作成し、その有効状態を bEnable で指定された値に設定します。

</td>

</td>

</td>

</td>

</td>

</td>

</td>

</td>

</td>

</td>

</td>

</td>

</td>

IDirect3DDevice9::GetLightEnable メソッド (d3d9.h) は、デバイス内のライティングパラメーター一式の有効状態を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他の値のいずれかを指定してデバイスを作成する必要があります。

IDirect3DDevice9::SetClipPlane メソッド (d3d9.h) は、デバイスのユーザー定義クリッピング平面の係数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。このエラーは、Index の値がデバイスがサポートするクリッピング平面インデックスの最大値を超えているか、pPlane の配列が 4 つの浮動小数点値を格納するのに十分な大きさでないことを示します。

このメソッドで設定する係数は、一般形の平面方程式の形式を取ります。pPlane の配列内の値を、配列に現れる順に A、B、C、D と呼ぶとすると、これらは一般形の平面方程式に当てはめられ、Ax + By + Cz + Dw = 0 となります。同次座標 (x, y, z, w) を持つ点は、Ax + By + Cz + Dw >= 0 であればその平面の半空間内で可視となります。クリッピング平面の後ろにある点はシーンからクリップされます。

固定機能パイプラインを使用する場合、平面方程式はワールド空間にあるものとみなされます。プログラマブルパイプラインを使用する場合、平面方程式はクリッピング空間 (出力頂点と同じ空間) にあるものとみなされます。

このメソッドは、設定したクリッピング平面方程式を有効にはしません。クリッピング平面を有効にするには、D3DRS_CLIPPLANEENABLE レンダーステートに適用する DWORD 値の対応するビットを設定してください。

IDirect3DDevice9::GetClipPlane メソッド (d3d9.h) は、デバイスのユーザー定義クリッピング平面の係数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。このエラーは、Index の値がデバイスがサポートするクリッピング平面インデックスの最大値を超えているか、pPlane の配列が 4 つの浮動小数点値を格納するのに十分な大きさでないことを示します。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他の値のいずれかを指定してデバイスを作成する必要があります。"

このメソッドが報告する係数は、一般形の平面方程式の形式を取ります。pPlane の配列内の値を、配列に現れる順に A、B、C、D と呼ぶとすると、これらは一般形の平面方程式に当てはめられ、Ax + By + Cz + Dw = 0 となります。同次座標 (x, y, z, w) を持つ点は、Ax + By + Cz + Dw >= 0 であればその平面の半空間内で可視となります。クリッピング平面上または平面の後ろにある点はシーンからクリップされます。

このメソッドが使用する平面方程式はワールド空間に存在し、事前の IDirect3DDevice9::SetClipPlane メソッドの呼び出しによって設定されます。

IDirect3DDevice9::SetRenderState メソッド (d3d9helper.h) は、デバイスのレンダーステートパラメーターを 1 つ設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL が返されます。

IDirect3DDevice9::GetRenderState メソッド (d3d9.h) は、デバイスのレンダーステート値を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。引数のいずれかが無効な場合は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他の値のいずれかを指定してデバイスを作成する必要があります。"

IDirect3DDevice9::CreateStateBlock メソッド (d3d9.h) は、すべてのデバイス状態、頂点関連の状態、またはピクセル関連の状態の値を格納する新しいステートブロックを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

頂点関連のデバイス状態とは、通常、システムが頂点を処理する方法に影響する状態を指します。ピクセル関連の状態とは、一般に、ラスタライズ中にシステムがピクセルデータや深度バッファーデータを処理する方法に影響するデバイス状態を指します。両方のグループに含まれる状態もあります。

IDirect3DDevice9::BeginStateBlock メソッド (d3d9.h) は、デバイスステートブロックの記録を開始するよう Direct3D に指示します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、E_OUTOFMEMORY。

アプリケーションは、このメソッドを呼び出す前に IDirect3DDevice9::ValidateDevice メソッドを呼び出すことで、記録されるすべての状態が有効であることを確認できます。

IDirect3DDevice9::BeginStateBlock を呼び出した後、IDirect3DDevice9::EndStateBlock を呼び出すまでの間に、次のメソッドをステートブロックに記録できます。

• IDirect3DDevice9::LightEnable
• IDirect3DDevice9::SetClipPlane
• IDirect3DDevice9::SetCurrentTexturePalette
• IDirect3DDevice9::SetFVF
• IDirect3DDevice9::SetIndices
• IDirect3DDevice9::SetLight
• IDirect3DDevice9::SetMaterial
• IDirect3DDevice9::SetNPatchMode
• IDirect3DDevice9::SetPixelShader
• IDirect3DDevice9::SetPixelShaderConstantB
• IDirect3DDevice9::SetPixelShaderConstantF
• IDirect3DDevice9::SetPixelShaderConstantI
• IDirect3DDevice9::SetRenderState
• IDirect3DDevice9::SetSamplerState
• IDirect3DDevice9::SetScissorRect
• IDirect3DDevice9::SetStreamSource
• IDirect3DDevice9::SetStreamSourceFreq
• IDirect3DDevice9::SetTexture
• IDirect3DDevice9::SetTextureStageState
• IDirect3DDevice9::SetTransform
• IDirect3DDevice9::SetViewport
• IDirect3DDevice9::SetVertexDeclaration
• IDirect3DDevice9::SetVertexShader
• IDirect3DDevice9::SetVertexShaderConstantB
• IDirect3DDevice9::SetVertexShaderConstantF
• IDirect3DDevice9::SetVertexShaderConstantI

IDirect3DDevice9::EndStateBlock メソッド (d3d9.h) は、デバイスステートブロックの記録を停止してステートブロックインターフェースへのポインターを取得するよう Direct3D に指示します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetClipStatus メソッド (d3d9.h) は、クリップステータスを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。 引数のいずれかが無効な場合、戻り値は D3DERR_INVALIDCALL になります。

クリップステータスはソフトウェア頂点処理中に使用されます。そのため、このメソッドはピュアデバイスおよび非ピュアのハードウェア処理デバイスではサポートされません。ピュアデバイスの詳細については、D3DCREATE を参照してください。

頂点処理中 (IDirect3DDevice9::ProcessVertices、IDirect3DDevice9::DrawPrimitive、その他の描画関数による処理中) にクリッピングが有効な場合、Direct3D はすべての頂点についてクリップコードを計算します。クリップコードは D3DCS_* ビットの組み合わせです。頂点が特定のクリッピング平面の外側にある場合、クリップコードの対応するビットが設定されます。Direct3D は、ClipUnion メンバーと ClipIntersection メンバーを持つ D3DCLIPSTATUS9 を使用してクリップステータスを保持します。ClipUnion はすべての頂点クリップコードのビットごとの「OR」、ClipIntersection はすべての頂点クリップコードのビットごとの「AND」です。初期値は ClipUnion が 0、ClipIntersection が 0xFFFFFFFF です。D3DRS_CLIPPING が FALSE に設定されている場合、ClipUnion と ClipIntersection は 0 に設定されます。Direct3D は描画呼び出しの際にクリップステータスを更新します。特定のオブジェクトについてクリップステータスを計算するには、ClipUnion と ClipIntersection を初期値に設定してから描画を続けてください。

IDirect3DDevice9::DrawRectPatch と IDirect3DDevice9::DrawTriPatch にはソフトウェアエミュレーションがないため、これらではクリップステータスは更新されません。

IDirect3DDevice9::GetClipStatus メソッド (d3d9.h) は、クリップステータスを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。

引数が無効な場合は D3DERR_INVALIDCALL が返されます。

頂点処理中 (IDirect3DDevice9::ProcessVertices、IDirect3DDevice9::DrawPrimitive、その他の描画関数による処理中) にクリッピングが有効な場合、Direct3D はすべての頂点についてクリップコードを計算します。クリップコードは D3DCS_* ビットの組み合わせです。頂点が特定のクリッピング平面の外側にある場合、クリップコードの対応するビットが設定されます。Direct3D は、ClipUnion メンバーと ClipIntersection メンバーを持つ D3DCLIPSTATUS9 を使用してクリップステータスを保持します。ClipUnion はすべての頂点クリップコードのビットごとの「OR」、ClipIntersection はすべての頂点クリップコードのビットごとの「AND」です。初期値は ClipUnion が 0、ClipIntersection が 0xFFFFFFFF です。D3DRS_CLIPPING が FALSE に設定されている場合、ClipUnion と ClipIntersection は 0 に設定されます。Direct3D は描画呼び出しの際にクリップステータスを更新します。特定のオブジェクトについてクリップステータスを計算するには、ClipUnion と ClipIntersection を初期値に設定してから描画を続けてください。

IDirect3DDevice9::DrawRectPatch と IDirect3DDevice9::DrawTriPatch にはソフトウェアエミュレーションがないため、これらではクリップステータスは更新されません。

クリップステータスはソフトウェア頂点処理中に使用されます。そのため、このメソッドはピュアデバイスおよび非ピュアのハードウェア処理デバイスではサポートされません。ピュアデバイスの詳細については、D3DCREATE を参照してください。

IDirect3DDevice9::GetTexture メソッド (d3d9.h) は、デバイスのステージに割り当てられているテクスチャーを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

通常、状態を返すメソッドは D3DCREATE_PUREDEVICE を指定して作成されたデバイスでは機能しません。ただし、このメソッドはインターフェースを返すため、ピュアデバイスでも機能します。

このメソッドを呼び出すと、IDirect3DTexture9 インターフェースの内部参照カウントが増加します。この IDirect3DTexture9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::SetTexture メソッド (d3d9helper.h) は、デバイスのステージにテクスチャーを割り当てます。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

テクスチャーがプール種別 D3DPOOL_SCRATCH で作成されている場合、SetTexture は使用できません。プール種別が D3DPOOL_SYSTEMMEM のテクスチャーについても、DevCaps に D3DDEVCAPS_TEXTURESYSTEMMEMORY が設定されていない限り SetTexture は使用できません。

IDirect3DDevice9::GetTextureStageState メソッド (d3d9.h) は、割り当てられているテクスチャーの状態値を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他のフラグ値のいずれかを指定してデバイスを作成する必要があります。"

IDirect3DDevice9::SetTextureStageState メソッド (d3d9helper.h) は、現在割り当てられているテクスチャーの状態値を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

IDirect3DDevice9::GetSamplerState メソッド (d3d9.h) は、サンプラー状態の値を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスについてはデバイス状態を返しません。このメソッドを使用したい場合は、D3DCREATE の他の値のいずれかを指定してデバイスを作成する必要があります。"

IDirect3DDevice9::SetSamplerState メソッド (d3d9helper.h) は、サンプラー状態の値を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

IDirect3DDevice9::ValidateDevice メソッド (d3d9.h) は、現在のテクスチャーブレンディング処理と引数を 1 パスでレンダリングできるかどうかをデバイスについて報告します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_CONFLICTINGRENDERSTATE、D3DERR_CONFLICTINGTEXTUREFILTER、D3DERR_DEVICELOST、D3DERR_DRIVERINTERNALERROR、D3DERR_TOOMANYOPERATIONS、D3DERR_UNSUPPORTEDALPHAARG、D3DERR_UNSUPPORTEDALPHAOPERATION、D3DERR_UNSUPPORTEDCOLORARG、D3DERR_UNSUPPORTEDCOLOROPERATION、D3DERR_UNSUPPORTEDFACTORVALUE、D3DERR_UNSUPPORTEDTEXTUREFILTER、D3DERR_WRONGTEXTUREFORMAT。

IDirect3DDevice9::ValidateDevice メソッドは、他の機能情報では判断できない場合にのみ、シナリオの検証に使用してください。たとえばマルチステージテクスチャリングのシナリオでは、D3DCAPS9 構造体の MaxTextureBlendStages メンバーと MaxSimultaneousTextures メンバーを調べることで、そのデバイスでマルチステージテクスチャリングが可能かどうかを判別できます。

現在のハードウェアが、処理と引数のあらゆる組み合わせを実装しているとは限りません。特定のブレンディング処理を指定した引数で実行できるかどうかは、目的のブレンディング処理を設定したうえで IDirect3DDevice9::ValidateDevice メソッドを呼び出すことで判別できます。

IDirect3DDevice9::ValidateDevice メソッドは、呼び出し時点の現在のレンダーステート、テクスチャー、テクスチャーステージ状態を使用して検証を行います。呼び出し後にこれらの要素を変更すると以前の結果は無効になるため、シーンをレンダリングする前にこのメソッドを再度呼び出す必要があります。

パフォーマンスを最大化するため、IDirect3DDevice9::ValidateDevice は初期化時に呼び出してください。レンダリングループの中では使用しないでください。

拡散反射の補間値を引数または処理として使用すること (D3DTA_DIFFUSED3DTOP_BLENDDIFFUSEALPHA) は、現在のハードウェアではほとんどサポートされていません。多くのハードウェアでは、補間された色データを導入できるのは最後のテクスチャー処理ステージだけです。

各ステージでは、テクスチャー (D3DTA_TEXTURE) を第 2 引数ではなく第 1 引数として指定するようにしてください。

多くのカードは、任意のテクスチャーステージで拡散反射値やスカラー値を使用することをサポートしていません。多くの場合、これらは最初または最後のテクスチャーブレンディングステージでのみ利用できます。

多くのカードでは、最初のテクスチャーに関連付けられたブレンディングユニットが、アルファをカラーチャンネルに複製するか入力を反転する以上のことを行えません。そのため、可能であればアプリケーションは 2 番目のテクスチャーステージのみを使用する必要があるかもしれません。このようなハードウェアでは、最初のユニットは既定の状態、すなわち第 1 カラー引数が D3DTA_TEXTURE に設定され、処理が D3DTOP_SELECTARG1 である状態とみなされます。

出力アルファに対する処理が、カラー処理より複雑であったり大きく異なっていたりする場合、サポートされない可能性が高くなります。

一部のハードウェアは、D3DTA_TFACTOR と D3DTA_DIFFUSE の同時使用をサポートしていません。

多くのカードは、複数テクスチャーとミップマップのトライリニアフィルタリングの同時使用をサポートしていません。マルチテクスチャーブレンディング処理に関与するテクスチャーに対してトライリニアフィルタリングを要求して検証が失敗した場合は、トライリニアフィルタリングをオフにして再度検証してください。その場合は、代わりにマルチパスレンダリングを行うとよいでしょう。

IDirect3DDevice9::SetPaletteEntries メソッド (d3d9.h) は、パレットエントリを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

Direct3D 9 のアプリケーションでは、このメソッドに渡すパレットは D3DCAPS9 構造体の D3DPTEXTURECAPS_ALPHAPALETTE 機能ビットに従う必要があります。D3DPTEXTURECAPS_ALPHAPALETTE が設定されていない場合、パレットのすべてのエントリのアルファは 1.0 でなければならず、そうでなければこのメソッドは D3DERR_INVALIDCALL で失敗します。D3DPTEXTURECAPS_ALPHAPALETTE が設定されている場合は、任意のアルファ値の組み合わせが許可されます。なお、すべてのパレットエントリのアルファが 0 に設定されている場合、デバッグランタイムは警告メッセージを出力します。

デバイスには論理パレットが 1 つ関連付けられており、すべてのテクスチャーステージで共有されます。

IDirect3DDevice9::GetPaletteEntries メソッド (d3d9.h) は、パレットエントリを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

PALETTEENTRY の詳細については、Platform SDK を参照してください。

IDirect3DDevice9::SetCurrentTexturePalette メソッド (d3d9.h) は、現在のテクスチャーパレットを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

デバイスには論理パレットが 1 つ関連付けられており、すべてのテクスチャーステージで共有されます。

IDirect3DDevice9::GetCurrentTexturePalette メソッド (d3d9.h) は、現在のテクスチャーパレットを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetScissorRect メソッド (d3d9helper.h) は、シザー矩形を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

シザー矩形は矩形のクリッピング領域として使用されます。

DirectX における矩形の使用方法の詳細については、矩形 (Direct3D 9) を参照してください。

IDirect3DDevice9::GetScissorRect メソッド (d3d9.h) は、シザー矩形を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

シザー矩形は矩形のクリッピング領域として使用されます。

DirectX における矩形の使用方法の詳細については、矩形 (Direct3D 9) を参照してください。

IDirect3DDevice9::SetSoftwareVertexProcessing メソッド (d3d9helper.h) を使用すると、ソフトウェア頂点処理モードとハードウェア頂点処理モードを切り替えられます。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

モード変更の制限は次のとおりです (D3DCREATE 定数に関する注意事項も参照してください)。

• デバイスが D3DCREATE_SOFTWARE_VERTEXPROCESSING で作成された場合、頂点処理はソフトウェアで行われ、変更できません。
• デバイスが D3DCREATE_HARDWARE_VERTEXPROCESSING で作成された場合、頂点処理はハードウェアで行われ、変更できません。
• デバイスが D3DCREATE_MIXED_VERTEXPROCESSING で作成された場合、頂点処理は既定でハードウェアで行われます。IDirect3DDevice9::SetSoftwareVertexProcessing を使用して、処理をソフトウェアに (またはハードウェアに戻すように) 切り替えられます。

Direct3D 9 では、代わりに SetSoftwareVertexProcessing を使用してください。この新しい API は StateBlocks には記録されません。

IDirect3DDevice9::GetSoftwareVertexProcessing メソッド (d3d9.h) は、頂点処理モード (ハードウェアまたはソフトウェア) を取得します。

型: BOOL

ソフトウェア頂点処理が設定されている場合は TRUE を返します。それ以外の場合は FALSE を返します。

アプリケーションは混合モードのデバイスを作成することで、ソフトウェア頂点処理とハードウェア頂点処理の両方を使用できます。DirectX 8.x で 2 つの頂点処理モードを切り替えるには、レンダーステート D3DRS_SOFTWAREVERTEXPROCESSING と適切な BOOL 引数を指定して IDirect3DDevice9::SetRenderState を使用していました。レンダーステートによる方法の欠点は、ステートブロックのセマンティクスを定義することが難しい点でした。アプリケーションとランタイムは、ステートブロックの記録と再生の際に追加の作業を行い、注意を払う必要がありました。

Direct3D 9 では、代わりに IDirect3DDevice9::SetSoftwareVertexProcessing を使用してください。この新しい API は StateBlocks には記録されません。

D3DCREATE 定数に関する注意事項も参照してください。

IDirect3DDevice9::SetNPatchMode メソッド (d3d9.h) は、N パッチを有効または無効にします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。

IDirect3DDevice9::GetNPatchMode メソッド (d3d9.h) は、N パッチモードのセグメント数を取得します。

型: FLOAT

分割セグメント数を指定します。セグメント数が 1.0 未満の場合、N パッチは無効になります。既定値は 0.0 です。

IDirect3DDevice9::DrawPrimitive メソッド (d3d9.h) は、現在のデータ入力ストリーム一式から、指定した種類の非インデックス幾何プリミティブの並びをレンダリングします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

従来のアプリケーションを Direct3D 9 に移行する場合は、Draw 系の呼び出しを行う前に、固定機能パイプラインを使用するための IDirect3DDevice9::SetFVF か、頂点シェーダーを使用するための IDirect3DDevice9::SetVertexDeclaration のいずれかの呼び出しを追加する必要があります。

IDirect3DDevice9::DrawIndexedPrimitive メソッド (d3d9.h) は、指定した幾何プリミティブを頂点の配列にレンダリングします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

このメソッドは、現在のデータ入力ストリーム一式からインデックス付きプリミティブを描画します。MinIndex およびインデックスストリーム内のすべてのインデックスは、BaseVertexIndex を基準とします。

MinIndex と NumVertices の各パラメーターは、IDirect3DDevice9::DrawIndexedPrimitive の各呼び出しで使用される頂点インデックスの範囲を指定します。これらは、頂点をインデックス参照する前に連続した範囲の頂点を処理することで、インデックス付きプリミティブの頂点処理を最適化するために使用されます。この呼び出しで使用されるインデックスが、この範囲外の頂点を参照することは無効です。

インデックス配列が設定されていない場合、IDirect3DDevice9::DrawIndexedPrimitive は失敗します。

D3DPRIMITIVETYPE 列挙型の D3DPT_POINTLIST メンバーはサポートされておらず、このメソッドで有効な種類ではありません。

従来のアプリケーションを Direct3D 9 に移行する場合は、Draw 系の呼び出しを行う前に、固定機能パイプラインを使用するための IDirect3DDevice9::SetFVF か、頂点シェーダーを使用するための IDirect3DDevice9::SetVertexDeclaration のいずれかの呼び出しを追加する必要があります。

IDirect3DDevice9::DrawPrimitiveUP メソッド (d3d9.h) は、ユーザーメモリのポインターで指定されたデータを、指定した種類の幾何プリミティブの並びとしてレンダリングします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

このメソッドは、頂点データを頂点バッファーに格納できないアプリケーションでの使用を想定しています。このメソッドがサポートする頂点ストリームは 1 つだけです。この呼び出しの効果は、指定された頂点データのポインターとストライドを頂点ストリーム 0 として使用することです。現在の頂点シェーダーの宣言がストリーム 0 以外の頂点ストリームを参照していることは無効です。

IDirect3DDevice9::DrawPrimitiveUP の呼び出し後は、IDirect3DDevice9::GetStreamSource が参照するストリーム 0 の設定は NULL に設定されます。

IDirect3DDevice9::DrawPrimitiveUP に渡した頂点データは、呼び出し後まで保持しておく必要はありません。Direct3D は呼び出しから戻る前にそのデータへのアクセスを完了します。

従来のアプリケーションを Direct3D 9 に移行する場合は、Draw 系の呼び出しを行う前に、固定機能パイプラインを使用するための IDirect3DDevice9::SetFVF か、頂点シェーダーを使用するための IDirect3DDevice9::SetVertexDeclaration のいずれかの呼び出しを追加する必要があります。

IDirect3DDevice9::DrawIndexedPrimitiveUP メソッド (d3d9.h) は、ユーザーメモリのポインターで指定されたデータを使用して、指定した幾何プリミティブをレンダリングします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

このメソッドは、頂点データを頂点バッファーに格納できないアプリケーションでの使用を想定しています。このメソッドがサポートする頂点ストリームは 1 つだけで、ストリーム 0 として宣言されている必要があります。

IDirect3DDevice9::DrawIndexedPrimitiveUP の呼び出し後は、IDirect3DDevice9::GetStreamSource が参照するストリーム 0 の設定は NULL に設定されます。また、IDirect3DDevice9::SetIndices のインデックスバッファー設定も NULL に設定されます。

IDirect3DDevice9::DrawIndexedPrimitiveUP に渡した頂点データは、呼び出し後まで保持しておく必要はありません。Direct3D は呼び出しから戻る前にそのデータへのアクセスを完了します。

従来のアプリケーションを Direct3D 9 に移行する場合は、Draw 系の呼び出しを行う前に、固定機能パイプラインを使用するための IDirect3DDevice9::SetFVF か、頂点シェーダーを使用するための IDirect3DDevice9::SetVertexDeclaration のいずれかの呼び出しを追加する必要があります。

IDirect3DDevice9::ProcessVertices メソッド (d3d9.h) は、頂点シェーダーで定義された頂点処理を入力データストリーム一式に適用します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドの処理順序は次のとおりです。

• ワールド行列 + ビュー行列 + 射影行列を使用して、頂点を射影空間へ変換します。
• ビューポートの設定を使用してスクリーン座標を計算します。
• クリッピングが有効な場合、クリッピングコードを計算し、出力先頂点バッファーに関連付けられた内部バッファーに格納します。頂点がビューフラスタム内にある場合は、そのスクリーン座標が計算されます。頂点がビューフラスタム外にある場合、その頂点は射影空間の座標のまま出力先頂点バッファーに格納されます。
• その他の注意点: ユーザーは内部のクリップコードバッファーにアクセスできません。三角形やその他のプリミティブに対するクリッピングは行われません。

Direct3D がテクスチャー座標を生成する場合、または入力テクスチャー座標をコピーもしくは変換する場合において、出力テクスチャー座標のフォーマットが Direct3D の生成する数より多くのテクスチャー座標成分を定義しているとき、Direct3D はそれらの余分な成分を変更しません。

IDirect3DDevice9::CreateVertexDeclaration メソッド (d3d9.h) は、デバイスと頂点要素から頂点シェーダー宣言を作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

DirectX の各バージョン間で頂点宣言をどのように対応付けるかの詳細な説明については、頂点宣言 (Direct3D 9) のページを参照してください。

IDirect3DDevice9::SetVertexDeclaration メソッド (d3d9helper.h) は、頂点宣言 (Direct3D 9) を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。 戻り値は D3DERR_INVALIDCALL になることがあります。

頂点宣言は、頂点のデータメンバー (テクスチャー座標、色、法線など) を定義する IDirect3DVertexDeclaration9 オブジェクトです。このデータは、頂点シェーダーとピクセルシェーダーを実装する際に役立ちます。

IDirect3DDevice9::GetVertexDeclaration メソッド (d3d9.h) は、頂点シェーダー宣言を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。 戻り値は D3DERR_INVALIDCALL になることがあります。

IDirect3DDevice9::SetFVF メソッド (d3d9.h) は、現在の頂点ストリーム宣言を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

位置、拡散反射色と鏡面反射色、およびテクスチャー座標を持つ頂点を初期化して使用する手順は次のとおりです。

1. カスタム頂点型と FVF コードを定義します。

   
   struct LVertex
   {
       FLOAT    x, y, z;
       D3DCOLOR specular, diffuse;
       FLOAT    tu, tv;
   };
       
   const DWORD VertexFVF = (D3DFVF_XYZ | D3DFVF_DIFFUSE |
                            D3DFVF_SPECULAR | D3DFVF_TEX1 );
   

2. IDirect3DDevice9::CreateVertexBuffer を使用して、4 頂点分の領域を持つ頂点バッファーを作成します。

   
   g_d3dDevice->CreateVertexBuffer( 4*sizeof(LVertex),  
       D3DUSAGE_WRITEONLY, VertexFVF, D3DPOOL_DEFAULT, &pBigSquareVB, NULL );
   

3. 各頂点の値を設定します。

   
   LVertex * v;
   pBigSquareVB->Lock( 0, 0, (BYTE**)&v, 0 );
       
   v[0].x  = 0.0f;  v[0].y  = 10.0;  v[0].z  = 10.0f;
   v[0].diffuse  = 0xffff0000;
   v[0].specular = 0xff00ff00;
   v[0].tu = 0.0f;  v[0].tv = 0.0f;
       
   v[1].x  = 0.0f;  v[1].y  = 0.0f;  v[1].z  = 10.0f;
   v[1].diffuse  = 0xff00ff00;
   v[1].specular = 0xff00ffff;
   v[1].tu = 0.0f;  v[1].tv = 0.0f;
       
   v[2].x  = 10.0f; v[2].y  = 10.0f; v[2].z  = 10.0f;
   v[2].diffuse  = 0xffff00ff;
   v[2].specular = 0xff000000;
   v[2].tu = 0.0f;  v[2].tv = 0.0f;
       
   v[3].x  = 0.0f; v[3].y  = 10.0f;  v[3].z = 10.0f;
   v[3].diffuse  = 0xffffff00;
   v[3].specular = 0xffff0000;
   v[3].tu = 0.0f; v[3].tv = 0.0f;
       
   pBigSquareVB->Unlock();
   

4. 頂点バッファーが初期化され、レンダリングの準備が整いました。次のコード例は、従来の FVF を使用して正方形を描画する方法を示しています。

   
   g_d3dDevice->SetFVF(VertexFVF);
   g_d3dDevice->SetStreamSource(0, pBigSquareVB, 0, sizeof(LVertex));
   g_d3dDevice->DrawPrimitive(D3DPT_TRIANGLESTRIP, 0 ,2);
   

1. カスタム頂点型と FVF コードを定義します。

   
   struct Vertex
   {
       FLOAT x, y, z;
       FLOAT nx, ny, nz;
       FLOAT tu, tv;
   };
       
   const DWORD VertexFVF = ( D3DFVF_XYZ | D3DFVF_NORMAL | D3DFVF_TEX1 );
   

2. IDirect3DDevice9::CreateVertexBuffer を使用して、4 頂点分の領域を持つ頂点バッファーを作成します (上の例と同様)。
3. 各頂点の値を設定します。

   
   Vertex * v;
   pBigSquareVB->Lock(0, 0, (BYTE**)&v, 0);
       
   v[0].x  = 0.0f;  v[0].y  = 10.0;  v[0].z  = 10.0f;
   v[0].nx = 0.0f;  v[0].ny = 1.0f;  v[0].nz = 0.0f;
   v[0].tu = 0.0f;  v[0].tv = 0.0f;
   
   v[1].x  = 0.0f;  v[1].y  = 0.0f;  v[1].z  = 10.0f;
   v[1].nx = 0.0f;  v[1].ny = 1.0f;  v[1].nz = 0.0f;
   v[1].tu = 0.0f;  v[1].tv = 0.0f;
       
   v[2].x  = 10.0f; v[2].y  = 10.0f; v[2].z  = 10.0f;
   v[2].nx = 0.0f;  v[2].ny = 1.0f;  v[2].nz = 0.0f;
   v[2].tu = 0.0f;  v[2].tv = 0.0f;
       
   v[3].x  = 0.0f; v[3].y  = 10.0f;  v[3].z = 10.0f;
   v[3].nx = 0.0f; v[3].ny = 1.0f;   v[3].nz = 0.0f;
   v[3].tu = 0.0f; v[3].tv = 0.0f;
       
   pBigSquareVB->Unlock();
   

4. オブジェクトを描画します (上の例と同様)。

IDirect3DDevice9::GetFVF メソッド (d3d9.h) は、固定機能頂点宣言を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

固定機能頂点宣言は、固定機能パイプラインで処理される頂点をどのように使用するかを決定する FVF フラグの集合です。

IDirect3DDevice9::CreateVertexShader メソッド (d3d9.h) は、頂点シェーダーを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、E_OUTOFMEMORY。

デバイスの作成時、IDirect3D9::CreateDevice は動作フラグを使用して、頂点をハードウェアで処理するかソフトウェアで処理するかを決定します。次の 3 つの選択肢があります。

• D3DCREATE_HARDWARE_VERTEXPROCESSING を設定して、頂点をハードウェアで処理する。
• D3DCREATE_SOFTWARE_VERTEXPROCESSING を設定して、頂点をソフトウェアで処理する。
• D3DCREATE_MIXED_VERTEXPROCESSING を設定して、頂点をハードウェアまたはソフトウェアのいずれかで処理する。混合モードのデバイスでソフトウェア処理とハードウェア処理を切り替えるには、IDirect3DDevice9::SetSoftwareVertexProcessing を使用します。

IDirect3DDevice9::SetVertexShader メソッド (d3d9helper.h) は、頂点シェーダーを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

(プログラマブル頂点シェーダーを設定した後に) 固定機能の頂点シェーダーを設定するには、IDirect3DDevice9::SetVertexShader(NULL) を呼び出してプログラマブルシェーダーを解放し、その後、固定機能の頂点フォーマットを指定して IDirect3DDevice9::SetFVF を呼び出します。

IDirect3DDevice9::GetVertexShader メソッド (d3d9.h) は、現在設定されている頂点シェーダーを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。 ppShader が無効な場合は D3DERR_INVALIDCALL が返されます。

通常、状態を返すメソッドは D3DCREATE_PUREDEVICE を指定して作成されたデバイスでは機能しません。ただし、このメソッドはインターフェースを返すため、ピュアデバイスでも機能します。

IDirect3DDevice9::SetVertexShaderConstantF メソッド (d3d9helper.h) は、浮動小数点型の頂点シェーダー定数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetVertexShaderConstantF メソッド (d3d9.h) は、浮動小数点型の頂点シェーダー定数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetVertexShaderConstantI メソッド (d3d9helper.h) は、整数型の頂点シェーダー定数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetVertexShaderConstantI メソッド (d3d9.h) は、整数型の頂点シェーダー定数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetVertexShaderConstantB メソッド (d3d9helper.h) は、ブール型の頂点シェーダー定数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetVertexShaderConstantB メソッド (d3d9.h) は、ブール型の頂点シェーダー定数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetStreamSource メソッド (d3d9helper.h) は、頂点バッファーをデバイスのデータストリームにバインドします。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

FVF 頂点シェーダーを使用する場合、頂点ストリームのストライドは FVF から算出される頂点サイズと一致していなければなりません。宣言を使用する場合、ストライドは宣言から算出されるストリームサイズ以上である必要があります。

SetStreamSource を呼び出す際、通常はストライドが頂点サイズと等しいことが求められます。ただし、同一または類似のジオメトリの複数インスタンスを描画したい場合 (インスタンシングを使用して描画する場合など) もあります。そのような場合は、ストライドに 0 を指定して、頂点バッファーのオフセットを進めないようランタイムに指示します (つまり、すべてのインスタンスで同じ頂点データを使用します)。インスタンシングの詳細については、ジオメトリの複数インスタンスの効率的な描画 (Direct3D 9) を参照してください。

IDirect3DDevice9::GetStreamSource メソッド (d3d9.h) は、指定したデータストリームにバインドされている頂点バッファーを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

ストリームとは、コンポーネントデータの一様な配列として定義されます。各コンポーネントは、位置、法線、色などの単一の要素を表す 1 つ以上の要素で構成されます。

FVF 頂点シェーダーを使用する場合、頂点ストリームのストライドは FVF から算出される頂点サイズと一致していなければなりません。宣言を使用する場合、ストライドは宣言から算出されるストリームサイズ以上である必要があります。

このメソッドを呼び出すと、IDirect3DVertexBuffer9 インターフェースの内部参照カウントが増加します。この IDirect3DVertexBuffer9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::SetStreamSourceFreq メソッド (d3d9helper.h) は、ストリームソースの周波数分周値を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

d3d9types.h には、SetStreamSourceFreq と組み合わせて使用するために設計された 2 つの定数、D3DSTREAMSOURCE_INDEXEDDATA と D3DSTREAMSOURCE_INSTANCEDATA が定義されています。これらの定数の使用方法については、ジオメトリの複数インスタンスの効率的な描画 (Direct3D 9) を参照してください。

IDirect3DDevice9::GetStreamSourceFreq メソッド (d3d9.h) は、ストリームソースの周波数分周値を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

頂点シェーダーは、1 頂点につき複数回呼び出せるようになりました。非インデックスジオメトリの描画を参照してください。

IDirect3DDevice9::SetIndices メソッド (d3d9.h) は、インデックスデータを設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

アプリケーションがこのインターフェースへの参照を保持しなくなると、インターフェースは自動的に解放されます。

IDirect3DDevice9::SetIndices メソッドは、現在のインデックス配列をインデックスバッファーに設定します。この単一のインデックス集合が、すべてのストリームのインデックス参照に使用されます。

IDirect3DDevice9::GetIndices メソッド (d3d9.h) は、インデックスデータを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドを呼び出すと、IDirect3DIndexBuffer9 インターフェースの内部参照カウントが増加します。この IDirect3DIndexBuffer9 インターフェースの使用を終えたときに IUnknown::Release を呼び出さないと、メモリリークが発生します。

IDirect3DDevice9::CreatePixelShader メソッド (d3d9.h) は、ピクセルシェーダーを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のいずれかになります: D3DERR_INVALIDCALL、D3DERR_OUTOFVIDEOMEMORY、 E_OUTOFMEMORY。

IDirect3DDevice9::SetPixelShader メソッド (d3d9.h) は、事前に作成したピクセルシェーダーを現在のピクセルシェーダーとして設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

IDirect3DDevice9::GetPixelShader メソッド (d3d9.h) は、現在設定されているピクセルシェーダーを取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_INVALIDCALL になります。

このメソッドは、D3DCREATE_PUREDEVICE を指定して作成されたデバイスでは機能しません。

IDirect3DDevice9::SetPixelShaderConstantF メソッド (d3d9helper.h) は、浮動小数点型のシェーダー定数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetPixelShaderConstantF メソッド (d3d9.h) は、浮動小数点型のシェーダー定数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetPixelShaderConstantI メソッド (d3d9helper.h) は、整数型のシェーダー定数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetPixelShaderConstantI メソッド (d3d9.h) は、整数型のシェーダー定数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::SetPixelShaderConstantB メソッド (d3d9.h) は、ブール型のシェーダー定数を設定します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::GetPixelShaderConstantB メソッド (d3d9.h) は、ブール型のシェーダー定数を取得します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::DrawRectPatch メソッド (d3d9.h) は、現在設定されているストリームを使用して矩形パッチを描画します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

静的パッチの場合: 頂点シェーダーを設定し、適切なストリームを設定して、pRectPatchInfo パラメーターにパッチ情報を指定し、Direct3D が情報を取得してキャッシュできるようにハンドルを指定します。その後、pRectPatchInfo を NULL に設定して IDirect3DDevice9::DrawRectPatch を呼び出すと、パッチを効率的に描画できます。キャッシュされたパッチを描画する際、現在設定されているストリームは無視されます。キャッシュされた pNumSegs を上書きするには、pNumSegs に新しい値を指定します。キャッシュされたパッチをレンダリングする際は、そのパッチを取得したときに設定していたものと同じ頂点シェーダーを設定する必要があります。

ハンドルを指定して IDirect3DDevice9::DrawRectPatch を呼び出すと、以前の IDirect3DDevice9::DrawTriPatch の呼び出しで同じハンドルによりキャッシュされた情報は無効になります。

動的パッチの場合、パッチをレンダリングするたびにパッチデータが変化するため、情報をキャッシュしても効率的ではありません。アプリケーションは Handle を 0 に設定することで、このことを Direct3D に伝えられます。この場合、Direct3D は現在設定されているストリームと pNumSegs の値を使用してパッチを描画し、情報は一切キャッシュしません。Handle を 0 に設定すると同時に pRectPatchInfo を NULL に設定することはできません。

IDirect3DDevice9::DrawTriPatch メソッド (d3d9.h) は、現在設定されているストリームを使用して三角形パッチを描画します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

静的パッチの場合: 頂点シェーダーを設定し、適切なストリームを設定して、pTriPatchInfo パラメーターにパッチ情報を指定し、Direct3D が情報を取得してキャッシュできるようにハンドルを指定します。パッチを効率的に描画するには、pTriPatchInfo を NULL に設定して IDirect3DDevice9::DrawTriPatch を呼び出します。キャッシュされたパッチを描画する際、現在設定されているストリームは無視されます。キャッシュされた pNumSegs を上書きするには、pNumSegs に新しい値を指定します。キャッシュされたパッチをレンダリングする際は、そのパッチを取得したときに設定していたものと同じ頂点シェーダーを設定する必要があります。

ハンドルを指定して IDirect3DDevice9::DrawTriPatch を呼び出すと、以前の IDirect3DDevice9::DrawRectPatch の呼び出しで同じハンドルによりキャッシュされた情報は無効になります。

動的パッチの場合、パッチをレンダリングするたびにパッチデータが変化するため、情報をキャッシュしても効率的ではありません。アプリケーションは Handle を 0 に設定することで、このことを Direct3D に伝えられます。この場合、Direct3D は現在設定されているストリームと pNumSegs の値を使用してパッチを描画し、情報は一切キャッシュしません。Handle を 0 に設定すると同時に pTriPatchInfo を NULL に設定することはできません。

IDirect3DDevice9::DeletePatch メソッド (d3d9.h) は、キャッシュされた高次パッチを解放します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は次のようになります: D3DERR_INVALIDCALL。

IDirect3DDevice9::CreateQuery メソッド (d3d9.h) は、状態クエリを作成します。

型: HRESULT

メソッドが成功した場合、戻り値は D3D_OK です。メソッドが失敗した場合、戻り値は D3DERR_NOTAVAILABLE または E_OUTOFMEMORY になります。

このメソッドは、同期クエリと非同期クエリの両方に対応しています。Direct3D 9 でサポートされなくなった GetInfo に代わるものです。

同期クエリと非同期クエリは、D3DQUERYTYPE を指定して IDirect3DDevice9::CreateQuery で作成します。クエリを作成し、問い合わせ対象の API 呼び出しを行った後は、IDirect3DQuery9::Issue でクエリを発行し、IDirect3DQuery9::GetData でクエリの結果を取得します。