IDirectDrawStreamSample インターフェイス

IDirectDrawStreamSample インターフェイスは、現在のストリーム サンプルに関連付けられた Microsoft® DirectDraw® サーフェスへのポインタを設定および取得するメソッドを提供する。

このインターフェイスは、アプリケーション開発者による実装を目的としたものではない。DirectDraw ストリームによって作成されたサンプル オブジェクトで公開される。

アプリケーションから、クリッピング矩形を設定し、DirectDraw ストリーム サンプル用のレンダリング サーフェスを取得するには、このインターフェイスを使用する。

vtable 順のメソッド

IUnknown メソッド	説明
QueryInterface	サポートされているインターフェイスへのポインタを取得する。
AddRef	参照カウントをインクリメントする。
Release	参照カウントをデクリメントする。
IDirectDrawStreamSample メソッド	説明
GetSurface	現在のサンプルの DirectDraw サーフェスへのポインタ、および関連付けられた矩形へのポインタを取得する。
SetRect	サンプルのクリッピング矩形を変更する。

IDirectDrawStreamSample::GetSurface

---

IDirectDrawStreamSample インターフェイス

現在のサンプルの DirectDraw サーフェスへのポインタ、および関連付けられた矩形へのポインタを取得する。

構文

HRESULT GetSurface(

  IDirectDrawSurface **ppDirectDrawSurface,

  RECT *pRect

  );

パラメータ

ppDirectDrawSurface

[out] サンプルの新しいサーフェスを指定する IDirectDrawSurface インターフェイスへのポインタのアドレス。新しいサーフェスを指定しない場合は、このパラメータを NULL に設定する。

pRect

[out] 現在のサンプルのクリッピング矩形が格納される RECT 構造体へのポインタ。クリッピング矩形を取得しない場合は、このパラメータを NULL に設定する。

戻り値

HRESULT 値を返す。

注意

どちらのパラメータも省略可能である。このインターフェイスの実装はすべて、NULL を有効なパラメータと見なす必要がある。サーフェス ポインタを取得する場合、メソッド側でその参照カウントがインクリメントされるので、呼び出し元で参照を解放すること。

IDirectDrawStreamSample::SetRect

---

IDirectDrawStreamSample インターフェイス

サンプルのクリッピング矩形を変更する。

構文

HRESULT SetRect (

  const RECT *pRect

  );

パラメータ

pRect

[in] ストリームの新しいクリッピング矩形を指定する RECT 構造体へのポインタ。

戻り値

次のいずれかの値を返す。

DDERR_INVALIDPIXELFORMAT	ストリームがピクセル フォーマットと互換でない。
DDERR_INVALIDRECT	指定された矩形が無効。
DDERR_INVALIDSURFACETYPE	ストリームがサーフェスと互換でない。
E_POINTER	ポインタの 1 つが無効。
MS_E_SAMPLEALLOC	ストリーム フォーマットがサーフェスと一致せず、現在、ストリームにサンプルが割り当てられている。
S_OK	成功。

注意

パラメータは省略可能である。値を変更しない場合には、そのパラメータを NULL に設定する。サーフェス フォーマットがストリーム フォーマットと一致しない場合、このメソッドは失敗する。

新しい矩形と現在の矩形のサイズが異なる場合、このメソッドの呼び出しは失敗する。