ID3DXSprite::DrawTransform Method

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

Syntax

HRESULT DrawTransform(      

    LPDIRECT3DTEXTURE9 pSrcTexture,
    CONST RECT *pSrcRect,
    CONST D3DXMATRIX *pTransform,
    D3DCOLOR Color
);

Parameters

pSrcTexture

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

pSrcRect

[in] 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 subrectangle 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 Value

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 IDirect3DDevice9::BeginScene and IDirect3DDevice9::EndScene pair.

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