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

A 2D grid of byte values that can be stored in grayscale PNG files. More...

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

Public Member Functions

 ByteGrid (int width, int height)
 
 ByteGrid (byte[,] data)
 
float SampledRead (float x, float y)
 Performs bilinear interpolation to get values lying between discrete grid points. More...
 
bool IsInRange (float x, float y)
 Returns true if the specified coordinates are within the bounds of the grid. More...
 
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 ByteGrid Load ([NotNull] Stream stream)
 Loads a grid from a PNG stream. More...
 

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...
 
- Properties inherited from OmegaEngine.Values.Grid< T >
virtual T this[int x, int y] [get, set]
 

Detailed Description

A 2D grid of byte values that can be stored in grayscale PNG files.

Member Function Documentation

bool OmegaEngine.Values.ByteGrid.IsInRange ( float  x,
float  y 
)

Returns true if the specified coordinates are within the bounds of the grid.

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

Loads a grid from a PNG stream.

float OmegaEngine.Values.ByteGrid.SampledRead ( float  x,
float  y 
)
inline

Performs bilinear interpolation to get values lying between discrete grid points.


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