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

reverts subscriber api

Browse source
This commit is contained in:
gellert 2016-09-16 11:18:15 +02:00
parent 2435f1b660
commit 64e53a17bd
5 changed files with 38 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1063,15 +1063,18 @@ For the `mouseWheel` event, the `event` object also have following properties:
* `callback` Function
Begin subscribing for presentation events and captured frames, the `callback`
will be called with `callback(image, dirtyRect)` when there is a
will be called with `callback(frameBuffer, dirtyRect)` when there is a
presentation event.
The `image` is a [NativeImage](native-image.md) that contains the image data of
the frame.
The `frameBuffer` is a `Buffer` that contains raw pixel data. On most machines,
the pixel data is effectively stored in 32bit BGRA format, but the actual
representation depends on the endianness of the processor (most modern
processors are little-endian, on machines with big-endian processors the data
is in 32bit ARGB format).
The `dirtyRect` is an object with `x, y, width, height` properties that
describes which part of the page was repainted. If `onlyDirty` is set to
`true`, `image` will only contain the repainted area. `onlyDirty`
`true`, `frameBuffer` will only contain the repainted area. `onlyDirty`
defaults to `false`.
#### `contents.endFrameSubscription()`