ID2D1SpriteBatch::SetSprites-Methode (d2d1_3.h)

Updates die Eigenschaften der angegebenen Sprites in diesem Sprite-Batch. Wenn Sie einen NULL-Wert für eine beliebige Eigenschaft angeben, bleibt diese Eigenschaft für diesen Sprite unverändert.

Syntax

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
);

Parameter

startIndex

Typ: UINT32

Der Index des ersten zu aktualisierenden Sprite-Batchs in diesem Sprite-Batch.

spriteCount

Typ: UINT32

Die Anzahl der Sprites, die mit neuen Eigenschaften aktualisiert werden sollen. Dadurch wird bestimmt, wie viele Schritte in die einzelnen Arrays Direct2D gelesen werden.

[in, optional] destinationRectangles

Typ: const D2D1_RECT_F*

Ein Zeiger auf ein Array mit den Zielrechtecken, die angeben, wo die Sprites im Zielgerätekontext gezeichnet werden sollen.

[in, optional] sourceRectangles

Typ: const D2D1_RECT_U*

Ein Zeiger auf ein Array, das die Quellrechtecke enthält, die die Regionen der Quell-Bitmap angeben, die als Sprites gezeichnet werden sollen.

Direct2D verwendet die gesamte Quellbitbit für Sprites, denen ein NULL-Wert oder InfiniteRectU zugewiesen ist. Wenn dieser Parameter vollständig ausgelassen oder auf einen NULL-Wert festgelegt wird, verwendet Direct2D die gesamte Quellbitbit für alle aktualisierten Sprites.

[in, optional] colors

Typ: const D2D1_COLOR_F*

Ein Zeiger auf ein Array, das die Farben enthält, die auf jeden Sprite angewendet werden sollen. Die Ausgabefarbe ist das Ergebnis der komponentenweisen Multiplikation der Quell-Bitmapfarbe und der bereitgestellten Farbe. Die Ausgabefarbe ist nicht geklemmt.

Direct2D ändert die Farbe von Sprites, denen ein NULL-Wert zugewiesen ist, nicht. Wenn dieser Parameter vollständig ausgelassen oder auf einen NULL-Wert festgelegt wird, ändert Direct2D die Farbe der aktualisierten Sprites nicht.

[in, optional] transforms

Typ: const D2D1_MATRIX_3X2_F*

Ein Zeiger auf ein Array, das die Transformationen enthält, die auf das Zielrechteck jedes Sprites angewendet werden sollen.

Direct2D transformiert das Zielrechteck von Sprites, denen ein NULL-Wert zugewiesen ist, nicht. Wenn dieser Parameter vollständig ausgelassen oder auf einen NULL-Wert festgelegt wird, transformiert Direct2D das Zielrechteck der aktualisierten Sprites nicht.

destinationRectanglesStride

Typ: UINT32

Gibt den Abstand zwischen den einzelnen Rechtecken im Array destinationRectangles in Bytes an. Wenn Sie einen Schritt von 0 angeben, wird für jeden aktualisierten Sprite das gleiche Zielrechteck verwendet.

sourceRectanglesStride

Typ: UINT32

Gibt den Abstand zwischen den einzelnen Rechtecken im Array sourceRectangles in Bytes an (sofern dieses Array angegeben ist). Wenn Sie einen Schritt von 0 angeben, wird für jeden aktualisierten Sprite das gleiche Quellrechteck verwendet.

colorsStride

Typ: UINT32

Gibt den Abstand (in Bytes) zwischen den einzelnen Farben im Farbarray an (sofern dieses Array angegeben ist). Wenn Sie einen Schritt von 0 angeben, wird für jeden aktualisierten Sprite die gleiche Farbe verwendet.

transformsStride

Typ: UINT32

Gibt den Abstand (in Bytes) zwischen den einzelnen Transformationen im Transformationsarray an (sofern dieses Array angegeben ist). Wenn Sie einen Schritt von 0 angeben, wird dieselbe Transformation für jeden aktualisierten Sprite verwendet.

Rückgabewert

Typ: HRESULT

Gibt bei Erfolg S_OK zurück. Gibt E_INVALIDARG zurück, wenn ein ungültiger Wert an die -Methode übergeben wurde. In diesem Fall werden durch diesen Aufruf von SetSprites keine Sprites geändert.

Anforderungen

Anforderung	Wert
Zielplattform	Windows
Kopfzeile	d2d1_3.h
Bibliothek	D2d1.lib
DLL	D2d1.dll

Weitere Informationen

ID2D1SpriteBatch