Library Moduleheckj.heightmap 0.6.4Heightmap

Heightmap

Data structures for generating and exposing a height map.

Documentation.md
import Heightmap

Module information

Declarations
28
Symbols
100

Coverage

64.3 percent of the declarations in Heightmap are fully documented32.1 percent of the declarations in Heightmap are indirectly documented3.6 percent of the declarations in Heightmap are completely undocumented

Declarations

28.6 percent of the declarations in Heightmap are initializers, type members, or enum cases42.9 percent of the declarations in Heightmap are instance members10.7 percent of the declarations in Heightmap are instance subscripts10.7 percent of the declarations in Heightmap are structures7.1 percent of the declarations in Heightmap are typealiases

Interfaces

100.0 percent of the declarations in Heightmap are unrestricted
Module stats and coverage details

Overview

This library presents a data structure that stores a two-dimensional array of float values, typically used for representing a height map. The internal representation of the height map is expected to be a Unit value (0.0 to 1.0), stored (and accessible) as a Float value.

Heightmaps

  • struct Heightmap

    A two-dimensional array of unit-values, used to represent a height map.

  • struct XZIndex

    A two-dimensional coordinate index to a height map.