ID2D1DeviceContext3::CreateSpriteBatch method (d2d1_3.h)

Creates a new, empty sprite batch. After creating a sprite batch, use ID2D1SpriteBatch::AddSprites to add sprites to it, then use ID2D1DeviceContext3::DrawSpriteBatch to draw it.

Syntax

HRESULT CreateSpriteBatch(
  [out] ID2D1SpriteBatch **spriteBatch
);

Parameters

[out] spriteBatch

Type: ID2D1SpriteBatch**

When this method returns, contains a pointer to a new, empty sprite batch to be populated by the app.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Target Platform Windows
Header d2d1_3.h
Library D2d1.lib
DLL D2d1.dll

See also

ID2D1DeviceContext3