OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Properties | List of all members
OmegaEngine.Values.NibbleGrid Class Reference

A 2D grid of nibble (half a byte / 4 bits) values that can be stored in 16 colors PNG files. More...

Inheritance diagram for OmegaEngine.Values.NibbleGrid:
OmegaEngine.Values.Grid< T >

Public Member Functions

 NibbleGrid (int width, int height)
 
 NibbleGrid ([NotNull] byte[,] data)
 
override unsafe Bitmap GenerateBitmap ()
 Generates a bitmap representation of the grid.
 
- Public Member Functions inherited from OmegaEngine.Values.Grid< T >
ClampedRead (int x, int y)
 Reads a value in the grid and automatically clamps out of bound values of x or y . More...
 
void Save ([NotNull, Localizable(false)] string path)
 Saves the grid to a PNG file. More...
 
void Save ([NotNull] Stream stream)
 Saves the grid to a PNG stream. More...
 

Static Public Member Functions

static NibbleGrid Load ([NotNull] Stream stream)
 Loads a grid from a PNG stream. More...
 

Properties

override byte this[int x, int y] [get, set]
 Gets or sets a value in the grid. More...
 
- Properties inherited from OmegaEngine.Values.Grid< T >
virtual T this[int x, int y] [get, set]
 

Additional Inherited Members

- Public Attributes inherited from OmegaEngine.Values.Grid< T >
int Width => Data.GetLength(0)
 The width of the grid (number of values along the X axis). More...
 
int Height => Data.GetLength(1)
 The height of the grid (number of values along the Y axis). More...
 
- Protected Member Functions inherited from OmegaEngine.Values.Grid< T >
 Grid (int width, int height)
 Creates a new empty grid. More...
 
 Grid (T[,] data)
 Creates a new grid based on an existing array. More...
 
- Package Attributes inherited from OmegaEngine.Values.Grid< T >
readonly T[,] Data
 The internal array containing the values. More...
 

Detailed Description

A 2D grid of nibble (half a byte / 4 bits) values that can be stored in 16 colors PNG files.

Member Function Documentation

static NibbleGrid OmegaEngine.Values.NibbleGrid.Load ( [NotNull] Stream  stream)
inlinestatic

Loads a grid from a PNG stream.

Exceptions
ArgumentOutOfRangeExceptionAny of the colors in the imag is not part of the classic 16 colors palette.

Property Documentation

override byte OmegaEngine.Values.NibbleGrid.this[int x, int y]
getset

Gets or sets a value in the grid.

Exceptions
IndexOutOfRangeExceptionx or y are out of bounds.
ArgumentOutOfRangeExceptionA value larger than 15 is set.

The documentation for this class was generated from the following file: