Click or drag to resize
OpacityMetadataEffect Class
[NoComposition] Marks an area of an input image as opaque, which can enable internal rendering optimizations.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsOpacityMetadataEffect

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

The OpacityMetadataEffect type exposes the following members.

Constructors
  NameDescription
Public methodOpacityMetadataEffect
Initializes a new instance of the OpacityMetadataEffect 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 propertyOpaqueRectangle
Specifies the region of the image which is fully opaque.
Public propertySource
Gets or sets the input source for OpacityMetadata effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this OpacityMetadataEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this OpacityMetadataEffect.
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.

Note: this effect doesn't modify the image itself to be opaque. It modifies data associated with the image so the renderer assumes the specified region is opaque.

This Windows Runtime type corresponds to the D2D Opacity metadata effect.

See Also