IHeightmapBuffer

Description

interface Tinman.Terrain.Heightmaps.IHeightmapBuffer

Derived from

IHeightmapLayers

Extended by

HeightmapRegion sealed
HeightmapSamples sealed

Base interface for classes that buffer heightmap samples.

Public / Methods

AddLayers


public method AddLayers → (1)

layers in : HeightmapLayer

The set of heightmap layers this buffer shall be able to store.

Adds the given heightmap layers this buffer.

GetAt


[Pure]
public method GetAt → (1)

offset in : int32

[>=0]
The heightmap sample offset.

returns → HeightmapSample

The heightmap sample value.

Returns a single heightmap sample.

The maximum valid sample offset is defined by the implementing class.

SetAt


public method SetAt → (3)

offset in : int32

[>=0]
The heightmap sample offset.

sample in : HeightmapSample

The heightmap sample value.

layers opt : HeightmapLayer = HeightmapLayer.All

The heightmap layers to set.

Sets a single heightmap sample.

Passing a heightmap sample with partial coverage to a buffer that does not contain the HeightmapLayer.Coverage layer will result in that layer being added to this buffer via a call to AddLayers.

The maximum valid sample offset is defined by the implementing class.