neocturne/MinedMap
1
0
Fork 0
mirror of https://github.com/neocturne/MinedMap.git synced 2025-07-04 06:39:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

treewide: add more documentation

Browse source
This commit is contained in:
Matthias Schiffer 2023-02-12 20:59:23 +01:00
parent 5ee114ed0a
commit 493608ebc8
Signed by: neocturne
GPG key ID: 16EF3F64CB201D9C
3 changed files with 53 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/types.rs
View file

@ -19,6 +19,7 @@ pub struct BlockY(pub u8);
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BlockZ(pub u8);
/// X, Y and Z coordinates of a block in a chunk section
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct BlockCoords {
pub x: BlockX,
@ -27,6 +28,11 @@ pub struct BlockCoords {
}
impl BlockCoords {
/// Computes a block's offset in various data structures
///
/// Many chunk data structures store block and biome data in the same
/// order. [BlockCoords::offset] computes the offset at which the data
/// for the block at a given coordinate is stored.
pub fn offset(&self) -> usize {
use BLOCKS_PER_CHUNK as N;
let x = self.x.0 as usize;
@ -69,6 +75,9 @@ impl Debug for ChunkCoords {
}
}
/// Generic array for data stored per chunk of a region
///
/// Includes various convenient iteration functions.
#[derive(Debug, Clone, Copy, Default)]
pub struct ChunkArray<T>(pub [[T; CHUNKS_PER_REGION]; CHUNKS_PER_REGION]);
@ -105,11 +114,14 @@ impl<T> IndexMut<ChunkCoords> for ChunkArray<T> {
}
}
/// Calculate division and remainder at the same time
pub trait DivRem<Rhs>
where
Self: Div<Rhs>,
Self: Rem<Rhs>,
{
/// Returns the result of the division and remainder operations
/// with the same inputs
fn div_rem(self, rhs: Rhs) -> (<Self as Div<Rhs>>::Output, <Self as Rem<Rhs>>::Output);
}