Class BitmapSourceEffect.Props

public sealed class BitmapSourceEffect.Props : DeviceEffectProperties

Inherited Members: DeviceEffectProperties.Storage

DeviceEffectProperties.ID

DeviceEffectProperties.DisplayName

DeviceEffectProperties.Author

DeviceEffectProperties.Category

DeviceEffectProperties.Description

DeviceEffectProperties.Cached

DeviceEffectProperties.Precision

DeviceEffectProperties.MinInputCount

DeviceEffectProperties.MaxInputCount

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AlphaMode: The alpha mode of the output.
The default value is Premultiplied.

BitmapSource: The IBitmapSource containing the image data to be loaded.
The defalut value is null.

ClassID: Implemented by the derived class to specify the effect's class ID (CLSID) when registering and creating the effect and for binding to an IDeviceEffectProperties.
Note that this is different than the ID property accessor, which queries the IDeviceEffectProperties for the actual runtime effect class ID.
Overriding this property is only necessary in advanced scenarios, such as when wrapping an existing effect (e.g. built-in Direct2D effects), or when working with CustomEffects that have their own generic type arguments (e.g. PixelShaderEffect).

EnableDpiCorrection: If you set this to true, the effect will scale the input image to convert the DPI reported by IBitmapSource to the DPI of the device context. The effect uses the interpolation mode you set with the InterpolationMode property. If you set this to false, the effect uses a DPI of 96.0 for the output image.
The default value is false.

InterpolationMode: The interpolation mode used to scale the image. If the mode disables the mipmap, then BitmapSourceEffect will cache the image at the resolution determined by the Scale and EnableDpiCorrection properties.
The default value is Linear.

Orientation: A flip and/or rotation operation to be performed on the image.
The default value is Default.

Scale: The scale amount in the X and Y direction. The effect multiplies the width by the X value and the height by the Y value. This property is a Vector2Float defined as: (X scale, Y scale). The scale amounts are float, unitless, and must be positive or 0.
The default value is { 1.0f, 1.0f }.