Microsoft DirectX 9.0 SDK Update (October 2004)

Sprite.Draw Method

Language:

Note: This documentation is preliminary and is subject to change.
How Do I...?

Adds a sprite to the list of batched sprites.

Definition

Visual Basic .NET Public Sub Draw( _
    ByVal srcTexture As Texture, _
    ByVal srcRectangle As Rectangle, _
    ByVal center As Vector3, _
    ByVal position As Vector3, _
    ByVal color As Color _
)
C# public void Draw(
    Texture srcTexture,
    Rectangle srcRectangle,
    Vector3 center,
    Vector3 position,
    Color color
);
Managed C++ public: void Draw(
    Texture *srcTexture,
    Rectangle srcRectangle,
    Vector3 center,
    Vector3 position,
    Color color
);
JScript .NET public function Draw(
    srcTexture : Texture,
    srcRectangle : Rectangle,
    center : Vector3,
    position : Vector3,
    color : Color
);

Parameters

srcTexture Microsoft.DirectX.Direct3D.Texture. A Texture object that represents the sprite texture.
srcRectangle System.Drawing.Rectangle. A Rectangle Leave Site object that indicates the portion of the source texture to use for the sprite. Specify Rectangle.Empty Leave Site to use the entire source image for the sprite.
center Microsoft.DirectX.Vector3. A Vector3 structure that identifies the center of the sprite. A value of (0,0,0) indicates the upper-left corner.
position Microsoft.DirectX.Vector3. A Vector3 structure that identifies the position of the sprite. A value of (0,0,0) indicates the upper-left corner.
color System.Drawing.Color. A Color Leave Site structure. The color and alpha channels are modulated by this value. The Color.Transparent Leave Site value maintains the original source color and alpha data.

Remarks

Exceptions
InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException The data is invalid.

How Do I...?

Draw A Sprite

This example demonstrates how to draw a sprite.

To draw a sprite:

  1. Call Sprite.Begin to prepare the device for drawing sprites.
  2. Call Sprite.Draw2D to render the sprite.
  3. Call Sprite.End to signal the end of this batch of sprites.

In the following C# code example, device is assumed to be the rendering Device. The texture variable is a loaded Texture object.

              [C#]
              
sprite.Begin(SpriteFlags.None); sprite.Draw2D(texture, Rectangle.Empty, Rectangle.Empty, new Point(5.0f, 5.0f), Color.White); sprite.End();


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center