Search Results for

    Show / Hide Table of Contents

    Interface IMousepad

    Interface for mouse pad functionality.

    Inherited Members
    IDevice.ClearAsync()
    IDevice.SetAllAsync(Color)
    IDevice.SetEffectAsync(Guid)
    IDevice.CurrentEffectId
    Namespace: Colore
    Assembly: Colore.dll
    Syntax
    public interface IMousepad : IDevice

    Properties

    Item[Int32]

    Gets or sets a specific LED on the mouse pad.

    Declaration
    Color this[int index] { get; set; }
    Parameters
    Type Name Description
    Int32 index

    The index to access.

    Property Value
    Type Description
    Color

    The current Color at the index.

    Methods

    SetCustomAsync(CustomMousepadEffect)

    Sets a custom effect on the mouse pad.

    Declaration
    Task<Guid> SetCustomAsync(CustomMousepadEffect effect)
    Parameters
    Type Name Description
    CustomMousepadEffect effect

    An instance of the CustomMousepadEffect struct.

    Returns
    Type Description
    Task<Guid>

    A Guid for the effect that was set.

    SetEffectAsync(MousepadEffectType)

    Sets an effect without any parameters. Currently, this only works for the None effect.

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

    Effect options.

    Returns
    Type Description
    Task<Guid>

    A Guid for the effect that was set.

    SetStaticAsync(Color)

    Sets a static color effect on the mouse pad.

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

    Color to set.

    Returns
    Type Description
    Task<Guid>

    A Guid for the effect that was set.

    SetStaticAsync(StaticMousepadEffect)

    Sets a static color effect on the mouse pad.

    Declaration
    Task<Guid> SetStaticAsync(StaticMousepadEffect effect)
    Parameters
    Type Name Description
    StaticMousepadEffect effect

    An instance of the StaticMousepadEffect struct.

    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