WaterWaves Class

WaterWaves Class

Defines a displacement of the water surface to create waves.

Inheritance Hierarchy

SystemObject
  DigitalRune.GraphicsWaterWaves
    DigitalRune.GraphicsOceanWaves
    DigitalRune.GraphicsUserDefinedWaves

Namespace: DigitalRune.Graphics
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public abstract class WaterWaves : IDisposable

Public MustInherit Class WaterWaves
	Implements IDisposable

public ref class WaterWaves abstract : IDisposable

[<AbstractClassAttribute>]
type WaterWaves =  
    class
        interface IDisposable
    end

The WaterWaves type exposes the following members.

Constructors

	Name	Description
	WaterWaves	Initializes a new instance of the WaterWaves class.

Top

Methods

	Name	Description
	Dispose	Releases all resources used by an instance of the WaterWaves class.
	Dispose(Boolean)	Releases the unmanaged resources used by an instance of the WaterWaves class and optionally releases the managed resources.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	DisplacementMap	Gets (or sets) the displacement map.
	IsTiling	Gets (or sets) a value indicating whether the displacement map can be tiled seamlessly across the water surface.
	NormalMap	Gets (or sets) the normal map (using standard encoding, see remarks).
	TileCenter	Gets (or sets) the center of the first tile in world space.
	TileSize	Gets (or sets) the size of a single tile (one texture repetition) in world space.

Top

Remarks

Water waves are defined using a DisplacementMap and a NormalMap. These maps are used to deform the water surface (usually by displacing the vertices in the vertex shader).

DisplacementMap and NormalMap are expected to have the same resolution. The DisplacementMap can be if only the normal map should be used.

Reference

DigitalRune.Graphics Namespace