Skip to main content

DisplaySettings Class

Package: GHIElectronics.Endpoint.Devices.Display
Namespace: GHIElectronics.Endpoint.Devices.Display

Everything in /config/display.json. Read with DisplayController.GetSettings and apply with DisplayController.SetSettings. Only the built-in Parallel transport has schema here; custom panels live in the customer's own Display.DisplayController subclass.

class DisplaySettings {};

Constructors​

DisplaySettings()​

DisplaySettings();

Properties​

Backlight​

BacklightSettings Backlight() const;
void Backlight(BacklightSettings value);

GPIO pin that drives the backlight, or null for "no backlight" or "customer's external backlight controller". The DisplayController does not fail when this is null - the panel is enabled, Flush works, the backlight is simply left alone.

Returns BacklightSettings

EnableAtBoot​

bool EnableAtBoot() const;
void EnableAtBoot(bool value);

True = the board brings up the built-in display during boot so the user's program sees a ready framebuffer. Only honoured for the built-in Parallel transport; custom subclasses init from their own code.

Returns bool

std::string Logo() const;
void Logo(std::string value);

Filename of a 24-bit uncompressed BMP on the config partition to show after Enable (null = none).

Returns string

Parallel​

ParallelLcdSettings Parallel() const;
void Parallel(ParallelLcdSettings value);

Timings for the SoC's parallel RGB panel. Required when DisplaySettings.Type is Parallel.

Returns ParallelLcdSettings

Type​

DisplayType Type() const;
void Type(DisplayType value);

Which transport the built-in display uses.

Returns DisplayType