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

image-shader

v0.2.6

Published

Run WebGL shaders on an image or canvas.

Downloads

3

Readme

Shader Image

experimental

Tool to simplify writing shaders for HTML Image and Canvas elements.

Written in Typescript and ships with all types.

This class class creates a webgl context and texture from a given HTMLImageElement or HTMLCanvasElement as well as a fragment shader.

The shader is wrapped with the necessery definitions and functions to render the image.

import { ImageShader } from "image-shader";

const source = new Image();
source.src = "some/url.png";

// Shader to only render the red channel of the image.
const shader = `
    void main() {
        vec4 pixel = getPixel();

        gl_FragColor = vec4( pixel.r, 0, 0, 1 );
    }
`;

const image = new ImageShader( source, shader );

document.body.appendChild( image.domElement );

Api

Constructor

new ImageShader( source, shader ) where source is either a HTMLImageElement or a HTMLCanvasElement and the shader is a string in form of webgl shader. This means it has to include a void main() method in which or subsequently from which the gl_FragColor is set.

For a list of available variables and methods within the shader see below.

Fields

  • domElement: Returns a HTMLCanvasElement in the size of the source image containing the shaded image.
  • width: Returns the width of the content.
  • height: Returns the height of the content.
  • uniforms: Returns a readonly object which contains all uniforms. Setting additional uniforms is enabled by adding more values on this object:
const image = new ImageShader( source, fragment );

image.uniforms.time = 2340;
image.uniforms.anchor = [ 23, 45 ];

image.render();

Methods

  • dispose(): Releases all memory. Since it uses WebGL internally, simply losing the reference will not clear all memory.
  • render(): Re-renders the image. Should only be used after uniforms have been changed. Calling the method otherwise is safe, but potentially wasteful.

Shader Helpers

The passed in shader, used as a fragment shader for the image, ships with some uniforms and helper methods:

Uniforms and Varying

  • sampler2D image: The image/canvas in question as texture.
  • vec2 resolution: The size of the image.
  • vec2 uv: The UV coordinates of the current fragment.

Methods

  • vec4 getPixel(): Returns the pixel for the current fragment. For instance: gl_FragColor = getPixel() simply renders the image unaltered.
  • vec4 getPixel( vec2 uv ): Returns the image pixel at the given UV coordineats.
  • vec4 getPixelXY( vec2 coords ): Returns the image pixel at the given coordinates in pixels.