Characteristic Locus
Inheritance System.Object SpiDisplayBase > EpdBase > Il3897 > Il91874V03 > Ssd1608
Implements IGraphicsDisplay
Inherited Members SpiDisplayBase.commandBuffer SpiDisplayBase.dataCommandPort SpiDisplayBase.resetPort SpiDisplayBase.chipSelectPort SpiDisplayBase.busyPort SpiDisplayBase.spiPeripheral SpiDisplayBase.DataState SpiDisplayBase.CommandState SpiDisplayBase.Write(Byte) SpiDisplayBase.Reset() SpiDisplayBase.DelayMs(Int32) SpiDisplayBase.SendCommand(Byte) SpiDisplayBase.SendData(Int32) SpiDisplayBase.SendData(Byte) SpiDisplayBase.SendData(Byte[]) SpiDisplayBase.WaitUntilIdle()
Namespace Meadow.Foundation.Displays.ePaper
Assembly EPaper.dll

Syntax

public abstract class EpdBase : SpiDisplayBase, IGraphicsDisplay

Constructors

EpdBase(IMeadowDevice, ISpiBus, IPin, IPin, IPin, IPin, Int32, Int32)

Declaration
public EpdBase(IMeadowDevice device, ISpiBus spiBus, IPin chipSelectPin, IPin dcPin, IPin resetPin, IPin busyPin, int width, int height)

Parameters

Type Name Description
IMeadowDevice device
ISpiBus spiBus
IPin chipSelectPin
IPin dcPin
IPin resetPin
IPin busyPin
System.Int32 width
System.Int32 height

Fields

imageBuffer

Declaration
protected readonly Buffer1 imageBuffer

Field Value

Type Description
Buffer1

Properties

ColorMode

Declaration
public ColorType ColorMode { get; }

Property Value

Type Description
ColorType

Height

Declaration
public int Height { get; }

Property Value

Type Description
System.Int32

IgnoreOutOfBoundsPixels

Declaration
public bool IgnoreOutOfBoundsPixels { get; set; }

Property Value

Type Description
System.Boolean

Width

Declaration
public int Width { get; }

Property Value

Type Description
System.Int32

Methods

Clear(Boolean)

Declaration
public void Clear(bool updateDisplay = false)

Parameters

Type Name Description
System.Boolean updateDisplay

Clear(Boolean, Boolean)

Clear the display.

Declaration
public void Clear(bool colored, bool updateDisplay = false)

Parameters

Type Name Description
System.Boolean colored

Set the display dark when true

System.Boolean updateDisplay

Update the dipslay once the buffer has been cleared when true.

ClearFrameMemory(Byte)

Declaration
public virtual void ClearFrameMemory(byte color)

Parameters

Type Name Description
System.Byte color

DisplayFrame()

Declaration
public virtual void DisplayFrame()

DrawBuffer(Int32, Int32, IDisplayBuffer)

Declaration
public void DrawBuffer(int x, int y, IDisplayBuffer displayBuffer)

Parameters

Type Name Description
System.Int32 x
System.Int32 y
IDisplayBuffer displayBuffer

DrawPixel(Int32, Int32, Color)

Draw a single pixel

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

Parameters

Type Name Description
System.Int32 x

x location

System.Int32 y

y location

Color color

Color of pixel.

DrawPixel(Int32, Int32, Boolean)

Draw a single pixel

Declaration
public void DrawPixel(int x, int y, bool colored)

Parameters

Type Name Description
System.Int32 x

x location

System.Int32 y

y location

System.Boolean colored

Turn the pixel on (true) or off (false).

DrawPixel(Int32, Int32, Byte, Byte, Byte)

Draw a single pixel

Declaration
public void DrawPixel(int x, int y, byte r, byte g, byte b)

Parameters

Type Name Description
System.Int32 x

x location

System.Int32 y

y location

System.Byte r

y location

System.Byte g

y location

System.Byte b

y location

Fill(Color, Boolean)

Clear the display.

Declaration
public void Fill(Color color, bool updateDisplay = false)

Parameters

Type Name Description
Color color

Color to set the display (not used on ePaper displays)

System.Boolean updateDisplay

Update the dipslay once the buffer has been cleared when true.

Fill(Int32, Int32, Int32, Int32, Color)

Declaration
public void Fill(int x, int y, int width, int height, Color color)

Parameters

Type Name Description
System.Int32 x
System.Int32 y
System.Int32 width
System.Int32 height
Color color

Initialize()

Declaration
protected abstract void Initialize()

InvertPixel(Int32, Int32)

Declaration
public void InvertPixel(int x, int y)

Parameters

Type Name Description
System.Int32 x
System.Int32 y

SendCommand(EpdBase.Command)

Declaration
protected void SendCommand(EpdBase.Command command)

Parameters

Type Name Description
EpdBase.Command command

SetFrameMemory(Byte[])

Declaration
public virtual void SetFrameMemory(byte[] image_buffer)

Parameters

Type Name Description
System.Byte[] image_buffer

SetFrameMemory(Byte[], Int32, Int32, Int32, Int32)

Declaration
public virtual void SetFrameMemory(byte[] image_buffer, int x, int y, int image_width, int image_height)

Parameters

Type Name Description
System.Byte[] image_buffer
System.Int32 x
System.Int32 y
System.Int32 image_width
System.Int32 image_height

Show()

Draw the display buffer to screen

Declaration
public void Show()

Show(Int32, Int32, Int32, Int32)

Draw the display buffer to screen

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

Parameters

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

Sleep()

Declaration
protected void Sleep()