IDirectInputDevice8::EnumEffects
デバイス上のフォース フィードバック システムによってサポートされるエフェクトをすべて列挙します。列挙される GUID は、定義済みのエフェクトを示すことも、デバイス製造元に固有のエフェクトを示すこともあります。
HRESULT
EnumEffects(
LPDIENUMEFFECTSCALLBACK lpCallback,
LPVOID pvRef,
DWORD dwEffType
);
パラメータ
- lpCallback
アプリケーション定義のコールバック関数のアドレス。この関数の宣言は、DIEnumEffectsCallback プロトタイプの宣言に準拠している必要があります。 - pvRef
コールバック関数に渡す、32 ビットのアプリケーション定義の値。このパラメーターはどの 32 ビット型でも構いませんが、便利のために LPVOID として宣言されます。 - dwEffType
エフェクトの種類のフィルター。列挙するエフェクトの種類を示すには DIEFT_* 値のいずれかを使用し、すべての種類のエフェクトを列挙するには DIEFT_ALL を使用します。これらの値のリストについては、「DIEffectInfo」を参照してください。
戻り値
メソッドが正常に実行された場合、戻り値は DI_OK です。メソッドが失敗した場合、戻り値は次のいずれかのエラー値です。
DIERR_INVALIDPARAM DIERR_NOTINITIALIZED
解説
コールバックによる列挙が途中で停止した場合、列挙は正常に実行されたと見なされます。
アプリケーションは、DIEffectInfo 構造体の dwEffType メンバーを使用してエフェクトの一般情報、たとえばエフェクトの種類や、エフェクトがサポートするエンベロープと条件パラメーターなどを取得できます。
エフェクトを最大限に活用するには、デバイスの製造元に連絡して、エフェクトのセマンティクスと、エフェクト固有のパラメーターについての情報を入手してください。
要件
ヘッダー: Dinput.h 宣言