electron/docs/api/image.md

1.3 KiB

Image

In atom-shell images are represented by their file paths, we currently do not support in-memory images or remote images.

For example when creating tray or setting window's icon, you can pass image's file path as String to represent an image:

var appIcon = new Tray('/Users/somebody/images/icon.png');
var window = new BrowserWindow({icon: '/Users/somebody/images/window.png'});

Supported formats

Only PNG and JPG formats are supported, and PNG format is preferred.

High resolution image

On platforms that have high-DPI support, you can append @2x after image's file name's base name to mark it as a high resolution image.

For example if icon.png is a normal image that has standard resolution, the icon@2x.png would be treated as a high resolution image that has double DPI dense.

If you want to support displays with different DPI denses at the same time, you can put images with different sizes in the same folder, and use the filename without DPI suffixes, like this:

images/
├── icon.png
├── icon@2x.png
└── icon@3x.png
var appIcon = new Tray('/Users/somebody/images/icon.png');

Following suffixes as DPI denses are also supported:

  • @1x
  • @1.25x
  • @1.33x
  • @1.4x
  • @1.5x
  • @1.8x
  • @2x
  • @2.5x
  • @3x