Image

The Image class represents generic image data

typescript

class Image

Properties

Name	Type	Description
`readonly bitsPerPixel`	`number`	Number of bits per single pixel
`readonly byteWidth`	`number`	Total number of bytes per image line
`readonly channels`	`number`	Amount of `Image` channels
`readonly colorMode`	`ColorMode`	An images color mode, defaults to `ColorMode.BGR`(default: `ColorMode.BGR`)
`readonly data`	`Buffer`	Generic `Image` data
`readonly height`	`number`	`Image` height in pixels
`readonly id`	`string`	Image identifier
`readonly 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})(default: `...`)
`readonly width`	`number`	`Image` width in pixels

toBGR(): Promise<Image>

toBGR converts an Image from RGB color mode to RGB

Promise<Image>

toDataURL(fileType: FileType): string

toDataURL encodes this Image as a base64 data URL string

fileTypeFileTypeThe target image format

string

toRGB(): Promise<Image>

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

Promise<Image>

fromRGBData(width: number, height: number, data: Buffer, channels: number, id: string, bitsPerPixel: number, byteWidth: number): Image

fromRGBData creates an Image from provided RGB data

widthnumber

heightnumber

dataBuffer

channelsnumber

idstring

bitsPerPixelnumber

byteWidthnumber

Image

Was this page helpful?