Graphics::DrawImage(Image*,constRectF&) method (gdiplusgraphics.h)

The Graphics::DrawImage method draws an image.

Syntax

Status DrawImage(
  [in]      Image         *image,
  [in, ref] const RectF & rect
);

Parameters

[in] image

Type: Image*

Pointer to an Image object that specifies the source image.

[in, ref] rect

Type: const RectF

Reference to a rectangle that bounds the drawing area for the image.

Return value

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Remarks

The image is scaled to fit the rectangle.

Examples

The following example draws the source image, the rectangle that bounds the resized image, and then draws the resized image to fit the rectangle.

VOID Example_DrawImage10(HDC hdc)

{
   Graphics graphics(hdc);

   // Create an Image object.
   Image image(L"climber.jpg");

   // Create a Pen object.
   Pen pen (Color(255, 255, 0, 0), 2);

   // Draw the original source image.
   graphics.DrawImage(&image, 10, 10);

   // Create a RectF object that specifies the destination of the image.
   RectF destRect(200, 50, 150, 75);

   // Draw the rectangle that bounds the image.
   graphics.DrawRectangle(&pen, destRect);

   // Draw the image.
   graphics.DrawImage(&image, destRect);
}

The following illustration shows the output of the preceding code.

Requirements

Requirement	Value
Minimum supported client	Windows XP, Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	gdiplusgraphics.h (include Gdiplus.h)
Library	Gdiplus.lib
DLL	Gdiplus.dll

See also

Drawing, Positioning, and Cloning Images

Graphics

Image

Loading and Displaying Bitmaps

RectF