Share via

ID2D1SpriteBatch::SetSprites メソッド (d2d1_3.h)

  • [アーティクル]

このスプライト バッチ内の指定したスプライトのプロパティを更新します。プロパティに null 値を指定すると、そのスプライトのプロパティは変更されません。

構文

HRESULT SetSprites(
                 UINT32                  startIndex,
                 UINT32                  spriteCount,
  [in, optional] const D2D1_RECT_F       *destinationRectangles,
  [in, optional] const D2D1_RECT_U       *sourceRectangles,
  [in, optional] const D2D1_COLOR_F      *colors,
  [in, optional] const D2D1_MATRIX_3X2_F *transforms,
                 UINT32                  destinationRectanglesStride,
                 UINT32                  sourceRectanglesStride,
                 UINT32                  colorsStride,
                 UINT32                  transformsStride
);

パラメーター

startIndex

型: UINT32

更新するこのスプライト バッチ内の最初のスプライトのインデックス。

spriteCount

型: UINT32

新しいプロパティで更新するスプライトの数。 これにより、Direct2D が読み取る各配列へのストライドの数が決まります。

[in, optional] destinationRectangles

型: const D2D1_RECT_F*

宛先デバイス コンテキストでスプライトを描画する場所を指定する宛先の四角形を含む配列へのポインター。

[in, optional] sourceRectangles

型: const D2D1_RECT_U*

スプライトとして描画するソース ビットマップの領域を指定するソース四角形を含む配列へのポインター。

Direct2D では、null 値または InfiniteRectU が割り当てられているスプライトにソース ビットマップ全体が使用されます。 このパラメーターを完全に省略するか、null 値に設定すると、Direct2D は更新されたすべてのスプライトにソース ビットマップ全体を使用します。

[in, optional] colors

型: const D2D1_COLOR_F*

各スプライトに適用する色を含む配列へのポインター。 出力色は、ソース ビットマップの色と指定された色のコンポーネントごとの乗算の結果です。 出力色はクランプされません。

Direct2D では、null 値が割り当てられているスプライトの色は変更されません。 このパラメーターを完全に省略するか、null 値に設定した場合、Direct2D は更新されたスプライトの色を変更しません。

[in, optional] transforms

型: const D2D1_MATRIX_3X2_F*

各スプライトの変換先の四角形に適用する変換を含む配列へのポインター。

Direct2D では、null 値が割り当てられているスプライトの変換先の四角形は変換されません。 このパラメーターを完全に省略するか、null 値に設定した場合、Direct2D は更新されたスプライトの変換先の四角形を変換しません。

destinationRectanglesStride

型: UINT32

destinationRectangles 配列内の各四角形間の距離をバイト単位で指定します。 ストライドを 0 にした場合、更新されたスプライトごとに同じターゲット四角形が使用されます。

sourceRectanglesStride

型: UINT32

sourceRectangles 配列内の各四角形間の距離をバイト単位で指定します (その配列が指定されている場合)。 ストライドを 0 にした場合、更新されたスプライトごとに同じソース四角形が使用されます。

colorsStride

型: UINT32

colors 配列の各色間の距離をバイト単位で指定します (その配列が指定されている場合)。 ストライドを 0 にした場合、更新されたスプライトごとに同じ色が使用されます。

transformsStride

型: UINT32

transforms 配列内の各変換間の距離をバイト単位で指定します (その配列が指定されている場合)。 ストライドを 0 にした場合、更新されたスプライトごとに同じ変換が使用されます。

戻り値

型: HRESULT

成功すると S_OK を返します。 無効な値が メソッドに渡された場合は、E_INVALIDARGを返します。 この場合、SetSprites の呼び出しによってスプライトは変更されません。

要件

要件 値
対象プラットフォーム Windows
ヘッダー d2d1_3.h
Library D2d1.lib
[DLL] D2d1.dll

こちらもご覧ください

ID2D1SpriteBatch