Platform SDK: DirectX

IDirectInputDevice7::EnumEffects

IDirectInputDevice7::EnumEffects メソッドは、デバイス上のフォース フィードバック システムがサポートするエフェクトをすべて列挙する。列挙される GUID は、デバイス メーカー独自のエフェクトに加えて、事前定義されたエフェクトも表すことができる。

HRESULT EnumEffects(
  LPDIENUMEFFECTSCALLBACK lpCallback,  
  LPVOID pvRef,                        
  DWORD dwEffType                      
);

パラメータ

lpCallback
アプリケーション定義のコールバック関数のアドレス。この関数の宣言は、DIEnumEffectsCallback プロトタイプの宣言と同様に行わなければならない。
pvRef
コールバック関数に渡すアプリケーション定義の 32 ビットの値。このパラメータには、任意の 32 ビットの値を使用できる。ただし、便宜上、LPVOID と宣言されている。
dwEffType
エフェクト タイプのフィルタ。DIEFT_* 値の 1 つを使用して列挙するエフェクト タイプを指示するか、あるいは DIEFT_ALL を使用してすべてのエフェクト タイプを列挙する。これらの値のリストについては、「DIEFFECTINFO」を参照すること。

戻り値

成功すれば DI_OK を返す。

失敗すれば次のエラー値のいずれかを返す。

DIERR_INVALIDPARAM
DIERR_NOTINITIALIZED

コールバック関数が列挙を途中で停止すると、その列挙は成功したと見なされる。

注意

アプリケーションは、DIEFFECTINFO 構造体の dwEffType メンバを使用して、エフェクトのタイプ、エフェクトがサポートしているエンベロープと条件パラメータが何であるか、などエフェクトの一般的情報を取得できる。

エフェクトを最大限に利用するには、デバイス メーカーに問い合わせて、エフェクトの意味内容とそのエフェクト固有のパラメータに関する情報を入手しなければならない。

動作環境

  Windows NT/2000 :Windows 2000 が必要。
  Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
  ヘッダー : dinput.h で宣言。
  インポート ライブラリ : dinput.lib を使用。