Module prelude Copy item path Source ChunkKey The key for a chunk at a particular level of detail. ChunkUnits A newtype wrapper for PointN
where each point represents exactly one chunk. Compressed A value compressed with compression algorithm A
. CompressibleChunkStorage A two-tier chunk storage. The first tier is an LRU cache of uncompressed chunks. The second tier is a Slab
of compressed
chunks. CompressibleChunkStorageReader An object for reading from CompressibleChunkStorage
with only &self
. Easily construct one of these using the
CompressibleChunkStorage::reader
method. ExtentN An N-dimensional extent. This is mathematically the Cartesian product of a half-closed interval [a, b)
in each dimension.
You can also just think of it as an axis-aligned box with some shape and a minimum point. When doing queries against lattice
maps, this is the primary structure used to determine the bounds of your query. Func Local Map-local coordinates. Lz4 The LZ4 compression algorithm . OctreeChunkIndex A ChunkedOctreeSet
that indexes the chunks of a ChunkMap
. Useful for representing a clipmap. OctreeNode Represents a single non-empty octant in the octree. Can be used for manual traversal by calling OctreeSet::get_child
. OctreeSet A sparse set of voxel coordinates (3D integer points). Supports spatial queries. PointDownsampler A ChunkDownsampler
that just selects a single point from each 2x2x2
(assuming lod_delta=1
) region, ignoring the rest. PointN An N-dimensional point (where N=2 or N=3), which is usually just a primitive array like
[i32; 2]
or [i32; 3]
. It is most convenient to construct points of any dimension as: Sd8 A signed distance value in the range [-1.0, 1.0]
with 8 bits of precision. Sd16 A signed distance value in the range [-1.0, 1.0]
with 16 bits of precision. SdfMeanDownsampler A ChunkDownsampler
that takes the mean of each 2x2x2
region of a signed distance field. It also renormalizes the values
to lie in the range [-1.0, 1.0]
. SerializableChunks A simple format for serializing a collection of chunks. All chunks are serialized with bincode
, then compressed using some
BytesCompression
. Snappy The Snappy compression algorithm .
Uses a pure Rust implementation, making it suitable for use with the WASM target. Stride The most efficient coordinates for slice-backed lattice maps. A single number that translates directly to a slice offset. TransformMap A lattice map that delegates look-ups to a different lattice map, then transforms the result
using some Fn(In) -> Out
. Axis2 Either the X or Y axis. Axis3 Either the X, Y, or Z axis. VisitStatus Abs Bounded Chunk One piece of a chunked lattice map. ChunkMapBuilder An object that knows how to construct chunks for a ChunkMap
. ChunkReadStorage Methods for reading chunks from storage. ChunkWriteStorage Methods for writing chunks from storage. Compression An algorithm for:
1. compressing a specific type Data
into type Compressed
2. decompressing Compressed
back into Data
ConstOne ConstZero Distance DotProduct FillExtent FloatPoint ForEach ForEachMut FromBytesCompression Get GetComponent GetMut GetMutPtr GetRef IndexedArray When a lattice map implements IndexedArray
, that means there is some underlying array with the location and shape dictated
by the extent. IntegerDiv IntegerPoint IntoIntegerPoint IsEmpty Used in many generic algorithms to check if a voxel is considered empty. IterChunkKeys IterExtent LatticeOrder MapComponents MinMaxComponent Neighborhoods Norm Ones Point A trait that bundles op traits that all PointN<N>
(and its components) should have. ReadExtent A trait to facilitate the generic implementation of copy_extent
. SignedDistance WriteExtent A trait to facilitate the generic implementation of copy_extent
. copy_extent Copy all points in extent
from the src
map to the dst
map. Array2x1 Array2x2 Array2x3 Array2x4 Array2x5 Array2x6 Array3x1 Array3x2 Array3x3 Array3x4 Array3x5 Array3x6 ChunkHashMap2x1 A 2-dimensional, 1-channel ChunkHashMap
. ChunkHashMap2x2 A 2-dimensional, 2-channel ChunkHashMap
. ChunkHashMap2x3 A 2-dimensional, 3-channel ChunkHashMap
. ChunkHashMap2x4 A 2-dimensional, 4-channel ChunkHashMap
. ChunkHashMap2x5 A 2-dimensional, 5-channel ChunkHashMap
. ChunkHashMap2x6 A 2-dimensional, 6-channel ChunkHashMap
. ChunkHashMap3x1 A 3-dimensional, 1-channel ChunkHashMap
. ChunkHashMap3x2 A 3-dimensional, 2-channel ChunkHashMap
. ChunkHashMap3x3 A 3-dimensional, 3-channel ChunkHashMap
. ChunkHashMap3x4 A 3-dimensional, 4-channel ChunkHashMap
. ChunkHashMap3x5 A 3-dimensional, 5-channel ChunkHashMap
. ChunkHashMap3x6 A 3-dimensional, 6-channel ChunkHashMap
. ChunkHashMapNx1 An N-dimensional, 1-channel ChunkHashMap
. ChunkKey2 A 2-dimensional ChunkKey
. ChunkKey3 A 3-dimensional ChunkKey
. ChunkMapBuilder2x1 A ChunkMapBuilder
for Array2x1
chunks. ChunkMapBuilder2x2 ChunkMapBuilder2x3 ChunkMapBuilder2x4 ChunkMapBuilder2x5 ChunkMapBuilder2x6 ChunkMapBuilder3x1 A ChunkMapBuilder
for Array3x1
chunks. ChunkMapBuilder3x2 ChunkMapBuilder3x3 ChunkMapBuilder3x4 ChunkMapBuilder3x5 ChunkMapBuilder3x6 ChunkMapBuilderNx1 A ChunkMapBuilder
for ArrayNx1
chunks. ChunkUnits2 ChunkUnits3 CompressibleChunkMap A ChunkMap
using CompressibleChunkStorage
as chunk storage. CompressibleChunkMap2x1 CompressibleChunkMap2x2 CompressibleChunkMap2x3 CompressibleChunkMap2x4 CompressibleChunkMap2x5 CompressibleChunkMap2x6 CompressibleChunkMap3x1 CompressibleChunkMap3x2 CompressibleChunkMap3x3 CompressibleChunkMap3x4 CompressibleChunkMap3x5 CompressibleChunkMap3x6 CompressibleChunkMapNx1 CompressibleChunkMapReader A ChunkMap
backed by a CompressibleChunkStorageReader
. CompressibleChunkMapReader2x1 CompressibleChunkMapReader2x2 CompressibleChunkMapReader2x3 CompressibleChunkMapReader2x4 CompressibleChunkMapReader2x5 CompressibleChunkMapReader2x6 CompressibleChunkMapReader3x1 CompressibleChunkMapReader3x2 CompressibleChunkMapReader3x3 CompressibleChunkMapReader3x4 CompressibleChunkMapReader3x5 CompressibleChunkMapReader3x6 CompressibleChunkMapReaderNx1 Extent2 A 2-dimensional extent with scalar type T
. Extent3 A 3-dimensional extent with scalar type T
. Extent2f A 2-dimensional extent with scalar type f32
. Extent2i A 2-dimensional extent with scalar type i32
. Extent3f A 3-dimensional extent with scalar type f32
. Extent3i A 3-dimensional extent with scalar type i32
. FastCompressibleChunkStorage FastCompressibleChunkStorageNx1 FastCompressibleChunkStorageNx2 FastCompressibleChunkStorageNx3 FastCompressibleChunkStorageNx4 FastCompressibleChunkStorageNx5 FastCompressibleChunkStorageNx6 LocalChunkCache2 A LocalCache
of 2D chunks. LocalChunkCache3 A LocalCache
of 3D chunks. Point2 A 2-dimensional point with scalar type T
. Point3 A 3-dimensional point with scalar type T
. Point2f A 2-dimensional point with scalar type f32
. Point2i A 2-dimensional point with scalar type i32
. Point3f A 3-dimensional point with scalar type f32
. Point3i A 3-dimensional point with scalar type i32
. SmallKeyHashMap