Skip to content

add info on webgl context lost event #1120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 11, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plot_url: https://codepen.io/plotly/embed/YeGGdy/?height=500&theme-id=15263&default-tab=result
language: plotly_js
suite: events
order: 11
order: 10.2
sitemap: false
arrangement: horizontal
markdown_content: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
plot_url: https://codepen.io/plotly/embed/WoZOdq/?height=500&theme-id=15263&default-tab=result
language: plotly_js
suite: events
order: 11
order: 10.3
sitemap: false
arrangement: horizontal
markdown_content: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
sitemap: false
arrangement: horizontal
markdown_content: |
The following Plotly events do not emit additional data or update information: [`plotly_afterplot`](), [`plotly_autosize`](), [`plotly_deselect`](), [`plotly_doubleclick`](), [`plotly_redraw`](), and [`plotly_animated`](). These event handlers can be used to notify or trigger an additional event with the following syntax:
The following Plotly events do not emit additional data or update information: [`plotly_webglcontextlost`](#webgl-context-lost-event), [`plotly_afterplot`](#afterplot-event), [`plotly_autosize`](), [`plotly_deselect`](), [`plotly_doubleclick`](#double-click-event), [`plotly_redraw`](), and [`plotly_animated`](). These event handlers can be used to notify or trigger an additional event with the following syntax:
---

function eventTriggeredHandler() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Webgl Context Lost Event
language: plotly_js
suite: events
order: 10.1
sitemap: false
arrangement: horizontal
markdown_content: |
Plotly graphs which use webgl receive a "webgl context" from the browser which gives them access to gpu resources.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michaelbabyn -- sorry one quick suggestion usually webgl is capitalized as: WebGL
can you update the text w/ that (but the handler can remain as is: plotly_webglcontextlost :) )

A program may lose its web context if the browser is overloaded with webgl contexts and is forced to shut one down.
The event handler: `plotly_webglcontextlost`, can be used to trigger an event after a graph using webgl loses it's webgl context.
---