kotlin-electron/electron.core/NativeImage

NativeImage

external class NativeImage(source)

Constructors

NativeImage

constructor()

Types

Companion

external object Companion

Properties

isMacTemplateImage

external var isMacTemplateImage: Boolean

A boolean property that determines whether the image is considered a template image.

Functions

addRepresentation

external fun addRepresentation(options: AddRepresentationOptions)

Add an image representation for a specific scale factor. This can be used to programmatically add different scale factor representations to an image. This can be called on empty images.

crop

external fun crop(rect: Rectangle): NativeImage

The cropped image.

getAspectRatio

external fun getAspectRatio(scaleFactor: Double = definedExternally): Double

The image's aspect ratio (width divided by height).

getBitmap

external fun getBitmap(options: BitmapOptions = definedExternally)

Legacy alias for image.toBitmap().

getNativeHandle

external fun getNativeHandle(): Buffer<*>

A Buffer that stores C pointer to underlying native handle of the image. On macOS, a pointer to NSImage instance is returned.

getScaleFactors

external fun getScaleFactors(): ReadonlyArray<Double>

An array of all scale factors corresponding to representations for a given NativeImage.

getSize

external fun getSize(scaleFactor: Double = definedExternally): Size

If scaleFactor is passed, this will return the size corresponding to the image representation most closely matching the passed value.

isEmpty

external fun isEmpty(): Boolean

Whether the image is empty.

isTemplateImage

external fun isTemplateImage(): Boolean

Whether the image is a macOS template image.

resize

external fun resize(options: ResizeOptions): NativeImage

The resized image.

setTemplateImage

external fun setTemplateImage(option: Boolean)

Marks the image as a macOS template image.

toBitmap

external fun toBitmap(options: ToBitmapOptions = definedExternally): Buffer<*>

A Buffer that contains a copy of the image's raw bitmap pixel data.

toDataURL

external fun toDataURL(options: ToDataURLOptions = definedExternally): String

The Data URL of the image.

toJPEG

external fun toJPEG(quality: Double): Buffer<*>

A Buffer that contains the image's JPEG encoded data.

toPNG

external fun toPNG(options: ToPNGOptions = definedExternally): Buffer<*>

A Buffer that contains the image's PNG encoded data.