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

docs: webContents.beginFrameSubscription

Browse source
This commit is contained in:
Cheng Zhao 2015-09-18 17:53:19 +08:00
parent 573892c112
commit 1e918480b4
2 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/api/browser-window.md
View file

@ -772,13 +772,3 @@ Sets whether the window should be visible on all workspaces.
Returns whether the window is visible on all workspaces.
**Note:** This API always returns false on Windows.
### BrowserWindow.beginFrameSubscription()
Enables offscreen rendering, after this call `frame-rendered` events will be
fired when the window receives a new frame from the renderer.
### BrowserWindow.endFrameSubscription()
Enables offscreen rendering, after this call `frame-rendered` events will
no longer be fired if offscreen rendering was enabled before.

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

@ -551,3 +551,17 @@ For the `mouseWheel` event, the `event` object also have following properties:
* `accelerationRatioY` Integer
* `hasPreciseScrollingDeltas` Boolean
* `canScroll` Boolean
### `webContents.beginFrameSubscription(callback)`
* `callback` Function
Begin subscribing for presentation events and captured frames, the `callback`
will be called with `callback(frameBuffer)` when there is a presentation event.
The `frameBuffer` is a `Buffer` that contains raw pixel data, in the format of
32bit ARGB.
### `webContents.endFrameSubscription()`
End subscribing for frame presentation events.