kotlin-electron/electron.core/NativeImage/Companion

Companion

Functions

Creates an empty NativeImage instance.

fun createFromBitmap(buffer: Buffer, options: CreateFromBitmapOptions): NativeImage

Creates a new NativeImage instance from buffer that contains the raw bitmap pixel data returned by toBitmap(). The specific format is platform-dependent.

createFromBuffer

fun createFromBuffer(buffer: Buffer, options: CreateFromBufferOptions = definedExternally): NativeImage

Creates a new NativeImage instance from buffer. Tries to decode as PNG or JPEG first.

createFromDataURL

fun createFromDataURL(dataURL: String): NativeImage

Creates a new NativeImage instance from dataUrl, a base 64 encoded Data URL string.

createFromNamedImage

fun createFromNamedImage(imageName: String, hslShift: ReadonlyArray<Double> = definedExternally): NativeImage

Creates a new NativeImage instance from the NSImage that maps to the given image name. See Apple's NSImageName documentation for a list of possible values.

createFromPath

fun createFromPath(path: String): NativeImage

Creates a new NativeImage instance from a file located at path. This method returns an empty image if the path does not exist, cannot be read, or is not a valid image.

createThumbnailFromPath

fun createThumbnailFromPath(path: String, size: Size): Promise<NativeImage>

fulfilled with the file's thumbnail preview image, which is a NativeImage.