@companion-surface/base
    Preparing search index...

    Interface SurfaceDrawProps

    interface SurfaceDrawProps {
        color?: string;
        controlId: string;
        image?: Uint8Array<ArrayBufferLike>;
        pageNumber?: number;
        text?: string;
    }
    Index

    Properties

    color? controlId image? pageNumber? text?

    Properties

    color?: string

    If the surface requested a background color, this is the color to display This is typically only used for surfaces which have buttons with a RGB backlight

    controlId: string
    image?: Uint8Array<ArrayBufferLike>

    If the surface requested an image to be drawn, this Uint8Array will contain the pixel data in the requested dimensions and format

    pageNumber?: number

    The Companion page number that the surface is currently on, if this is applicable.

    Optionaltext

    text?: string

    If the surface requested button text, this is the text to draw This is typically only used for surfaces which have buttons with text-only displays

    Settings

    Member Visibility

    On This Page

    Properties