ImageAttributes::SetWrapMode method (gdiplusimageattributes.h)

The ImageAttributes::SetWrapMode method sets the wrap mode of this ImageAttributes object.

Syntax

Status SetWrapMode(
  [in]                WrapMode      wrap,
  [in, ref, optional] const Color & color,
  [in, optional]      BOOL          clamp
);

Parameters

[in] wrap

Type: WrapMode

Element of the WrapMode enumeration that specifies how repeated copies of an image are used to tile an area.

[in, ref, optional] color

Type: const Color

Reference to a Color object that specifies the color of pixels outside of a rendered image. This color is visible if the wrap parameter is set to WrapModeClamp and the source rectangle passed to DrawImage is larger than the image itself. The default value is Color(), which is a Color object initialized to black.

[in, optional] clamp

Type: BOOL

This parameter has no effect in GDI+ version 1.0. Set this parameter to FALSE. The default value is FALSE.

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.

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 gdiplusimageattributes.h (include Gdiplus.h)
Library Gdiplus.lib
DLL Gdiplus.dll

See also

Bitmap

Color

Image

ImageAttributes

Metafile

Recoloring

WrapMode