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

    Interface CardGenerator

    interface CardGenerator {
        generateBasicCard(
            width: number,
            height: number,
            pixelFormat: SurfaceSchemaPixelFormat,
        ): Promise<Uint8Array<ArrayBufferLike>>;
        generateLcdStripCard(
            width: number,
            height: number,
            pixelFormat: SurfaceSchemaPixelFormat,
        ): Promise<Uint8Array<ArrayBufferLike>>;
        generateLogoCard(
            width: number,
            height: number,
            pixelFormat: SurfaceSchemaPixelFormat,
        ): Promise<Uint8Array<ArrayBufferLike>>;
    }
    Index

    Methods

    generateBasicCard generateLcdStripCard generateLogoCard

    Methods

    • Generate a basic placeholder status card. This is typically a large logo in the middle, with some status text along the bottom.

      Parameters

      • width: number

        Width of the card in pixels

      • height: number

        Height of the card in pixels

      • pixelFormat: SurfaceSchemaPixelFormat

        Pixel format of the card

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Generate a basic status card designed for a wide and short LCD strip display.

      Parameters

      • width: number

        Width of the card in pixels

      • height: number

        Height of the card in pixels

      • pixelFormat: SurfaceSchemaPixelFormat

        Pixel format of the card

      Returns Promise<Uint8Array<ArrayBufferLike>>

    Settings

    Member Visibility

    On This Page

    Methods