Microsoft DirectX 8.0 (C++)

IDirectInputEffect::Start

エフェクトの再生を開始する。エフェクトが既に再生中ならば、最初から開始される。エフェクトがダウンロードされていないか、または前回のダウンロード以来、変更されている場合は、開始前にエフェクトがダウンロードされる。この処理はデフォルトで行われる。これを抑制するには、DIES_NODOWNLOAD フラグを渡せばよい。

HRESULT Start(
  DWORD dwIterations,  
  DWORD dwFlags        
);

パラメータ

dwIterations
連続してエフェクトを再生する回数。エンベロープは、補間ごとに再調整される。

エフェクトを一度だけ再生するには、1 を渡す。明示的に停止させられるまで反復再生するには、INFINITE を渡す。エンベロープを再調整しないで、明示的に停止されるまでエフェクトを再生するには、IDirectInputEffect::SetParameters メソッドを使用してエフェクト パラメータを修正した後、その dwDuration メンバを INFINITE に変更する。

dwFlags
デバイスがエフェクトをどのように再生するかを表すフラグ。値はゼロまたは次のフラグのいずれかを指定する。
DIES_SOLO
指定されたエフェクトが再生される前に、デバイス上のほかのすべてのエフェクトを停止する。このフラグを省略すると、エフェクトは、デバイス上で既に再生が始まっている既存のエフェクトと混合されることになる。
DIES_NODOWNLOAD
エフェクトの自動ダウンロードを行わない。

戻り値

成功した場合は、DI_OK を返す。

失敗した場合は、次のいずれかのエラー値を返す。

DIERR_INCOMPLETEEFFECT
DIERR_INVALIDPARAM
DIERR_NOTEXCLUSIVEACQUIRED
DIERR_NOTINITIALIZED
DIERR_UNSUPPORTED

注意

このメソッドを成功させるには、デバイスを排他協調レベルで取得しなければならない。

複数回の補間をサポートしないデバイスもある。

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : dinput.h で宣言。