# glsl-film-grain

> natural looking film grain using noise functions

Latest version **1.0.4** (published 2016-03-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install glsl-film-grain
pnpm add glsl-film-grain
yarn add glsl-film-grain
bun add glsl-film-grain
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2016-03-11 |
| First published | 2015-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 209 |
| Author | Matt DesLauriers |
| Maintainers | mattdesl |
| Keywords | noise, film, grain, lens, imperfections, ecosystem:stackgl, stackgl, webgl, glsl, glslify |

## Links

- npm: https://www.npmjs.com/package/glsl-film-grain
- Repository: https://github.com/mattdesl/glsl-film-grain
- Issues: https://github.com/mattdesl/glsl-film-grain/issues
- npm.io page: https://npm.io/package/glsl-film-grain

## Dependencies (1)

- [glsl-noise](https://npm.io/package/glsl-noise.md) 0.0.0

## Recent versions

- 1.0.4 (latest) — 2016-03-11
- 1.0.3 — 2016-03-11
- 1.0.2 — 2015-01-26
- 1.0.1 — 2015-01-26
- 1.0.0 — 2015-01-26

## README

# glsl-film-grain

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

![img](http://i.imgur.com/uXUivnH.png)

[(click for demo)](http://mattdesl.github.io/glsl-film-grain)

Natural looking film grain using 3D noise functions. Inspired by [Martins Upitis](http://devlog-martinsh.blogspot.ca/2013/05/image-imperfections-and-film-grain-post.html). 

This is a fairly expensive technique to achieve film grain, but it looks more realistic than a [hash function](https://www.npmjs.com/package/glsl-random) and also produces better motion.

Simplest example:

```glsl
#pragma glslify: grain = require(glsl-film-grain)

void main() {
    float grainSize = 2.0;
    float g = grain(texCoord, resolution / grainSize);
    vec3 color = vec3(g);
    gl_FragColor = vec4(color, 1.0);
}
```

Results in:

![grain](http://i.imgur.com/OEBZs8B.png)


See [blending tips](#blending-tips) and the [demo source](demo.js) for details.

## Usage

[![NPM](https://nodei.co/npm/glsl-film-grain.png)](https://www.npmjs.com/package/glsl-film-grain)

#### `f = grain(texCoord, resolution[, frame[, q]])`

Returns a float for the monochromatic grain with the given options:

- `texCoord` the UV coordinates of your scene
- `resolution` the resolution of your scene in pixels, optionally scaled to adjust the grain size
- `frame` the animation frame, which is an offset into the Z of the 3D noise
- `q` is a coefficient for the offset calculation, and may evoke subtly different motion. Defaults to 2.5

## blending tips

There are a lot of ways to blend the noise onto the 3D scene or image. The solution used in the demo uses [glsl-blend-soft-light](https://www.npmjs.com/package/glsl-blend-soft-light) and [glsl-luma](https://www.npmjs.com/package/glsl-luma).

```glsl
    vec3 g = vec3(grain(texCoord, p));
  
    //blend the noise over the background, 
    //i.e. overlay, soft light, additive
    vec3 color = blend(backgroundColor, g);
    
    //get the luminance of the background
    float luminance = luma(backgroundColor);
    
    //reduce the noise based on some 
    //threshold of the background luminance
    float response = smoothstep(0.05, 0.5, luminance);
    color = mix(color, backgroundColor, pow(response, 2.0));
    
    //final color
    gl_FragColor = vec4(color, 1.0);
```

## License

MIT, see [LICENSE.md](http://github.com/mattdesl/glsl-film-grain/blob/master/LICENSE.md) for details.

---
_Source: https://npm.io/package/glsl-film-grain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._