Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@vanruesc
vanruesc committed Aug 31, 2018
1 parent b53ea67 commit 63db9d7
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 25 deletions.
5 changes: 2 additions & 3 deletions public/docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,8 @@ <h2 id="included-filters">Included Filters</h2><ul>
</ul>
<h2 id="contributing">Contributing</h2><p>Please refer to the <a href="https://github.com/vanruesc/postprocessing/blob/master/.github/CONTRIBUTING.md">contribution guidelines</a> for details.</p>
<h2 id="license">License</h2><p>This library is licensed under the <a href="https://github.com/vanruesc/postprocessing/blob/master/LICENSE.md">Zlib license</a>.</p>
<p>The original code that this library is based on, was written by <a href="http://alteredqualia.com">alteredq</a>,
<a href="https://github.com/MiiBond">miibond</a>, <a href="https://github.com/zz85">zz85</a>, <a href="http://airtight.cc">felixturner</a>,
<a href="http://eduperiment.com">spidersharma</a> and <a href="http://huwbowles.com">huwb</a>
<p>The original code that this library is based on, was written by <a href="http://mrdoob.com">mrdoob</a> and the
<a href="https://github.com/mrdoob/three.js/graphs/contributors">three.js contributors</a>
and is licensed under the <a href="https://github.com/mrdoob/three.js/blob/master/LICENSE">MIT license</a>.</p>
<p>The film effect incorporates code written by Georg Steinrohder and Pat Shearon which was released under the
<a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 License</a>.</p>
Expand Down
4 changes: 2 additions & 2 deletions public/docs/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13643,15 +13643,15 @@
},
{
"kind": "index",
"content": "# Post Processing\r\n\r\n[![Build status](https://travis-ci.org/vanruesc/postprocessing.svg?branch=master)](https://travis-ci.org/vanruesc/postprocessing)\r\n[![npm version](https://badge.fury.io/js/postprocessing.svg)](http://badge.fury.io/js/postprocessing)\r\n[![Peer dependencies](https://david-dm.org/vanruesc/postprocessing/peer-status.svg)](https://david-dm.org/vanruesc/postprocessing?type=peer)\r\n\r\nA post processing library that provides the means to implement image filter effects for [three.js](https://threejs.org/).\r\n\r\n*[Extensive Demo](https://vanruesc.github.io/postprocessing/public/demo) &there4;\r\n[API Reference](https://vanruesc.github.io/postprocessing/public/docs) &there4;\r\n[Wiki](https://github.com/vanruesc/postprocessing/wiki)*\r\n\r\n\r\n## Installation\r\n\r\nThis library requires the peer dependency [three](https://github.com/mrdoob/three.js/).\r\n\r\n```sh\r\nnpm install three postprocessing\r\n```\r\n\r\n\r\n## Usage\r\n\r\nPlease refer to the [usage example](https://github.com/mrdoob/three.js/blob/master/README.md) of three.js for information\r\nabout how to setup the renderer, scene and camera.\r\n\r\n#### Basics\r\n\r\n```javascript\r\nimport { Clock, PerspectiveCamera, Scene, WebGLRenderer } from \"three\";\r\nimport { EffectComposer, GlitchPass, RenderPass } from \"postprocessing\";\r\n\r\nconst composer = new EffectComposer(new WebGLRenderer());\r\ncomposer.addPass(new RenderPass(new Scene(), new PerspectiveCamera()));\r\n\r\nconst pass = new GlitchPass();\r\npass.renderToScreen = true;\r\ncomposer.addPass(pass);\r\n\r\nconst clock = new Clock();\r\n\r\n(function render() {\r\n\r\n\trequestAnimationFrame(render);\r\n\tcomposer.render(clock.getDelta());\r\n\r\n}());\r\n```\r\n\r\n#### Custom Passes\r\n\r\n```javascript\r\nimport { Pass } from \"postprocessing\";\r\nimport { MyMaterial } from \"./MyMaterial.js\";\r\n\r\nexport class MyPass extends Pass {\r\n\r\n\tconstructor() {\r\n\r\n\t\tsuper(\"MyPass\");\r\n\r\n\t\tthis.setFullscreenMaterial(new MyMaterial());\r\n\r\n\t}\r\n\r\n\trender(renderer, inputBuffer, outputBuffer, delta, stencilTest) {\r\n\r\n\t\tthis.getFullscreenMaterial().uniforms.tDiffuse.value = inputBuffer.texture;\r\n\t\trenderer.render(this.scene, this.camera, this.renderToScreen ? null : outputBuffer);\r\n\r\n\t}\r\n\r\n}\r\n\r\n```\r\n\r\nSee the [Wiki](https://github.com/vanruesc/postprocessing/wiki/Custom-Passes) for more information.\r\n\r\n\r\n## Included Filters\r\n\r\n - [Bloom](http://vanruesc.github.io/postprocessing/public/demo/#bloom)\r\n - [Blur](http://vanruesc.github.io/postprocessing/public/demo/#blur)\r\n - [Bokeh](http://vanruesc.github.io/postprocessing/public/demo/#bokeh)\r\n - [Realistic Bokeh](http://vanruesc.github.io/postprocessing/public/demo/#realistic-bokeh)\r\n - [Depth](http://vanruesc.github.io/postprocessing/public/demo/#depth)\r\n - [Dot Screen](http://vanruesc.github.io/postprocessing/public/demo/#dot-screen)\r\n - [Film](http://vanruesc.github.io/postprocessing/public/demo/#film)\r\n - [Glitch](http://vanruesc.github.io/postprocessing/public/demo/#glitch)\r\n - [God Rays](http://vanruesc.github.io/postprocessing/public/demo/#god-rays)\r\n - [Outline](http://vanruesc.github.io/postprocessing/public/demo/#outline)\r\n - [Pixelation](http://vanruesc.github.io/postprocessing/public/demo/#pixelation)\r\n - [Render](http://vanruesc.github.io/postprocessing/public/demo/#render)\r\n - [Shock Wave](http://vanruesc.github.io/postprocessing/public/demo/#shock-wave)\r\n - [SMAA](http://vanruesc.github.io/postprocessing/public/demo/#smaa)\r\n - [Tone Mapping](http://vanruesc.github.io/postprocessing/public/demo/#tone-mapping)\r\n\r\n\r\n## Contributing\r\n\r\nPlease refer to the [contribution guidelines](https://github.com/vanruesc/postprocessing/blob/master/.github/CONTRIBUTING.md) for details.\r\n\r\n\r\n## License\r\n\r\nThis library is licensed under the [Zlib license](https://github.com/vanruesc/postprocessing/blob/master/LICENSE.md).\r\n\r\nThe original code that this library is based on, was written by [alteredq](http://alteredqualia.com),\r\n[miibond](https://github.com/MiiBond), [zz85](https://github.com/zz85), [felixturner](http://airtight.cc),\r\n[spidersharma](http://eduperiment.com) and [huwb](http://huwbowles.com)\r\nand is licensed under the [MIT license](https://github.com/mrdoob/three.js/blob/master/LICENSE).\r\n\r\nThe film effect incorporates code written by Georg Steinrohder and Pat Shearon which was released under the\r\n[Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/).\r\n",
"content": "# Post Processing\r\n\r\n[![Build status](https://travis-ci.org/vanruesc/postprocessing.svg?branch=master)](https://travis-ci.org/vanruesc/postprocessing)\r\n[![npm version](https://badge.fury.io/js/postprocessing.svg)](http://badge.fury.io/js/postprocessing)\r\n[![Peer dependencies](https://david-dm.org/vanruesc/postprocessing/peer-status.svg)](https://david-dm.org/vanruesc/postprocessing?type=peer)\r\n\r\nA post processing library that provides the means to implement image filter effects for [three.js](https://threejs.org/).\r\n\r\n*[Extensive Demo](https://vanruesc.github.io/postprocessing/public/demo) &there4;\r\n[API Reference](https://vanruesc.github.io/postprocessing/public/docs) &there4;\r\n[Wiki](https://github.com/vanruesc/postprocessing/wiki)*\r\n\r\n\r\n## Installation\r\n\r\nThis library requires the peer dependency [three](https://github.com/mrdoob/three.js/).\r\n\r\n```sh\r\nnpm install three postprocessing\r\n```\r\n\r\n\r\n## Usage\r\n\r\nPlease refer to the [usage example](https://github.com/mrdoob/three.js/blob/master/README.md) of three.js for information\r\nabout how to setup the renderer, scene and camera.\r\n\r\n#### Basics\r\n\r\n```javascript\r\nimport { Clock, PerspectiveCamera, Scene, WebGLRenderer } from \"three\";\r\nimport { EffectComposer, GlitchPass, RenderPass } from \"postprocessing\";\r\n\r\nconst composer = new EffectComposer(new WebGLRenderer());\r\ncomposer.addPass(new RenderPass(new Scene(), new PerspectiveCamera()));\r\n\r\nconst pass = new GlitchPass();\r\npass.renderToScreen = true;\r\ncomposer.addPass(pass);\r\n\r\nconst clock = new Clock();\r\n\r\n(function render() {\r\n\r\n\trequestAnimationFrame(render);\r\n\tcomposer.render(clock.getDelta());\r\n\r\n}());\r\n```\r\n\r\n#### Custom Passes\r\n\r\n```javascript\r\nimport { Pass } from \"postprocessing\";\r\nimport { MyMaterial } from \"./MyMaterial.js\";\r\n\r\nexport class MyPass extends Pass {\r\n\r\n\tconstructor() {\r\n\r\n\t\tsuper(\"MyPass\");\r\n\r\n\t\tthis.setFullscreenMaterial(new MyMaterial());\r\n\r\n\t}\r\n\r\n\trender(renderer, inputBuffer, outputBuffer, delta, stencilTest) {\r\n\r\n\t\tthis.getFullscreenMaterial().uniforms.tDiffuse.value = inputBuffer.texture;\r\n\t\trenderer.render(this.scene, this.camera, this.renderToScreen ? null : outputBuffer);\r\n\r\n\t}\r\n\r\n}\r\n\r\n```\r\n\r\nSee the [Wiki](https://github.com/vanruesc/postprocessing/wiki/Custom-Passes) for more information.\r\n\r\n\r\n## Included Filters\r\n\r\n - [Bloom](http://vanruesc.github.io/postprocessing/public/demo/#bloom)\r\n - [Blur](http://vanruesc.github.io/postprocessing/public/demo/#blur)\r\n - [Bokeh](http://vanruesc.github.io/postprocessing/public/demo/#bokeh)\r\n - [Realistic Bokeh](http://vanruesc.github.io/postprocessing/public/demo/#realistic-bokeh)\r\n - [Depth](http://vanruesc.github.io/postprocessing/public/demo/#depth)\r\n - [Dot Screen](http://vanruesc.github.io/postprocessing/public/demo/#dot-screen)\r\n - [Film](http://vanruesc.github.io/postprocessing/public/demo/#film)\r\n - [Glitch](http://vanruesc.github.io/postprocessing/public/demo/#glitch)\r\n - [God Rays](http://vanruesc.github.io/postprocessing/public/demo/#god-rays)\r\n - [Outline](http://vanruesc.github.io/postprocessing/public/demo/#outline)\r\n - [Pixelation](http://vanruesc.github.io/postprocessing/public/demo/#pixelation)\r\n - [Render](http://vanruesc.github.io/postprocessing/public/demo/#render)\r\n - [Shock Wave](http://vanruesc.github.io/postprocessing/public/demo/#shock-wave)\r\n - [SMAA](http://vanruesc.github.io/postprocessing/public/demo/#smaa)\r\n - [Tone Mapping](http://vanruesc.github.io/postprocessing/public/demo/#tone-mapping)\r\n\r\n\r\n## Contributing\r\n\r\nPlease refer to the [contribution guidelines](https://github.com/vanruesc/postprocessing/blob/master/.github/CONTRIBUTING.md) for details.\r\n\r\n\r\n## License\r\n\r\nThis library is licensed under the [Zlib license](https://github.com/vanruesc/postprocessing/blob/master/LICENSE.md).\r\n\r\nThe original code that this library is based on, was written by [mrdoob](http://mrdoob.com) and the\r\n[three.js contributors](https://github.com/mrdoob/three.js/graphs/contributors)\r\nand is licensed under the [MIT license](https://github.com/mrdoob/three.js/blob/master/LICENSE).\r\n\r\nThe film effect incorporates code written by Georg Steinrohder and Pat Shearon which was released under the\r\n[Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/).\r\n",
"longname": "D:\\Sourcecode\\JavaScript\\postprocessing\\README.md",
"name": "./README.md",
"static": true,
"access": "public"
},
{
"kind": "packageJSON",
"content": "{\r\n\t\"name\": \"postprocessing\",\r\n\t\"version\": \"4.9.0\",\r\n\t\"description\": \"A post processing library that provides the means to implement image filter effects for three.js.\",\r\n\t\"homepage\": \"https://github.com/vanruesc/postprocessing\",\r\n\t\"main\": \"build/postprocessing.js\",\r\n\t\"module\": \"src/index.js\",\r\n\t\"sideEffects\": false,\r\n\t\"license\": \"Zlib\",\r\n\r\n\t\"keywords\": [\r\n\t\t\"2d\",\r\n\t\t\"3d\",\r\n\t\t\"rendering\",\r\n\t\t\"filter\",\r\n\t\t\"effect\",\r\n\t\t\"composer\",\r\n\t\t\"gpgpu\",\r\n\t\t\"rendertexture\",\r\n\t\t\"rendertarget\"\r\n\t],\r\n\r\n\t\"author\": {\r\n\t\t\"name\": \"Raoul van Rüschen\",\r\n\t\t\"email\": \"[email protected]\"\r\n\t},\r\n\r\n\t\"repository\": {\r\n\t\t\"type\": \"git\",\r\n\t\t\"url\": \"https://github.com/vanruesc/postprocessing.git\"\r\n\t},\r\n\r\n\t\"bugs\": {\r\n\t\t\"url\": \"https://github.com/vanruesc/postprocessing/issues\"\r\n\t},\r\n\r\n\t\"files\": [\r\n\t\t\"src\",\r\n\t\t\"build\"\r\n\t],\r\n\r\n\t\"scripts\": {\r\n\t\t\"ava\": \"ava\",\r\n\t\t\"lint\": \"npm run lint:lib && npm run lint:demo && npm run lint:test\",\r\n\t\t\"lint:config\": \"eslint *.js\",\r\n\t\t\"lint:lib\": \"eslint src\",\r\n\t\t\"lint:demo\": \"eslint demo/src\",\r\n\t\t\"lint:test\": \"eslint test\",\r\n\t\t\"build\": \"rollup -c\",\r\n\t\t\"build:production\": \"cross-env NODE_ENV=production npm run build\",\r\n\t\t\"doc\": \"esdoc\",\r\n\t\t\"deploy\": \"cpx demo/assets/** public/demo\",\r\n\t\t\"pretest\": \"npm run lint && npm run build:production\",\r\n\t\t\"test\": \"npm run ava\",\r\n\t\t\"prepack\": \"npm test && inline-import\",\r\n\t\t\"postpublish\": \"inline-import -r\"\r\n\t},\r\n\r\n\t\"ava\": {\r\n\t\t\"failFast\": true,\r\n\t\t\"files\": [\"test/**/*.js\"]\r\n\t},\r\n\r\n\t\"eslintConfig\": {\r\n\t\t\"extends\": \"delta\"\r\n\t},\r\n\r\n\t\"peerDependencies\": {\r\n\t\t\"three\": \">= 0.89.0 <= 0.95.0\"\r\n\t},\r\n\r\n\t\"devDependencies\": {\r\n\t\t\"ava\": \"0.x.x\",\r\n\t\t\"babel-core\": \"6.x.x\",\r\n\t\t\"babel-plugin-external-helpers\": \"6.x.x\",\r\n\t\t\"babel-preset-env\": \"1.x.x\",\r\n\t\t\"cpx\": \"1.x.x\",\r\n\t\t\"cross-env\": \"5.x.x\",\r\n\t\t\"dat.gui\": \"0.x.x\",\r\n\t\t\"delta-controls\": \"2.x.x\",\r\n\t\t\"esdoc\": \"1.x.x\",\r\n\t\t\"esdoc-standard-plugin\": \"1.x.x\",\r\n\t\t\"eslint\": \"5.x.x\",\r\n\t\t\"eslint-config-delta\": \"0.x.x\",\r\n\t\t\"inline-import\": \"1.x.x\",\r\n\t\t\"math-ds\": \"1.x.x\",\r\n\t\t\"rollup\": \"0.x.x\",\r\n\t\t\"rollup-plugin-babel\": \"3.x.x\",\r\n\t\t\"rollup-plugin-babel-minify\": \"5.x.x\",\r\n\t\t\"rollup-plugin-node-resolve\": \"3.x.x\",\r\n\t\t\"rollup-plugin-string\": \"2.x.x\",\r\n\t\t\"synthetic-event\": \"0.x.x\",\r\n\t\t\"three\": \"0.95.x\",\r\n\t\t\"three-demo\": \"3.x.x\"\r\n\t}\r\n}\r\n",
"content": "{\r\n\t\"name\": \"postprocessing\",\r\n\t\"version\": \"4.10.0\",\r\n\t\"description\": \"A post processing library that provides the means to implement image filter effects for three.js.\",\r\n\t\"homepage\": \"https://github.com/vanruesc/postprocessing\",\r\n\t\"main\": \"build/postprocessing.js\",\r\n\t\"module\": \"src/index.js\",\r\n\t\"sideEffects\": false,\r\n\t\"license\": \"Zlib\",\r\n\r\n\t\"keywords\": [\r\n\t\t\"2d\",\r\n\t\t\"3d\",\r\n\t\t\"rendering\",\r\n\t\t\"filter\",\r\n\t\t\"effect\",\r\n\t\t\"composer\",\r\n\t\t\"gpgpu\",\r\n\t\t\"rendertexture\",\r\n\t\t\"rendertarget\"\r\n\t],\r\n\r\n\t\"author\": {\r\n\t\t\"name\": \"Raoul van Rüschen\",\r\n\t\t\"email\": \"[email protected]\"\r\n\t},\r\n\r\n\t\"repository\": {\r\n\t\t\"type\": \"git\",\r\n\t\t\"url\": \"https://github.com/vanruesc/postprocessing.git\"\r\n\t},\r\n\r\n\t\"bugs\": {\r\n\t\t\"url\": \"https://github.com/vanruesc/postprocessing/issues\"\r\n\t},\r\n\r\n\t\"files\": [\r\n\t\t\"src\",\r\n\t\t\"build\"\r\n\t],\r\n\r\n\t\"scripts\": {\r\n\t\t\"ava\": \"ava\",\r\n\t\t\"lint\": \"npm run lint:lib && npm run lint:demo && npm run lint:test\",\r\n\t\t\"lint:config\": \"eslint *.js\",\r\n\t\t\"lint:lib\": \"eslint src\",\r\n\t\t\"lint:demo\": \"eslint demo/src\",\r\n\t\t\"lint:test\": \"eslint test\",\r\n\t\t\"build\": \"rollup -c\",\r\n\t\t\"build:production\": \"cross-env NODE_ENV=production npm run build\",\r\n\t\t\"doc\": \"esdoc\",\r\n\t\t\"deploy\": \"cpx demo/assets/** public/demo\",\r\n\t\t\"pretest\": \"npm run lint && npm run build:production\",\r\n\t\t\"test\": \"npm run ava\",\r\n\t\t\"prepack\": \"npm test && inline-import\",\r\n\t\t\"postpublish\": \"inline-import -r\"\r\n\t},\r\n\r\n\t\"ava\": {\r\n\t\t\"failFast\": true,\r\n\t\t\"files\": [\"test/**/*.js\"]\r\n\t},\r\n\r\n\t\"eslintConfig\": {\r\n\t\t\"extends\": \"delta\"\r\n\t},\r\n\r\n\t\"peerDependencies\": {\r\n\t\t\"three\": \">= 0.89.0 <= 0.96.0\"\r\n\t},\r\n\r\n\t\"devDependencies\": {\r\n\t\t\"@babel/core\": \"7.x.x\",\r\n\t\t\"@babel/preset-env\": \"7.x.x\",\r\n\t\t\"ava\": \"0.x.x\",\r\n\t\t\"cpx\": \"1.x.x\",\r\n\t\t\"cross-env\": \"5.x.x\",\r\n\t\t\"dat.gui\": \"0.x.x\",\r\n\t\t\"delta-controls\": \"2.x.x\",\r\n\t\t\"esdoc\": \"1.x.x\",\r\n\t\t\"esdoc-standard-plugin\": \"1.x.x\",\r\n\t\t\"eslint\": \"5.x.x\",\r\n\t\t\"eslint-config-delta\": \"0.x.x\",\r\n\t\t\"inline-import\": \"1.x.x\",\r\n\t\t\"math-ds\": \"1.x.x\",\r\n\t\t\"rollup\": \"0.x.x\",\r\n\t\t\"rollup-plugin-babel\": \"4.x.x\",\r\n\t\t\"rollup-plugin-babel-minify\": \"6.x.x\",\r\n\t\t\"rollup-plugin-node-resolve\": \"3.x.x\",\r\n\t\t\"rollup-plugin-string\": \"2.x.x\",\r\n\t\t\"synthetic-event\": \"0.x.x\",\r\n\t\t\"three\": \"0.96.x\",\r\n\t\t\"three-demo\": \"3.x.x\"\r\n\t}\r\n}\r\n",
"longname": "D:\\Sourcecode\\JavaScript\\postprocessing\\package.json",
"name": "package.json",
"static": true,
Expand Down
Loading

0 comments on commit 63db9d7

Please sign in to comment.