kotlin-electron/electron.core/NativeImage

NativeImage

external class NativeImage(source)

Constructors

NativeImage

constructor()

Types

Companion

object Companion

Properties

isMacTemplateImage

var isMacTemplateImage: Boolean

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

Functions

addRepresentation

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

fun crop(rect: Rectangle): NativeImage

The cropped image.

getAspectRatio

fun getAspectRatio(scaleFactor: Double = definedExternally): Double

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

getBitmap

fun getBitmap(options: BitmapOptions = definedExternally)

Legacy alias for image.toBitmap().

getNativeHandle

fun getNativeHandle(): ERROR CLASS: Symbol not found for Buffer<*>

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

getScaleFactors

fun getScaleFactors(): ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Double>

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

getSize

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

fun isEmpty(): Boolean

Whether the image is empty.

isTemplateImage

fun isTemplateImage(): Boolean

Whether the image is a macOS template image.

resize

fun resize(options: ResizeOptions): NativeImage

The resized image.

setTemplateImage

fun setTemplateImage(option: Boolean)

Marks the image as a macOS template image.

toBitmap

fun toBitmap(options: ToBitmapOptions = definedExternally): ERROR CLASS: Symbol not found for Buffer<*>

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

toDataURL

fun toDataURL(options: ToDataURLOptions = definedExternally): String

The Data URL of the image.

toJPEG

fun toJPEG(quality: Double): ERROR CLASS: Symbol not found for Buffer<*>

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

toPNG

fun toPNG(options: ToPNGOptions = definedExternally): ERROR CLASS: Symbol not found for Buffer<*>

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