ImageAttributes::Reset method (gdiplusimageattributes.h)

The ImageAttributes::Reset method clears all color- and grayscale-adjustment settings for a specified category.

Syntax

Status Reset(
  [in, optional] ColorAdjustType type
);

Parameters

[in, optional] type

Type: ColorAdjustType

Element of the ColorAdjustType enumeration that specifies the category for which color adjustment is reset. The default value is ColorAdjustTypeDefault.

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

An ImageAttributes object maintains color and grayscale settings for five adjustment categories: default, bitmap, brush, pen, and text. For example, you can specify a gamma value for the default category, a different gamma value for the bitmap category, and still a different gamma value for the pen category.

The default color- and grayscale-adjustment settings apply to all categories that don't have adjustment settings of their own. For example, if you never specify any adjustment settings for the pen category, then the default settings apply to the pen category.

As soon as you specify a color- or grayscale-adjustment setting for a certain category, the default adjustment settings no longer apply to that category. You can reinstate the default settings for that category by calling ImageAttributes::Reset. For example, suppose you specify a gamma value for the default category. If you set the gamma value for the pen category by calling ImageAttributes::SetGamma, then the default gamma value will not apply to pens. If you later pass ColorAdjustTypePen to the ImageAttributes::Reset method, the pen category will revert to the default gamma value.

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

ColorAdjustType

Image

ImageAttributes

ImageAttributes::ClearNoOp

ImageAttributes::SetNoOp

Metafile

Recoloring