Image
Native image.
| Module | require("gui") |
| Type | Class |
High DPI Image
By appending @{scaleFactor}x to the image's base filename, you can mark
the image as a high DPI image. For example an image file with filename of
icon@2x.png will have scale factor of 2.
Template Image
On macOS you can mark an image as template image by putting Template to
its base filename, for example iconTemplate.png and iconTemplate@2x.png.
Template images should consist of only black and clear colors, and macOS will mix with other content to create best appearance. This is useful for tray icons and menu item icons that automatically adjust to light and dark themes.
Class methods
createEmpty()
Create an empty image.
Return
ImagecreateFromPath(path)
Create an image by reading from path.
Parameters
Stringpath
Return
ImagecreateFromBuffer(buffer, scaleFactor)
Create an image from buffer in memory, with scale_factor.
Parameters
BufferbufferNumberscaleFactor
Return
ImageMethods
clear()
Make the image empty.
On Windows creating an image from filesystem path will also lock the file, by calling this method the image file will be unlocked. The original image file will not be modified, and APIs that accepted this image will not be affected.
isEmpty()
Return whether the image has any data.
Return
BooleansetTemplate(is)
Set whether the image is a template image.
Parameters
Booleanis
isTemplate()
Return whether the image is a template image.
Return
BooleangetSize()
Return image's size in DIP.
Return
SizeFgetScaleFactor()
Return image's scale factor.
Return
Numbertint(color)
Return a new image that has tint color applied.
On Windows the tint color is applied by using color matrix, while other
platforms use "source-atop" blend mode. So the result image
might very likely look different on Windows.
Parameters
Colorcolor
Return
Imageresize(newSize, scaleFactor)
Return a new image resized to new_size with scale_factor.
Parameters
SizeFnewSizeNumberscaleFactor
Return
ImagetoPNG()
Return a buffer containing the image's PNG encoded data.
Return
BuffertoJPEG(quality)
Return a buffer containing the image's JPEG encoded data.
Parameters
Integerquality - Between 1-100.
Return
Buffer