Class ArtemisLayout

Namespace

Artemis.Core

Assembly

Artemis.Core.dll

Represents a device layout decorated with extra Artemis-specific data

public class ArtemisLayout

Inheritance

object

ArtemisLayout

Constructors

ArtemisLayout(string)

Creates a new instance of the ArtemisLayout class

public ArtemisLayout(string filePath)

Parameters

filePath string

The path of the layout XML file

Properties

FilePath

Gets the file path the layout was (attempted to be) loaded from

public string FilePath { get; }

Property Value

string

Image

Gets the image of the device

public Uri? Image { get; }

Property Value

Uri

IsDefaultLayout

Gets a boolean indicating whether this layout is a default layout or not

public bool IsDefaultLayout { get; }

Property Value

bool

IsValid

Gets a boolean indicating whether a valid layout was loaded

public bool IsValid { get; }

Property Value

bool

LayoutCustomDeviceData

Gets the custom layout data embedded in the RGB.NET layout

public LayoutCustomDeviceData LayoutCustomDeviceData { get; }

Property Value

LayoutCustomDeviceData

Leds

Gets a list of LEDs this layout contains

public List<ArtemisLedLayout> Leds { get; }

Property Value

List<ArtemisLedLayout>

RgbLayout

Gets the RGB.NET device layout

public DeviceLayout RgbLayout { get; }

Property Value

DeviceLayout

Methods

ApplyToDevice(IRGBDevice, bool, bool)

Applies the layout to the provided device

public void ApplyToDevice(IRGBDevice device, bool createMissingLeds = false, bool removeExcessiveLeds = false)

Parameters

device IRGBDevice

createMissingLeds bool

removeExcessiveLeds bool

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.