| TurbulenceEffect Class |
[NoComposition]
Generates an image using the Perlin noise function.
Inheritance HierarchySystem.Object
Microsoft.Graphics.Canvas.Effects.TurbulenceEffect
Microsoft.Graphics.Canvas.Effects.TurbulenceEffect
Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
SyntaxC#
public sealed class TurbulenceEffect : ICanvasEffect, IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable
The TurbulenceEffect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TurbulenceEffect | Initializes a new instance of the TurbulenceEffect class. |
Properties| Name | Description | |
|---|---|---|
 | BufferPrecision | Specifies what precision to use for intermediate buffers when drawing this effect. |
| CacheOutput | Enables caching the output from drawing this effect. |
| Frequency | Base frequencies in the X and Y direction. Units are specified in 1/DIPs.
Default value (0.01, 0.01). |
| Name | Attaches a user-defined name string to the effect. |
| Noise | The turbulence noise mode.
Default value FractalSum. |
| Octaves | Number of octaves for the noise function. Default value 1. |
| Offset | Offsets the coordinates where the turbulence output is generated. Default value (0,0). |
| Seed | The seed for the pseudo random generator. Default value 0. |
| Size | Specifies the size of image to generate. Default value (512, 512). |
| Tileable | Turns stitching on or off. If set, the base frequency is adjusted so the
output bitmap can be tiled. Default value false. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the effect. |
| GetBounds(ICanvasResourceCreator) | Retrieves the bounds of this TurbulenceEffect. |
| GetBounds(ICanvasResourceCreator, Matrix3x2) | Retrieves the bounds of this TurbulenceEffect. |
| GetInvalidRectangles | Queries what regions of the effect output have changed since it was last drawn. |
 | GetRequiredSourceRectangle | Queries what part of an effect source image is needed to draw an output region. |
| GetRequiredSourceRectangles | Queries what parts of the effect source images are needed to draw an output region. |
| InvalidateSourceRectangle | Notifies the effect that one of its source images has changed. |
RemarksSupported by Win2D but not Windows.UI.Composition.
The Turbulence effect computes the sum of one or more octaves of the Perlin noise function. Perlin noise is a pseudo-random function whose value depends on the frequency, position, and seed value. This effect outputs pixel values in premultiplied alpha.
This Windows Runtime type corresponds to the D2D Turbulence effect.
See Also