Interface IPixelDisplay

Represents a pixel based graphics display

Assembly: Meadow.Contracts.dll

View Source

Declaration

public interface IPixelDisplay : IDisplay

Properties

ColorMode

The currently set color mode for the display

View Source

Declaration

ColorMode ColorMode { get; }

SupportedColorModes

The Color mode supported by the display

View Source

Declaration

ColorMode SupportedColorModes { get; }

Width

Width of the display in pixels

View Source

Declaration

int Width { get; }

Height

Height of the display in pixels

View Source

Declaration

int Height { get; }

PixelBuffer

Provide a buffer that matches this display's color depth, height, and width This should be the buffer that is sent to the device when Show is called

View Source

Declaration

IPixelBuffer PixelBuffer { get; }

EnabledColor

The color to draw when a pixel is enabled

View Source

Declaration

Color EnabledColor { get; }

DisabledColor

The color to draw when a pixel is disabled

View Source

Declaration

Color DisabledColor { get; }

Methods

IsColorTypeSupported(ColorMode)

Is the color mode supported on this display

View Source

Declaration

bool IsColorTypeSupported(ColorMode mode)

Returns

System.Boolean

Parameters

Type	Name	Description
Meadow.Peripherals.Displays.ColorMode	mode	The color mode

SetColorMode(ColorMode)

Set the color mode for the display

View Source

Declaration

void SetColorMode(ColorMode mode)

Parameters

Type	Name
Meadow.Peripherals.Displays.ColorMode	mode

Show()

Transfer the contents of the buffer to the display

View Source

Declaration

void Show()

Show(int, int, int, int)

Transfer part of the contents of the buffer to the display bounded by left, top, right and bottom

View Source

Declaration

void Show(int left, int top, int right, int bottom)

Parameters

Type	Name
System.Int32	left
System.Int32	top
System.Int32	right
System.Int32	bottom

Clear(bool)

Clear the display

View Source

Declaration

void Clear(bool updateDisplay = false)

Parameters

Type	Name	Description
System.Boolean	updateDisplay	Update the display once the buffer has been cleared when true

Fill(Color, bool)

Clear the display

View Source

Declaration

void Fill(Color fillColor, bool updateDisplay = false)

Parameters

Type	Name	Description
Meadow.Color	fillColor	The color used to fill the display buffer
System.Boolean	updateDisplay	Update the display once the buffer has been cleared when true

Fill(int, int, int, int, Color)

Clear the display

View Source

Declaration

void Fill(int x, int y, int width, int height, Color fillColor)

Parameters

Type	Name	Description
System.Int32	x	x position in pixels
System.Int32	y	y position in pixels
System.Int32	width	width to fill in pixels
System.Int32	height	height to fill in pixels
Meadow.Color	fillColor	The color used to fill the display buffer

DrawPixel(int, int, Color)

Draw a single pixel at the specified color

View Source

Declaration

void DrawPixel(int x, int y, Color color)

Parameters

Type	Name	Description
System.Int32	x	x position in pixels
System.Int32	y	y position in pixels
Meadow.Color	color	The Meadow Foundation color of the pixel

DrawPixel(int, int, bool)

Enable or disable a single pixel (used for 1bpp displays)

View Source

Declaration

void DrawPixel(int x, int y, bool enabled)

Parameters

Type	Name	Description
System.Int32	x	x position in pixels
System.Int32	y	y position in pixels
System.Boolean	enabled	On if true, off if false

InvertPixel(int, int)

Invert the color of a single pixel

View Source

Declaration

void InvertPixel(int x, int y)

Parameters

Type	Name	Description
System.Int32	x	x position in pixels
System.Int32	y	y position in pixels

WriteBuffer(int, int, IPixelBuffer)

Draw a buffer to the display

View Source

Declaration

void WriteBuffer(int x, int y, IPixelBuffer displayBuffer)

Parameters

Type	Name
System.Int32	x
System.Int32	y
Meadow.Peripherals.Displays.IPixelBuffer	displayBuffer