Interface RingData

Represents the ring- and background-related properties for a given size

interface RingData {
    bkgName: string | undefined;
    colorBand: RingColorBand | undefined;
    defaultBackgroundColorLittleEndian: number | null;
    defaultRingColorLittleEndian: number | null;
    maskName: string | undefined;
    ringName: string | undefined;
    subjectScaleAdjustment: number | null;
}

Properties

bkgName: string | undefined

The filename of the background asset, if available

colorBand: RingColorBand | undefined

Defines color stops for the ring gradient, if applicable

defaultBackgroundColorLittleEndian: number | null

Default color for the background in little-endian BBGGRR format, or null if not set

defaultRingColorLittleEndian: number | null

Default color for the ring in little-endian BBGGRR format, or null if not set

maskName: string | undefined

The filename of the mask asset, if available

ringName: string | undefined

The filename of the ring asset, if available

subjectScaleAdjustment: number | null

Scaling factor to adjust how the subject texture fits within the ring, or null if unavailable