Skip to content
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

docs: consolidation #1787

Merged
merged 1 commit into from
Aug 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
10 changes: 0 additions & 10 deletions docs/api-reference/engine/animation-loop.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,6 @@

Manages an animation loop and optionally a WebGL context and a WebGL canvas. It provides a number of features related to initialization and animation of a WebGL context.

- Provides a number of commonly needed variables as part of the `context` object which is passed to `onRender` and `onFinalize` callbacks.
- Objects returned by `onInitialize` will be appended to `context` object hence available to `onRender` and `onFinalize`.
- To avoid problems with page load timing, move context creation to the `onCreateContext` method.
- By default, `onRender` method manages resizing of canvas, viewport and framebuffer.
- Makes it easy to wait for the HTML page to load before creating a canvas and WebGL resources.

References:

- [WebGL Fundamentals](https://webglfundamentals.org/webgl/lessons/webgl-anti-patterns.html#drawingbuffer) contains excellent information on the subtleties of the how the WebGL context's drawing buffer and the HTML canvas interact.
- When running in the browser, this class uses [`requestAnimationFrame`](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame)

## Usage

Expand Down
181 changes: 0 additions & 181 deletions docs/api-reference/engine/animation-loop2.md

This file was deleted.

Loading
Loading