Graphics::DrawImage(Image*,constRect&,INT,INT,INT,INT,Unit,constImageAttributes*,DrawImageAbort,VOID*) method (gdiplusgraphics.h)
The Graphics::DrawImage method draws an image.
Syntax
Status DrawImage(
[in] Image *image,
[in, ref] const Rect & destRect,
[in] INT srcx,
[in] INT srcy,
[in] INT srcwidth,
[in] INT srcheight,
[in] Unit srcUnit,
[in] const ImageAttributes *imageAttributes,
[in] DrawImageAbort callback,
[in] VOID *callbackData
);
Parameters
[in] image
Type: Image*
Pointer to an Image object that specifies the source image.
[in, ref] destRect
Type: const Rect
Reference to a rectangle that bounds the drawing area for the image.
[in] srcx
Type: INT
Integer that specifies the x-coordinate of the upper-left corner of the portion of the source image to be drawn.
[in] srcy
Type: INT
Integer that specifies the y-coordinate of the upper-left corner of the portion of the source image to be drawn.
[in] srcwidth
Type: INT
Integer that specifies the width of the portion of the source image to be drawn.
[in] srcheight
Type: INT
Integer that specifies the height of the portion of the source image to be drawn.
[in] srcUnit
Type: Unit
Element of the Unit enumeration that specifies the unit of measure for the image. The default value is UnitPixel.
[in] imageAttributes
Type: ImageAttributes*
Pointer to an ImageAttributes object that specifies the color and size attributes of the image to be drawn. The default value is NULL.
[in] callback
Type: DrawImageAbort
Callback method used to cancel the drawing in progress. The default value is NULL.
[in] callbackData
Type: VOID*
Pointer to additional data used by the method specified by the callback parameter. The default value is NULL.
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 portion of the source image to be drawn is scaled to fit the rectangle.
Examples
The following example draws the original source image and then draws a portion of the image in a specified rectangle.
VOID Example_DrawImage5(HDC hdc)
{
Graphics graphics(hdc);
// Create an Image object.
Image image(L"pattern.png");
// Draw the original source image.
graphics.DrawImage(&image, 10, 10);
// Define the portion of the image to draw.
int srcX = 70;
int srcY = 20;
int srcWidth = 100;
int srcHeight = 100;
// Create a Rect object that specifies the destination of the image.
Rect destRect(200, 10, image.GetWidth(), image.GetHeight());
// Create an ImageAttributes object that specifies a recoloring from red to blue.
ImageAttributes remapAttributes;
ColorMap redToBlue;
redToBlue.oldColor = Color(255, 255, 0, 0);
redToBlue.newColor = Color(255, 0, 0, 255);
remapAttributes.SetRemapTable(1, &redToBlue);
// Draw the resized image.
graphics.DrawImage(
&image,
destRect,
srcX,
srcY,
srcWidth,
srcHeight,
UnitPixel,
&remapAttributes,
NULL,
NULL);
}
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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for