Click or drag to resize
RgbToHueEffect Class
[Win10] [NoComposition] Converts an RGB image to HSV (hue, saturation, value) or HSL (hue, saturation, lightness) color space.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsRgbToHueEffect

Namespace:  Microsoft.Graphics.Canvas.Effects
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
Syntax
C#
public sealed class RgbToHueEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The RgbToHueEffect type exposes the following members.

Constructors
  NameDescription
Public methodRgbToHueEffect
Initializes a new instance of the RgbToHueEffect class.
Top
Properties
  NameDescription
Public propertyBufferPrecision
Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
Enables caching the output from drawing this effect.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyOutputColorSpace
Specifies which color space to convert into. Default value Hsv.
Public propertySource
Gets or sets the input source for RgbToHue effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this RgbToHueEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this RgbToHueEffect.
Public methodGetInvalidRectangles
Queries what regions of the effect output have changed since it was last drawn.
Public methodCode exampleGetRequiredSourceRectangle
Queries what part of an effect source image is needed to draw an output region.
Public methodGetRequiredSourceRectangles
Queries what parts of the effect source images are needed to draw an output region.
Public methodInvalidateSourceRectangle
Notifies the effect that one of its source images has changed.
Top
Remarks

This API is available on Windows 10 (Universal Windows Platform) only. It is not supported on Windows 8.1 or Phone 8.1.

Supported by Win2D but not Windows.UI.Composition.

HSV and HSL are two different models for representing colors in a cylindrical color space. They are useful because they allow you to reason about a color using more intuitive concepts like hue and intensity versus combining red, green and blue values.

To reverse the behavior of this effect, use HueToRgbEffect.

Effect inputs and outputs are assumed to be in premultiplied alpha format, but this effect operates internally on straight alpha data, so its input values will be unpremultiplied before the color conversion is applied.

This Windows Runtime type corresponds to the D2D RGB to hue effect.

See Also