npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

glsl-token-functions

v1.0.1

Published

Extract function definitions from an array of GLSL tokens.

Downloads

61,179

Readme

glsl-token-functions

stable

Extract function definitions from an array of GLSL tokens from glsl-tokenizer.

You can use this to grab all of the functions in a shader, along with their arguments, return value and name.

Usage

NPM

functions = tokenFunctions(tokens)

Given an array of tokens produced by glsl-tokenizer, return an array of function data in the following format:

{
  name: 'functionName',
  type: 'vec4'
  body: [100, 110],
  args: [98, 99],
  outer: [80, 111]
}

fn.name

The function name. For example, the following function would be main:

void main();

fn.type

The function return type. For example, the following function would be vec2:

vec2 getModel(vec3 p);

Note that this supports structs too! The following function's type would be Ray:

struct Ray {
  vec3 ro;
  vec3 rd;
}

Ray getCamera(vec3 origin);

fn.body

The start and end index in the original tokens array of the function body, i.e. the part between the curly braces. If the function doesn't have a body, this will be false.

For example:

const tokenFunctions = require('glsl-token-functions')
const toString = require('glsl-token-string')
const tokenize = require('glsl-tokenizer')
const src = `
void main();
void main() { gl_FragColor = vec4(1); }
`

const tokens = tokenize(src)
const functions = tokenFunctions(tokens)

console.log(getBody(functions[0])) // false
console.log(getBody(functions[1])) // " gl_FragColor = vec4(1); "

function getBody () {
  return toString(tokens.slice(fn.body[0], fn.body[1]))
}

fn.args

The start and end index in the original tokens array of the function arguments, i.e. the part including the parenthesis in the function definition.

For example:

const tokenFunctions = require('glsl-token-functions')
const toString = require('glsl-token-string')
const tokenize = require('glsl-tokenizer')
const src = `
void main();
void drawImage(vec3 ro, vec3 rd);
`

const tokens = tokenize(src)
const functions = tokenFunctions(tokens)

console.log(getArgs(functions[0])) // "()"
console.log(getArgs(functions[1])) // "(vec3 ro, vec3 rd)"

function getArgs () {
  return toString(tokens.slice(fn.args[0], fn.args[1]))
}

fn.outer

The start and end index in the original tokens array of the entire function.

For example:

const tokenFunctions = require('glsl-token-functions')
const toString = require('glsl-token-string')
const tokenize = require('glsl-tokenizer')
const src = `
void main();
void main() { gl_FragColor = vec4(1); }
`

const tokens = tokenize(src)
const functions = tokenFunctions(tokens)

console.log(getOuter(functions[0])) // "void main();"
console.log(getOuter(functions[1])) // "void main() { gl_FragColor = vec4(1); }"

function getOuter () {
  return toString(tokens.slice(fn.outer[0], fn.outer[1]))
}

Contributing

See stackgl/contributing for details.

License

MIT. See LICENSE.md for details.