Sprite.Draw2D(Texture,Rectangle,Rectangle,Point,Single,Point,Int32) Method (Microsoft.DirectX.Direct3D)

  • Article

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 RectangleLeave Site, _
    ByVal destinationRectangle As RectangleLeave Site, _
    ByVal center As PointLeave Site, _
    ByVal rotationAngle As Single, _
    ByVal position As PointLeave Site, _
    ByVal color As Integer _
)
C# public void Draw2D(
    Texture srcTexture,
    RectangleLeave Site srcRectangle,
    RectangleLeave Site destinationRectangle,
    PointLeave Site center,
    float rotationAngle,
    PointLeave Site position,
    int color
);
C++ public:
void Draw2D(
    Texture^ srcTexture,
    RectangleLeave Site srcRectangle,
    RectangleLeave Site destinationRectangle,
    PointLeave Site center,
    float rotationAngle,
    PointLeave Site position,
    int color
);
JScript public function Draw2D(
    srcTexture : Texture,
    srcRectangle : RectangleLeave Site,
    destinationRectangle : RectangleLeave Site,
    center : PointLeave Site,
    rotationAngle : float,
    position : PointLeave Site,
    color : int
);

Parameters

srcTexture Microsoft.DirectX.Direct3D.Texture
A Texture object that represents the sprite texture.
srcRectangle System.Drawing.Rectangle
A RectangleLeave Site object that indicates the portion of the source texture to use for the sprite. Specify Rectangle.EmptyLeave Site to use the entire source image for the sprite.
destinationRectangle System.Drawing.Rectangle
A RectangleLeave Site object that indicates the size of the destination rectangle.
center System.Drawing.Point
A Vector3 structure that identifies the center of the sprite. A value of (0,0) indicates the upper-left corner.
rotationAngle System.Single
A floating point value that specifies the rotation angle around the rotational center of the sprite.
position System.Drawing.Point
A PointLeave Site 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:

  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, 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();

See Also