Class Image

constructor

• new Image(width, height, data, channels, id, bitsPerPixel, byteWidth, colorMode?, pixelDensity?): Image

• Image class constructor

  Parameters

  • width: number

    Image width in pixels

  • height: number

    Image height in pixels

  • data: Buffer

    Generic Image data

  • channels: number

    Amount of Image channels

  • id: string

    Image identifier

  • bitsPerPixel: number

    Number of bits per single pixel

  • byteWidth: number

    Total number of bytes per image line

  • colorMode: ColorMode = ColorMode.BGR

    An images color mode, defaults to ColorMode.BGR

  • pixelDensity: {
        scaleX: number;
        scaleY: number;
    } = ...

    Object containing scale info to work with e.g. Retina display data where the reported display size and pixel size differ (Default: {scaleX: 1.0, scaleY: 1.0})

    • scaleX: number

    • scaleY: number

  Returns Image

Readonly bitsPerPixel

Readonly byteWidth

Readonly channels

Readonly colorMode

Readonly data

Readonly height

Readonly id

Readonly pixelDensity

Readonly width

hasAlphaChannel

• get hasAlphaChannel(): boolean

• hasAlphaChannel return true if an Image has an additional (fourth) alpha channel

  Returns boolean

toBGR

• toBGR(): Promise<Image>

• toBGR converts an Image from RGB color mode to RGB

  Returns Promise<Image>

toRGB

• toRGB(): Promise<Image>

• toRGB converts an Image from BGR color mode (default within nut.js) to RGB

  Returns Promise<Image>

Static fromRGBData

• fromRGBData(width, height, data, channels, id, bitsPerPixel, byteWidth): Image

• fromRGBData creates an Image from provided RGB data

  Parameters

  • width: number

  • height: number

  • data: Buffer

  • channels: number

  • id: string

  • bitsPerPixel: number

  • byteWidth: number

  Returns Image