docs: webContents.beginFrameSubscription
authorCheng Zhao <zcbenz@gmail.com>
Fri, 18 Sep 2015 09:53:19 +0000 (17:53 +0800)
committerCheng Zhao <zcbenz@gmail.com>
Fri, 18 Sep 2015 09:53:19 +0000 (17:53 +0800)
docs/api/browser-window.md
docs/api/web-contents.md

index 2868209..f1705c2 100644 (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.
index 1a90437..e8f72cd 100644 (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.