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

three-glslify

v2.0.2

Published

a helper to make ThreeJS shader materials from glslify

Downloads

9

Readme

three-glslify

experimental

DEPRECATED !

This bridge is no longer necessary in [email protected] and above. See three-glslify-example for a full example of using ThreeJS + glslify.


A helper to turn glslify shader into a ThreeJS shader object.

Typical example:

var THREE = require('three')

//inline our shader code
var glslify = require('glslify')
var source = glslify({
    vertex: './foo.vert',
    fragment: './foo.frag',
    sourceOnly: true
})

//create a shader that ThreeJS will recognize
var createShader = require('three-glslify')(THREE)
var myShader = createShader(source)

//we can now use it in ShaderMaterial or EffectComposer
var pass = new THREE.ShaderPass( myShader )
effectComposer.addPass(pass)

The returned myShader object looks like this, with new instances of Texture, Vector2, etc. based on the uniform type. Attributes start with empty arrays.

{
	vertexShader: '... source ...',
	fragmentShader: '... source ...',
	uniforms: {
		u_tex0: { type: 't', value: new THREE.Texture() },
		... etc
	},
	attributes: {
		displacement: { type: 'f', value: [] }
	}
}

Usage

NPM

createShader(source, options)

Creates a shader with the given source (from glslify, using sourceOnly) and options.

Options:

  • colors an array of uniform names that should be mapped to THREE.Color typed, 'c'. Otherwise these will just be plain THREE.Vector3 types, v3

Gotchas

Since ThreeJS release cycles are unpredictable and don't use semantic versioning, this module may break with newer versions of ThreeJS. It currently works with three 0.68.0 (r68). Send issues or PRs if you find versioning problems.

ThreeJS distinguishes between an array of THREE.Vector3 objects, and a flattened vec3 type represented by floats (v3v vs fv). This module only sees the vec3 array type, and assumes they are to be represented by an array of THREE.Vector3 elements. Same with ivec3, vec4, etc.

License

MIT, see LICENSE.md for details.