ホーム › Devices.HumanInterfaceDevice › IDirectInputEffectDriver

IDirectInputEffectDriver

COM

📘 Microsoft Learn (日本語) · English

IID02538130-898f-11d0-9ad0-00a0c9a06e35継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

これら 3 つのメソッドにより、元のインターフェイスの機能に影響を与えることなく、DirectInputEffectDriver オブジェクトに追加のインターフェイスを追加できます。

メソッド 11

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT DeviceID(DWORD param0, DWORD param1, DWORD param2, DWORD param3, void* param4)

IDirectInputEffectDriver::DeviceID メソッドは、デバイスの識別情報をドライバーに送信します。

param0	DWORD	in	対象デバイスの外部識別子(外部ID)。
param1	DWORD	in	デバイスの新規割り当てか解放かを示すフラグ。
param2	DWORD	in	内部デバイスID。ドライバ内でデバイスを識別する番号。
param3	DWORD	in	デバイスの種別やプラグイン番号を示す値。
param4	void*	inout	デバイス固有情報を格納したバッファへのポインタ。NULL可。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

解説(Remarks)

IDirectInputEffectDriver::DeviceID メソッドの例として、デバイスドライバーに dwExternalID = 2、dwInternalId = 1 が渡された場合、デバイス上のユニット 1 は ID が 2 のジョイスティックに対応します。

vtbl 4 HRESULT GetVersions(DIDRIVERVERSIONS* param0)

IDirectInputEffectDriver::GetVersions メソッドは、フォースフィードバックのハードウェアおよびドライバーに関するバージョン情報を取得します。

param0

DIDRIVERVERSIONS*

inout

ドライバとファームウェアのバージョン情報を受け取るDIDRIVERVERSIONS構造体へのポインタ。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 5 HRESULT Escape(DWORD param0, DWORD param1, DIEFFESCAPE* param2)

IDirectInputEffectDriver::Escape メソッドは、ドライバーへエスケープします。このメソッドは、アプリケーションが IDirectInputEffect::Escape または IDirectInputDevice::Escape メソッドを呼び出したことに応答して呼び出されます。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	対象エフェクトのドライバ内識別子。
param2	DIEFFESCAPE*	inout	ドライバ固有拡張コマンドを格納したDIEFFESCAPE構造体へのポインタ。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 6 HRESULT SetGain(DWORD param0, DWORD param1)

IDirectInputEffectDriver::SetGain メソッドは、デバイス全体のゲインを設定します。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	デバイス全体のゲイン値。0〜10000の範囲で指定する。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 7 HRESULT SendForceFeedbackCommand(DWORD param0, DWORD param1)

IDirectInputEffectDriver::SendForceFeedbackCommand メソッドは、デバイスのフォースフィードバック状態を変更します。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	送信するFFコマンドフラグ。DISFFC_RESET/DISFFC_STOPALL等。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 8 HRESULT GetForceFeedbackState(DWORD param0, DIDEVICESTATE* param1)

IDirectInputEffectDriver::GetForceFeedbackState メソッドは、デバイスのフォースフィードバック状態を取得します。

param0	DWORD	in	対象デバイスの内部ID。
param1	DIDEVICESTATE*	inout	FF状態を受け取るDIDEVICESTATE構造体へのポインタ。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 9 HRESULT DownloadEffect(DWORD param0, DWORD param1, DWORD* param2, DIEFFECT* param3, DWORD param4)

IDirectInputEffectDriver::DownloadEffect メソッドは、エフェクトをデバイスに送信します。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	エフェクト種別を示す値。
param2	DWORD*	inout	入出力。ダウンロード先エフェクトのドライバ内IDを受け渡すポインタ。0で新規割り当て。
param3	DIEFFECT*	inout	ダウンロードするエフェクトのパラメータを格納したDIEFFECT構造体へのポインタ。
param4	DWORD	in	更新範囲を示すフラグ。DIEP_*値の組み合わせを指定する。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラー値を返します。

vtbl 10 HRESULT DestroyEffect(DWORD param0, DWORD param1)

IDirectInputEffectDriver::DestroyEffect メソッドは、デバイスからエフェクトを削除します。エフェクトが再生中の場合、ドライバーはアンロードする前にそれを停止する必要があります。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	破棄するエフェクトのドライバ内ID。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 11 HRESULT StartEffect(DWORD param0, DWORD param1, DWORD param2, DWORD param3)

IDirectInputEffectDriver::StartEffect メソッドは、エフェクトの再生を開始します。エフェクトが既に再生中の場合は、最初から再開されます。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	開始するエフェクトのドライバ内ID。
param2	DWORD	in	動作モードフラグ。DIES_SOLO等を指定する。
param3	DWORD	in	再生する反復回数。INFINITEで無限再生。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 12 HRESULT StopEffect(DWORD param0, DWORD param1)

IDirectInputEffectDriver::StopEffect メソッドは、エフェクトの再生を停止します。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	停止するエフェクトのドライバ内ID。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

vtbl 13 HRESULT GetEffectStatus(DWORD param0, DWORD param1, DWORD* param2)

IDirectInputEffectDriver::GetEffectStatus メソッドは、エフェクトの状態に関する情報を取得します。

param0	DWORD	in	対象デバイスの内部ID。
param1	DWORD	in	状態を取得するエフェクトのドライバ内ID。
param2	DWORD*	inout	エフェクトの状態フラグを受け取るDWORDへのポインタ。DIEGES_PLAYING等を返す。

戻り値

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IDirectInputEffectDriver "{02538130-898F-11D0-9AD0-00A0C9A06E35}"
#usecom global IDirectInputEffectDriver IID_IDirectInputEffectDriver "{}"
#comfunc global IDirectInputEffectDriver_DeviceID                  3 int,int,int,int,sptr
#comfunc global IDirectInputEffectDriver_GetVersions               4 var
#comfunc global IDirectInputEffectDriver_Escape                    5 int,int,var
#comfunc global IDirectInputEffectDriver_SetGain                   6 int,int
#comfunc global IDirectInputEffectDriver_SendForceFeedbackCommand  7 int,int
#comfunc global IDirectInputEffectDriver_GetForceFeedbackState     8 int,var
#comfunc global IDirectInputEffectDriver_DownloadEffect            9 int,int,var,var,int
#comfunc global IDirectInputEffectDriver_DestroyEffect             10 int,int
#comfunc global IDirectInputEffectDriver_StartEffect               11 int,int,int,int
#comfunc global IDirectInputEffectDriver_StopEffect                12 int,int
#comfunc global IDirectInputEffectDriver_GetEffectStatus           13 int,int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDirectInputEffectDriver "{02538130-898F-11D0-9AD0-00A0C9A06E35}"
#usecom global IDirectInputEffectDriver IID_IDirectInputEffectDriver "{}"
#comfunc global IDirectInputEffectDriver_DeviceID                  3 int,int,int,int,sptr
#comfunc global IDirectInputEffectDriver_GetVersions               4 sptr
#comfunc global IDirectInputEffectDriver_Escape                    5 int,int,sptr
#comfunc global IDirectInputEffectDriver_SetGain                   6 int,int
#comfunc global IDirectInputEffectDriver_SendForceFeedbackCommand  7 int,int
#comfunc global IDirectInputEffectDriver_GetForceFeedbackState     8 int,sptr
#comfunc global IDirectInputEffectDriver_DownloadEffect            9 int,int,sptr,sptr,int
#comfunc global IDirectInputEffectDriver_DestroyEffect             10 int,int
#comfunc global IDirectInputEffectDriver_StartEffect               11 int,int,int,int
#comfunc global IDirectInputEffectDriver_StopEffect                12 int,int
#comfunc global IDirectInputEffectDriver_GetEffectStatus           13 int,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。