Interface IPixelBuffer
IPixelBuffer provides a standard interface for representing the display state of a device capable of displaying pixels. It specifies methods for performing common primitive operations on a buffer of pixel data.
Conceptually, implementing classes should:
- Specify a bit depth for pixels
- Specify a color mode
- Preserve the display state as a byte[] in the PixelBuffer
- Optimize primitive drawing methods for the bit depth of pixels
- Be abstracted/decoupled from a specific device driver
Assembly: Meadow.Foundation.dll
View Source
public interface IPixelBuffer
Properties
Width
The width of the pixel buffer
View Source
int Width { get; }
Height
The height of the pixel buffer
View Source
int Height { get; }
ColorMode
The ColorMode of the pixel buffer
View Source
ColorMode ColorMode { get; }
BitDepth
The BitDepth of the chosen ColorMode.
View Source
int BitDepth { get; }
ByteCount
The number of bytes in this pixel buffer
View Source
int ByteCount { get; }
Buffer
The byte array that holds all pixel data
View Source
byte[] Buffer { get; }
Methods
SetPixel(int, int, Color)
Set the color of the pixel at the provided coordinates
View Source
void SetPixel(int x, int y, Color color)
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | x | X coordinate of the pixel: 0,0 at top left |
System.Int32 | y | Y coordinate of the pixel: 0,0 at top left |
Meadow.Color | color | The pixel color |
GetPixel(int, int)
Get the color of a pixel - may be scaled based on buffer color depth
View Source
Color GetPixel(int x, int y)
Returns
Meadow.Color
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | x | X coordinate of the pixel: 0,0 at top left |
System.Int32 | y | Y coordinate of the pixel: 0,0 at top left |
InvertPixel(int, int)
Invert the color of a pixel at the provided location
View Source
void InvertPixel(int x, int y)
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | x | The X coord to invert |
System.Int32 | y | The Y coord to invert |
WriteBuffer(int, int, IPixelBuffer)
Writes another pixel buffer into this buffer.
View Source
void WriteBuffer(int originX, int originY, IPixelBuffer buffer)
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | originX | The X origin to start writing |
System.Int32 | originY | The Y origin to start writing |
| Meadow.Foundation.Graphics.Buffers.IPixelBuffer | buffer | The buffer to write into this buffer |
Fill(Color)
Fills the buffer with the provided color
View Source
void Fill(Color color)
Parameters
| Type | Name | Description |
|---|---|---|
Meadow.Color | color | The color to fill |
Fill(int, int, int, int, Color)
Fills part of the buffer with the provided color
View Source
void Fill(int originX, int originY, int width, int height, Color color)
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | originX | The X coord to start filling |
System.Int32 | originY | The Y coord to start filling |
System.Int32 | width | The width to fill |
System.Int32 | height | The height to fill |
Meadow.Color | color | The color to fill |
Clear()
Clears the buffer (writes 0s to the byte array)
View Source
void Clear()
Clear(int, int, int, int)
Clears a region of the buffer (writes 0s to the byte array)
View Source
void Clear(int originX, int originY, int width, int height)
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | originX | The X coord to start |
System.Int32 | originY | The Y coord to start |
System.Int32 | width | The width of the region to clear |
System.Int32 | height | The height of the region to clear |