Search Results for

    Show / Hide Table of Contents

    Interface IDevice

    Interface for functionality common with all devices.

    Namespace: Colore
    Assembly: Colore.dll
    Syntax
    public interface IDevice

    Properties

    CurrentEffectId

    Gets the ID of the currently active effect.

    Declaration
    Guid CurrentEffectId { get; }
    Property Value
    Type Description
    Guid

    Methods

    ClearAsync()

    Clears the current effect on the device.

    Declaration
    Task<Guid> ClearAsync()
    Returns
    Type Description
    Task<Guid>

    A Guid for the effect that was set.

    SetAllAsync(Color)

    Sets the color of all components on this device.

    Declaration
    Task<Guid> SetAllAsync(Color color)
    Parameters
    Type Name Description
    Color color

    Color to set.

    Returns
    Type Description
    Task<Guid>

    A Guid for the effect that was set.

    SetEffectAsync(Guid)

    Updates the device to use the effect pointed to by the specified GUID.

    Declaration
    Task<Guid> SetEffectAsync(Guid effectId)
    Parameters
    Type Name Description
    Guid effectId

    GUID to set.

    Returns
    Type Description
    Task<Guid>

    A Guid for the effect that was set.

    In This Article
    Back to top Copyright © 2015-2022 by Adam Hellberg and Brandon Scott
    Generated by DocFX