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

gl-wiretap

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gl-wiretap

A gl debugger that listens and replays gl (WebGL, WebGL2, and HeadlessGL) gpu commands

  • 0.6.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4K
decreased by-5.12%
Maintainers
1
Weekly downloads
 
Created
Source

gl-wiretap

A gl debugger that listens and replays gl (WebGL, WebGL2, and HeadlessGL) gpu commands

Example

const gl = glWiretap(realGL);

// do a bunch of webgl commands..

// then later, get all commands as a string of runnable javascript
const commands = gl.toString();

// possibly write commands to file, for unit testing or reproducing bug
require('fs').writeFileSync('./file.js',
    // create a `gl` variable for the script to use
    "const canvas = document.createElement('canvas');"
    + "const gl = canvas.getContext('webgl');"
    + commands
);

WebGL Usage

const canvas = document.createElement('canvas');
const realGL = canvas.getContext('webgl');
const gl = glWiretap(realGL);

WebGL2 Usage

const canvas = document.createElement('canvas');
const realGL = canvas.getContext('webgl2');
const gl = glWiretap(realGL);

HeadlessGL Usage

const { glWiretap } = require('gl-wiretap');
const realGL = require('gl')(1, 1);
const gl = glWiretap(realGL);

See the HeadlessGL project for more information on using it.

API

const gl = glWiretap(realGL, options);

// do a bunch of webgl commands..

// then later, see all commands ran
const commands = gl.toString();

glWiretap() methods

glWiretap().addComment()

Add a comment for later when calling glWiretap().toString(), to help human doing debugging

glWiretap().toString()

This is where the gl context outputs all values as runnable javascript. The value for context here is gl by default, for simplicity. But can be changed to the value of with options.contextName. Any variables created here (example: gl.createProgram(), or gl.createShader(gl.VERTEX_SHADER)) are simply constants that increment on an index to prevent collision.

glWiretap().checkThrowError()

Causes a thrown exception when error detected from gl context, to help human doing debugging

glWiretap().getReadPixelsVariableName()

Gets the last internal variable name used as a target value for gl.readPixels()

glWiretap().insertVariable(name, value)

Insert a value into the glWiretap() playback string.

glWiretap().reset()

Reset the playback string.

glWiretap().setIndent(spaces)

Set the playback indentation. Useful for formatting results.

glWiretap().getContextVariableName(value)

Get a variable name from the context. Useful for adding additional functionality to, for example, textures, etc.

glWiretap options

  • contextName: String - A string that refers to the gl context for glWiretap().toString()
  • recording: String[] - A array of strings that
  • readPixelsFile: String - When set, writes a file by this name to the current directory when on node HeadlessGL using readPixels
  • throwGetError: Boolean - Causes gl.getError() to throw if there is an error
  • throwGetShaderParameter: Boolean - Causes gl.getShaderParameter() to throw if there is an error
  • throwGetProgramParameter: Boolean - Causes gl.getProgramParameter() to throw if there is an error
  • onReadPixels: Function(targetName, argumentAsStrings);
  • onUnrecognizedArgumentLookup: Function(argument) => string - Allows for just in time value tracking and insertion.

Typescript support

By default, typescript is supported

Keywords

FAQs

Package last updated on 28 Sep 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