Skip to main content

Class EPaperMonoBase

Provide an interface for ePaper monochrome displays

Assembly: EPaper.dll
View Source
public abstract class EPaperMonoBase : EPaperBase, ISpiPeripheral, IDisposable, IGraphicsDisplay

Inheritance: System.Object -> Meadow.Foundation.Displays.EPaperBase

Derived:
Meadow.Foundation.Displays.Epd4in2, Meadow.Foundation.Displays.Il3897, Meadow.Foundation.Displays.Il91874V03, Meadow.Foundation.Displays.Ssd1608

Implements:
Meadow.Hardware.ISpiPeripheral, System.IDisposable, Meadow.Foundation.Graphics.IGraphicsDisplay

Properties

ColorMode

Display color mode

View Source
public ColorMode ColorMode { get; }

SupportedColorModes

The Color mode supported by the display

View Source
public ColorMode SupportedColorModes { get; }

PixelBuffer

The buffer the holds the pixel data for the display

View Source
public IPixelBuffer PixelBuffer { get; }

EnabledColor

The color to draw when a pixel is enabled

View Source
public Color EnabledColor { get; }

DisabledColor

The color to draw when a pixel is disabled

View Source
public Color DisabledColor { get; }

Width

Width of display in pixels

View Source
public int Width { get; }

Height

Height of display in pixels

View Source
public int Height { get; }

Fields

imageBuffer

Buffer to hold display data

View Source
protected readonly Buffer1bppV imageBuffer

Methods

Initialize()

Initialize display

View Source
protected abstract void Initialize()

Clear(bool)

Clear display buffer

View Source
public void Clear(bool updateDisplay = false)
Parameters
TypeNameDescription
System.BooleanupdateDisplayforce display update

Fill(Color, bool)

Clear the display

View Source
public void Fill(Color color, bool updateDisplay = false)
Parameters
TypeNameDescription
Meadow.ColorcolorColor to set the display (not used on ePaper displays)
System.BooleanupdateDisplayUpdate the display once the buffer has been cleared when true

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

Fill the display buffer with a color

View Source
public void Fill(int x, int y, int width, int height, Color color)
Parameters
TypeNameDescription
System.Int32xx location in pixels to start fill
System.Int32yy location in pixels to start fill
System.Int32widthwidth in pixels to fill
System.Int32heightheight in pixels to fill
Meadow.Colorcolorcolor to fill

Clear(bool, bool)

Clear the display

View Source
public void Clear(bool enabled, bool updateDisplay = false)
Parameters
TypeNameDescription
System.BooleanenabledSet the display to the enabled or disabled color (defaults are black and white)
System.BooleanupdateDisplayUpdate the display once the buffer has been cleared when true

DrawPixel(int, int, bool)

Draw a single pixel

View Source
public void DrawPixel(int x, int y, bool enabled)
Parameters
TypeNameDescription
System.Int32xx location
System.Int32yy location
System.BooleanenabledTurn the pixel on (true) or off (false)

DrawPixel(int, int, Color)

Draw a single pixel

View Source
public void DrawPixel(int x, int y, Color color)
Parameters
TypeNameDescription
System.Int32xx location
System.Int32yy location
Meadow.ColorcolorColor of pixel

InvertPixel(int, int)

Invert color of pixel

View Source
public void InvertPixel(int x, int y)
Parameters
TypeNameDescription
System.Int32xx coordinate of pixel
System.Int32yy coordinate of pixel

Show(int, int, int, int)

Draw the display buffer to screen

View Source
public virtual void Show(int left, int top, int right, int bottom)
Parameters
TypeName
System.Int32left
System.Int32top
System.Int32right
System.Int32bottom

Show()

Draw the display buffer to screen

View Source
public virtual void Show()

WriteBuffer(int, int, IPixelBuffer)

Draw a buffer at a specific location

View Source
public void WriteBuffer(int x, int y, IPixelBuffer displayBuffer)
Parameters
TypeNameDescription
System.Int32xx location in pixels
System.Int32yy location in pixels
Meadow.Foundation.Graphics.Buffers.IPixelBufferdisplayBuffer

SetFrameMemory(byte[], int, int, int, int)

Set frame buffer memory of display

View Source
public virtual void SetFrameMemory(byte[] buffer, int x, int y, int width, int height)
Parameters
TypeNameDescription
System.Byte[]bufferbuffer
System.Int32xx location
System.Int32yy location
System.Int32widthwidth in pixels
System.Int32heightheight in pixels

SetFrameMemory(byte[])

Set frame buffer memory of display (full screen)

View Source
public virtual void SetFrameMemory(byte[] buffer)
Parameters
TypeNameDescription
System.Byte[]bufferThe image buffer

DisplayFrame()

Display frame buffer

View Source
public virtual void DisplayFrame()

Sleep()

Set display to sleep mode

View Source
protected virtual void Sleep()

SendCommand(Command)

Set command to display

View Source
protected void SendCommand(EPaperMonoBase.Command command)
Parameters
TypeNameDescription
Meadow.Foundation.Displays.EPaperMonoBase.Commandcommandcommand

Implements