github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-11 00:18:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
Paul Betts
2016-03-13 20:11:43 -07:00
parent 262abc43f8
commit 5dea4b9b1c
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api/native-image.md
View File

@@ -133,6 +133,13 @@ Returns a [Buffer][buffer] that contains the image's `JPEG` encoded data.
Returns the data URL of the image.
### `image.asNativeRepresentation(type)`
Returns a pointer to an underlying native type (encoded as a [Buffer][buffer]) which can be used with native APIs. Note that in many cases, this pointer is a weak pointer to the underlying native image not a copy, so you _must_ ensure that the associated `nativeImage` instance is kept around.
* `type` String (**required**) - one of:
* `nsimage` - (OS X only) a pointer to an `NSImage`
### `image.isEmpty()`
Returns a boolean whether the image is empty.