Interface IFrameBuffer

Namespace

Iot.Device.EPaper.Buffers

Assembly

Iot.Device.ePaper.dll

Represents a display frame buffer.

public interface IFrameBuffer

Properties

BitDepth

Gets the bit depth of the frame.

int BitDepth { get; }

Property Value

int

Buffer

Gets the internal buffer representing this frame.

byte[] Buffer { get; }

Property Value

byte[]

BufferByteCount

Gets the total number of bytes that the current buffer is made of.

int BufferByteCount { get; }

Property Value

int

ColorFormat

Gets the color format used across this frame buffer.

ColorFormat ColorFormat { get; }

Property Value

ColorFormat

CurrentFramePage

Gets or sets the current frame page index which this frame instance is covering.

int CurrentFramePage { get; set; }

Property Value

int

Height

Gets the width of the buffer in pixel.

int Height { get; }

Property Value

int

this[Point]

Gets or sets a byte from the Buffer using the specified point.

byte this[Point point] { get; set; }

Parameters

point Point

The point to get the byte containing the pixel.

Property Value

byte

A byte that contains the pixel specified by the point.

this[int]

Gets or sets a byte from the Buffer using the specified index value.

byte this[int index] { get; set; }

Parameters

index int

The index of the byte to get.

Property Value

byte

A byte from Buffer

StartPoint

Gets or sets the position from which this frame's area starts.

Point StartPoint { get; set; }

Property Value

Point

Width

Gets the height of the buffer in pixel.

int Width { get; }

Property Value

int

Methods

Clear()

Resets the current frame buffer to its default starting values (all pixels set to 0).

void Clear()

Clear(Color)

Resets the current frame buffer to with its default starting values set to the specified color.

void Clear(Color color)

Parameters

color Color

The color to use as a default value when clearing the frame buffer.

Fill(Color)

Fill the entire frame buffer using the specified color.

void Fill(Color color)

Parameters

color Color

The color to fill the frame with.

Fill(Point, int, int, Color)

Fill the specific portion of the frame buffer with the specified color.

void Fill(Point start, int width, int height, Color color)

Parameters

start Point

The starting position.

width int

The width of the area.

height int

The height of the area.

color Color

The color value to use.

GetPixel(Point)

Gets the pixel at the specified position.

Color GetPixel(Point point)

Parameters

point Point

The position to get the pixel from.

Returns

Color

Color representing the specified pixel.

IsPointWithinFrameBuffer(Point)

Checks if the specified point falls within the area this buffer is covering.

bool IsPointWithinFrameBuffer(Point point)

Parameters

point Point

The point to check.

Returns

bool

True if the point is within this frame's area, otherwise; false.

IsRangeWithinFrameBuffer(Point, Point)

Checks if the specified range of points is within the current frame buffer.

bool IsRangeWithinFrameBuffer(Point start, Point end)

Parameters

start Point

The starting point of the range.

end Point

The end point of the range.

Returns

bool

True if the range is within this frame's area, otherwise; false.

SetPixel(Point, Color)

Sets the value of the pixel at the specified position.

void SetPixel(Point point, Color pixelColor)

Parameters

point Point

The position to set the pixel.

pixelColor Color

The pixel color value to use.

WriteBuffer(IFrameBuffer)

Copies the entire specified IFrameBuffer into the current frame buffer.

void WriteBuffer(IFrameBuffer buffer)

Parameters

buffer IFrameBuffer

The IFrameBuffer to copy from.

WriteBuffer(IFrameBuffer, Point)

Copies the specified IFrameBuffer into the current frame buffer.

void WriteBuffer(IFrameBuffer buffer, Point destinationStart)

Parameters

buffer IFrameBuffer

The IFrameBuffer to copy from.

destinationStart Point

The start point to begin writing to.

WriteBuffer(IFrameBuffer, Point, Point, Point)

Copies the specified IFrameBuffer into the current frame buffer.

void WriteBuffer(IFrameBuffer buffer, Point start, Point end, Point destinationStart)

Parameters

buffer IFrameBuffer

The IFrameBuffer to copy from.

start Point

The start position to copy from.

end Point

The point at which copying from the buffer will stop.

destinationStart Point

The start point to begin writing to.