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-instanced-uniforms-mesh

v0.50.3

Published

Extension to Three.js InstancedMesh supporting per-instance uniform values

Downloads

12,913

Readme

InstancedUniformsMesh

This package provides a InstancedUniformsMesh class which extends Three.js's InstancedMesh to allow its material's shader uniforms to be set individually per instance. It behaves just like InstancedMesh but exposes a new method:

mesh.setUniformAt(uniformName, instanceIndex, value)

When you call setUniformAt, the geometry and the material's shaders will be automatically upgraded behind the scenes to turn that uniform into an instanced buffer attribute, filling in the other indices with the uniform's default value. You can do this for any uniform of type float, vec2, vec3, or vec4. It works both for built-in Three.js materials and also for any custom ShaderMaterial.

For example, here is how you could set random emissive and metalness values for each instance using a MeshStandardMaterial:

import { InstancedUniformsMesh } from 'three-instanced-uniforms-mesh'

const count = 100
const mesh = new InstancedUniformsMesh(
  someGeometry,
  new MeshStandardMaterial(),
  count
)
const color = new Color()
for (let i = 0; i < count; i++) {
  mesh.setMatrixAt(i, someMatrixValue)
  mesh.setUniformAt('metalness', i, Math.random())
  mesh.setUniformAt('emissive', i, color.set(Math.random() * 0xffffff))
}

While this is obviously useful for Three.js's built in materials, it really shines with custom shaders. Just declare any configurable parameters as uniforms in your custom shader, and then you can use that either on a single non-instanced Mesh by setting the material's uniforms directly, or instance it using InstancedUniformsMesh by calling setUniformAt. Your shader doesn't need to change at all to support the instancing!

Note: Calling setUniformAt automatically marks the underlying buffer attributes for upload, so unlike setMatrixAt or setColorAt you don't need to set needsUpdate manually.

Value Types

The type of the value argument should match the type of the uniform defined in the material's shader:

| For a uniform of type: | Pass a value of this type: | |---------------------------|----------------------------------| | float | Number | | vec2 | THREE.Vector2 | | vec3 | THREE.Vector3 or THREE.Color | | vec4 | THREE.Vector4 | | mat3 (ThreeJS r132+ only) | THREE.Matrix3 | | mat4 (ThreeJS r132+ only) | THREE.Matrix4 |

Resetting to defaults

If you have set instance-specific values for a given uniform but you want to revert all those to the single original uniform value, you can call:

mesh.unsetUniform(uniformName)

Examples