Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@luma.gl/webgl-state-tracker

Package Overview
Dependencies
Maintainers
7
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@luma.gl/webgl-state-tracker

WebGL state manager that saves and restores WebGLRenderingContext state

  • 7.1.0-alpha.5
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.6K
increased by10.61%
Maintainers
7
Weekly downloads
 
Created
Source

@luma.gl/webgl-state-tracker

Provides WebGL context state tracking and a unified API for setting WebGL parameters

State tracking

This module installs overrides on a WebGLRenderingContext that track state changes and allow context state to be saved and restored through push and pop operations.

This is useful when combining code written in different WebGL frameworks or code bases, as each code base can make changes to the global WebGLRenderingContext state and leave it in a state that causes problems for the other code base.

Usage

yarn add @luma.gl/webgl-state-tracker
import trackContextState from '@luma.gl/webgl-state-tracker';

const gl = canvas.getContext('webgl');
trackContextState(gl);

Functions

trackContextState(gl : WebGLRenderingContext, options: Object)

Initialize WebGL state caching on a context. After calling this function, context state will be cached. State caching speeds up parameter access and enables pushContextState and popContextState to efficiently save and restore global WebGL context state.

trackContextState(gl, {enable = true, copyState} = {})

  • gl (WebGLRenderingContext) - gl context
  • enable (Boolean) - whether cache is being used
  • copyState whether the state cache is initialized to WebGL defaults (fast) or read from the context (slow)

Remarks:

  • trackContextState can be called multiple times to enable/disable state cache.
  • copyState-false is fast, and yields correct results for newly created, unmodified contexts. If you are tracking a context created by an external framework, it is likely safest to use copyState=true to ensure the cache corresponds to the context state.

pushContextState(gl : WebGLRenderingContext)

Saves the current state of the context by "pushing" it onto an internal stack, enabling it to be restored later.

pushContextState(gl)

  • gl (WebGLRenderingContext) - gl context Returns: nothing

Remarks:

  • Can be called multiple times, enabling "nested" usage.
  • Each invocation of pushContextState is expected to be matched by a call to popContextState at a later time.

popContextState(gl : WebGLRenderingContext)

Restores the state of the context at the time of the latest call to pushContextState.

popContextState(gl)

  • gl (WebGLRenderingContext) - gl context Returns: nothing

Remarks;

  • Any changes made to the context state after the last call to pushContextState are undone and "discarded".
  • It is an error to call popContextState without first doing a matching call to pushContextState.

Remarks

  • This a helper module for luma.gl, but is designed to be independently usable in other projects.

Keywords

FAQs

Package last updated on 30 May 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc