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

Add documentation comments for all items

Browse source
This commit is contained in:
Matthias Schiffer 2023-08-18 19:13:43 +02:00
parent ba86dc8c06
commit 05a8056cbf
Signed by: neocturne
GPG key ID: 16EF3F64CB201D9C
26 changed files with 576 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/util.rs
View file

@ -1,6 +1,10 @@
//! Utility functions and extension traits
use crate::types::*;
/// Extension trait for combined bit shift and mask
pub trait ShiftMask: Sized {
/// Output type of shift operation
type MaskedOutput;
/// Apply a right shift to a value, and return both the result and the
@ -27,6 +31,8 @@ impl ShiftMask for i32 {
}
}
/// Combines a coordinate split into region, chunk and block number to
/// a single linear coordinate
#[inline]
pub fn to_flat_coord<const AXIS: u8>(
region: i8,
@ -36,6 +42,7 @@ pub fn to_flat_coord<const AXIS: u8>(
(region as i32) << (BLOCK_BITS + CHUNK_BITS) | ((chunk.0 as i32) << BLOCK_BITS | block.0 as i32)
}
/// Splits a flat (linear) coordinate into region, chunk and block numbers
#[inline]
pub fn from_flat_coord<const AXIS: u8>(coord: i32) -> (i8, ChunkCoord<AXIS>, BlockCoord<AXIS>) {
let (region_chunk, block) = coord.shift_mask(BLOCK_BITS);