Edit

Share via

D2D1_TURBULENCE_PROP enumeration (d2d1effects.h)

  • Article

Identifiers for properties of the Turbulence effect.

Syntax

typedef enum D2D1_TURBULENCE_PROP {
  D2D1_TURBULENCE_PROP_OFFSET = 0,
  D2D1_TURBULENCE_PROP_SIZE = 1,
  D2D1_TURBULENCE_PROP_BASE_FREQUENCY = 2,
  D2D1_TURBULENCE_PROP_NUM_OCTAVES = 3,
  D2D1_TURBULENCE_PROP_SEED = 4,
  D2D1_TURBULENCE_PROP_NOISE = 5,
  D2D1_TURBULENCE_PROP_STITCHABLE = 6,
  D2D1_TURBULENCE_PROP_FORCE_DWORD = 0xffffffff
} ;

Constants

 
D2D1_TURBULENCE_PROP_OFFSET
Value: 0
The coordinates where the turbulence output is generated.


The algorithm used to generate the Perlin noise is position dependent, so a different offset results in a different output.
This property is not bounded and the units are specified in DIPs.


Note  The offset does not have the same effect as a translation because the noise function output is infinite and the function will wrap around the tile.

 

The type is D2D1_VECTOR_2F.


The default value is {0.0f, 0.0f}.
D2D1_TURBULENCE_PROP_SIZE
Value: 1
D2D1_TURBULENCE_PROP_BASE_FREQUENCY
Value: 2
The base frequencies in the X and Y direction. This property is a float and must be greater than 0. The units are specified in 1/DIPs.


A value of 1 (1/DIPs) for the base frequency results in the Perlin noise completing an entire cycle between two pixels. The ease interpolation for these pixels results in completely random pixels, since there is no correlation between the pixels.

A value of 0.1(1/DIPs) for the base frequency, the Perlin noise function repeats every 10 DIPs. This results in correlation between pixels and the typical turbulence effect is visible.

The type is D2D1_VECTOR_2F.


The default value is {0.01f, 0.01f}.
D2D1_TURBULENCE_PROP_NUM_OCTAVES
Value: 3
The number of octaves for the noise function. This property is a UINT32 and must be greater than 0.


The type is UINT32.

The default value is 1.
D2D1_TURBULENCE_PROP_SEED
Value: 4
The seed for the pseudo random generator. This property is unbounded.


The type is UINT32.

The default value is 0.
D2D1_TURBULENCE_PROP_NOISE
Value: 5
The turbulence noise mode. This property can be either fractal sum or turbulence. Indicates whether to generate a bitmap based on Fractal Noise or the Turbulence function.


The type is D2D1_TURBULENCE_NOISE.


The default value is D2D1_TURBULENCE_NOISE_FRACTAL_SUM.
D2D1_TURBULENCE_PROP_STITCHABLE
Value: 6
Turns stitching on or off. The base frequency is adjusted so that output bitmap can be stitched. This is useful if you want to tile multiple copies of the turbulence effect output.


True – The output bitmap can be tiled (using the tile effect) without the appearance of seams. The base frequency is adjusted so that output bitmap can be stitched.

False – The base frequency is not adjusted, so seams may appear between tiles if the bitmap is tiled.

The type is BOOL.

The default value is FALSE.
D2D1_TURBULENCE_PROP_FORCE_DWORD
Value: 0xffffffff

Requirements

Requirement Value
Header d2d1effects.h