electron/docs/api/image.md
2014-06-23 22:58:42 +08:00

25 lines
838 B
Markdown

# 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:
```javascript
var appIcon = new Tray('/Users/somebody/images/icon@2x.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.