Struct BiomeColorMap 

pub struct BiomeColorMap(/* private fields */);

A map of biomeids to colors

This function is useful for generating pictures of biome maps.

The colors are mapped as an array, the elements corresponding to the Red Green And blue value respectively. eg [RED, GREEN, BLUE] The map should contain all biomes available in minecraft.

The color scheme comes from cubiomes. The color scheme in cubiomes is strongly inspired by the color scheme used in AMIDST

It’s implemented as its own type which uses an array as its backend. The array maps each biomeid number to a color. The id’s which dont map to a id are 0.

Usage

The map is meant to use by indexing

Examples

// Modify a specific biomes color from the default
use cubiomes::{enums::BiomeID, colors::BiomeColorMap};

let mut color_map = BiomeColorMap::default();
let new_color = [0, 120, 255];

color_map[BiomeID::badlands] = new_color;

assert_eq!(color_map[BiomeID::badlands], new_color);

Details

The arraymap approach was benchmarked to be faster than a map type. If you still desire a seperate map type you can use new_biome_color_map() instead.

Implementations

impl BiomeColorMap

pub fn new() -> Self

Constructs a new BiomeColorMap with colors from cubiomes.

pub fn get(&self, idx: BiomeID) -> &[u8; 3]

Gets a specific BiomeID’s color from the map. If not found (for some reason) returns None. The map should contain all biomes.

pub fn get_mut(&mut self, idx: BiomeID) -> &mut [u8; 3]

Gets a mutable reference to a specific BiomeID’s color.

The function can be used to mutate the color map

pub fn as_arr(&self) -> &[[u8; 3]; 256]

Returns a reference to the underlying array of the map.

pub fn to_arr(&self) -> [[u8; 3]; 256]

Returns a copy of the underlying array in the map.

Trait Implementations

impl Clone for BiomeColorMap

fn clone(&self) -> BiomeColorMap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BiomeColorMap

impl Debug for BiomeColorMap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BiomeColorMap

fn default() -> Self

Returns the “default value” for a type.

impl Index<BiomeID> for BiomeColorMap

type Output = [u8; 3]

The returned type after indexing.

fn index(&self, index: BiomeID) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<BiomeID> for BiomeColorMap

fn index_mut(&mut self, index: BiomeID) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.