Click or drag to resize
LinearTransferEffect Class
[NoComposition] Alters the colors of an image by applying a per-channel linear transfer function.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsLinearTransferEffect

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

The LinearTransferEffect type exposes the following members.

Constructors
  NameDescription
Public methodLinearTransferEffect
Initializes a new instance of the LinearTransferEffect class.
Top
Properties
  NameDescription
Public propertyAlphaDisable
Disables the alpha channel transfer function. Default value false.
Public propertyAlphaOffset
Offsets the alpha channel. Default value 0.
Public propertyAlphaSlope
Controls the slope of the alpha channel. Default value 1.
Public propertyBlueDisable
Disables the blue channel transfer function. Default value false.
Public propertyBlueOffset
Offsets the blue channel. Default value 0.
Public propertyBlueSlope
Controls the slope of the blue channel. Default value 1.
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 propertyClampOutput
If set, the effect clamps color values to between 0 and 1 before passing them on to the next effect in the graph. If false, the effect will not clamp values, although subsequent effects or the output surface may later clamp if they are not of high enough precision. Default value false.
Public propertyGreenDisable
Disables the green channel transfer function. Default value false.
Public propertyGreenOffset
Offsets the green channel. Default value 0.
Public propertyGreenSlope
Controls the slope of the green channel. Default value 1.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyRedDisable
Disables the red channel transfer function. Default value false.
Public propertyRedOffset
Offsets the red channel. Default value 0.
Public propertyRedSlope
Controls the slope of the red channel. Default value 1.
Public propertySource
Gets or sets the input source for LinearTransfer effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this LinearTransferEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this LinearTransferEffect.
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

Supported by Win2D but not Windows.UI.Composition.

The linear transfer function is evaluated separately for each color channel:

result = (input * slope) + offset

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, then the transfer function applied, and finally the result converted back to premultiplied format.

This Windows Runtime type corresponds to the D2D Linear transfer effect.

See Also