ID3DXSprite::DrawTransform

Provides a mechanism for drawing a sprite that is transformed by a specified matrix.

HRESULT DrawTransform(
  LPDIRECT3DTEXTURE8 pSrcTexture,
  CONST RECT* pSrcRect,
  CONST D3DXMATRIX* pTransform,
  D3DCOLOR Color
);

Parameters

pSrcTexture

[in] Pointer to an IDirect3DTexture8 interface, representing the source image used for the sprite.

pSrcRect

[in] A pointer to a RECT structure that indicates what portion of the source texture to use for the sprite. If this parameter is NULL, then the entire source image is used for the sprite; however, you can specify a sub-rectangle of the source image instead.

Before transformation, the size of the sprite is defined by pSrcRect with the top-left corner at the origin (0,0).

pTransform

[in] Pointer to a D3DXMATRIX structure, specifying the transformation that will be applied.

Color

[in] D3DCOLOR type. The color and alpha channels are modulated by this value. A value of 0xFFFFFFFF maintains the original source color and alpha data.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

This method must be called between an IDirect3DDevice8::BeginScene and IDirect3DDevice8::EndScene pair.

If ID3DXSprite::Begin has not been called, this method will internally call Begin and ID3DXSprite::End. When making successive calls to ID3DXSprite::Draw and/or ID3DXSprite::DrawTransform, be sure to call Begin to avoid the extra overhead of Draw and DrawTransform internally calling Begin and End each time.

Requirements

  Header: Declared in D3dx8core.h.
  Import Library: Use D3dx8.lib.

See Also

ID3DXSprite::Draw