mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add documentation for changes

Browse source
This commit is contained in:
Heilig Benedek 2016-08-01 02:14:45 +02:00
parent 7a471e1ab7
commit 2b05be64b4
2 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api/native-image.md
View file

@ -152,6 +152,10 @@ Returns a [Buffer][buffer] that contains the image's `PNG` encoded data.
Returns a [Buffer][buffer] that contains the image's `JPEG` encoded data.
#### `image.toBitmap()`
Returns a [Buffer][buffer] that contains the image's raw pixel data.
#### `image.toDataURL()`
Returns the data URL of the image.

12
docs/api/web-contents.md
View file

@ -334,7 +334,13 @@ Returns:
* `event` Event
* `type` String
* `image` NativeImage (optional)
* `scale` Float (optional)
* `scale` Float (optional) - scaling factor for the custom cursor
* `size` Object (optional) - the size of the `image`
* `width` Integer
* `height` Integer
* `hotspot` Object (optional) - coordinates of the custom cursor's hotspot
* `x` Integer - x coordinate
* `y` Integer - y coordinate
Emitted when the cursor's type changes. The `type` parameter can be `default`,
`crosshair`, `pointer`, `text`, `wait`, `help`, `e-resize`, `n-resize`,
@ -346,8 +352,8 @@ Emitted when the cursor's type changes. The `type` parameter can be `default`,
`not-allowed`, `zoom-in`, `zoom-out`, `grab`, `grabbing`, `custom`.
If the `type` parameter is `custom`, the `image` parameter will hold the custom
cursor image in a `NativeImage`, and the `scale` will hold scaling information
for the image.
cursor image in a `NativeImage`, and `scale`, `size` and `hotspot` will hold
additional information about the custom cursor.
#### Event: 'context-menu'