D3DXCreateSprite function

Creates a sprite object which is associated with a particular device. Sprite objects are used to draw 2D images to the screen.

Syntax

HRESULT D3DXCreateSprite(
  _In_  LPDIRECT3DDEVICE9 pDevice,
  _Out_ LPD3DXSPRITE      *ppSprite
);

Parameters

pDevice [in]

Type: LPDIRECT3DDEVICE9

Pointer to an IDirect3DDevice9 interface, the device to be associated with the sprite.

ppSprite [out]

Type: LPD3DXSPRITE*

Address of a pointer to an ID3DXSprite interface. This interface allows the user to access sprite functions.

Return value

Type: HRESULT

If the function succeeds, the return value is S_OK. If the function fails, the return value can be one of the following: D3DERR_INVALIDCALL, E_OUTOFMEMORY.

Remarks

This interface can be used to draw two dimensional images in screen space of the associated device.

Requirements

Requirement Value
Header
D3dx9core.h
Library
D3dx9.lib

See also

General Purpose Functions