Skip to content

Commit

Permalink
Update readme, bump version.
Browse files Browse the repository at this point in the history
  • Loading branch information
repalash committed Dec 10, 2023
1 parent 6da3ef1 commit 356654c
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 10 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2401,6 +2401,34 @@ To stop a transition, call `fadePlugin.stopTransition()`. This will immediately

The plugin automatically tracks `setDirty()` function calls in objects, materials and the scene. It can be triggerred by calling `setDirty` on any material or object in the scene. Check the [example](https://threepipe.org/examples/#frame-fade-plugin/) for a demo. This can be disabled by options in the plugin.

## VignettePlugin

[//]: # (todo: image)

Example: https://threepipe.org/examples/#vignette-plugin/

Source Code: [src/plugins/postprocessing/VignettePlugin.ts](./src/plugins/postprocessing/VignettePlugin.ts)

API Reference: [VignettePlugin](https://threepipe.org/docs/classes/VignettePlugin.html)

VignettePlugin adds a post-processing material extension to the ScreenPass in render manager
that applies a vignette effect to the final render. The parameters `power` and `color` can be changed to customize the effect.

```typescript
import {ThreeViewer, VignettePlugin} from 'threepipe'

const viewer = new ThreeViewer({...})

const vignettePlugin = viewer.addPluginSync(VignettePlugin)

// Change the vignette color
vignettePlugin.power = 1
vignettePlugin.color = new Color(0.5, 0, 0)

// or
// vignettePlugin.color.set('#ff0000'); vignettePlugin.setDirty() // Call setDirty to tell the plugin that color has changed
```

## HDRiGroundPlugin

[//]: # (todo: image)
Expand Down
16 changes: 8 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "threepipe",
"version": "0.0.16",
"version": "0.0.17",
"description": "A 3D viewer framework built on top of three.js in TypeScript with a focus on quality rendering, modularity and extensibility.",
"main": "src/index.ts",
"module": "dist/index.mjs",
Expand Down
2 changes: 1 addition & 1 deletion src/viewer/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const VERSION = '0.0.16'
export const VERSION = '0.0.17'

0 comments on commit 356654c

Please sign in to comment.