Graphics.DrawImage(Image*, const Rect) method

Article
03/07/2012

Applies to: desktop apps only

The Graphics::DrawImage method draws an image.

Syntax

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

Parameters

image [in]
Type: Image*

Pointer to an Image object that specifies the source image.
rect [in, ref]
Type: const Rect

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

Return value

Type:

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_DrawImage9(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 Rect object that specifies the destination of the image.
   Rect 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.

Illustration showing two versions of the same image; the second is slightly narrower than the first, much shorter, and outlined in red

Requirements

Minimum supported client	Windows XP, Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Product	GDI+ 1.0
Header	Gdiplusgraphics.h (include Gdiplus.h)
Library	Gdiplus.lib
DLL	Gdiplus.dll