Click or drag to resize
TurbulenceEffect Class
[NoComposition] Generates an image using the Perlin noise function.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsTurbulenceEffect

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

The TurbulenceEffect type exposes the following members.

Constructors
  NameDescription
Public methodTurbulenceEffect
Initializes a new instance of the TurbulenceEffect 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 propertyFrequency
Base frequencies in the X and Y direction. Units are specified in 1/DIPs. Default value (0.01, 0.01).
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyNoise
The turbulence noise mode. Default value FractalSum.
Public propertyOctaves
Number of octaves for the noise function. Default value 1.
Public propertyOffset
Offsets the coordinates where the turbulence output is generated. Default value (0,0).
Public propertySeed
The seed for the pseudo random generator. Default value 0.
Public propertySize
Specifies the size of image to generate. Default value (512, 512).
Public propertyTileable
Turns stitching on or off. If set, the base frequency is adjusted so the output bitmap can be tiled. Default value false.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this TurbulenceEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this TurbulenceEffect.
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 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