Sprite.Draw2D Method

Language:

How Do I...?

Draw A Sprite

Adds a sprite to the list of batched sprites. Used for presentation in 2-D space.

Definition

Visual Basic Public Sub Draw2D( _
    ByVal srcTexture As Texture, _
    ByVal srcRectangle As Rectangle, _
    ByVal destinationRectangle As Rectangle, _
    ByVal position As Point, _
    ByVal color As Integer _
)

C# public void Draw2D(
    Texture srcTexture,
    Rectangle srcRectangle,
    Rectangle destinationRectangle,
    Point position,
    int color
);

C++ public:
void Draw2D(
    Texture^ srcTexture,
    Rectangle srcRectangle,
    Rectangle destinationRectangle,
    Point position,
    int color
);

JScript public function Draw2D(
    srcTexture : Texture,
    srcRectangle : Rectangle,
    destinationRectangle : Rectangle,
    position : Point,
    color : int
);

Visual Basic	Public Sub Draw2D( _ ByVal srcTexture As Texture, _ ByVal srcRectangle As Rectangle, _ ByVal destinationRectangle As Rectangle, _ ByVal position As Point, _ ByVal color As Integer _ )
C#	public void Draw2D( Texture srcTexture, Rectangle srcRectangle, Rectangle destinationRectangle, Point position, int color );
C++	public: void Draw2D( Texture^ srcTexture, Rectangle srcRectangle, Rectangle destinationRectangle, Point position, int color );
JScript	public function Draw2D( srcTexture : Texture, srcRectangle : Rectangle, destinationRectangle : Rectangle, position : Point, color : int );

Parameters

srcTexture Microsoft.DirectX.Direct3D.Texture
A Texture object that represents the sprite texture.

srcRectangle System.Drawing.Rectangle
A Rectangle object that indicates the portion of the source texture to use for the sprite. Specify Rectangle.Empty to use the entire source image for the sprite.

destinationRectangle System.Drawing.Rectangle
A Rectangle object that indicates the size of the destination rectangle.

position System.Drawing.Point
A Point object that represents the position of the sprite in 2-D-space.

color System.Int32
Color value represented as an integer.

How Do I...?

Draw A Sprite

This example demonstrates how to draw a sprite.

To draw a sprite:

Call Sprite.Begin to prepare the device for drawing sprites.

Call Sprite.Draw2D to render the sprite.

Call Sprite.End to signal the end of this batch of sprites.

In the following C# code example, sprite is assumed to be the rendered Sprite object. 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();

srcTexture	Microsoft.DirectX.Direct3D.Texture A Texture object that represents the sprite texture.
srcRectangle	System.Drawing.Rectangle A Rectangle object that indicates the portion of the source texture to use for the sprite. Specify Rectangle.Empty to use the entire source image for the sprite.
destinationRectangle	System.Drawing.Rectangle A Rectangle object that indicates the size of the destination rectangle.
position	System.Drawing.Point A Point object that represents the position of the sprite in 2-D-space.
color	System.Int32 Color value represented as an integer.