angular-three-postprocessing 2.0.0-beta.252 → 2.0.0-beta.254
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,59 @@
|
|
|
1
|
-
# postprocessing
|
|
1
|
+
# `angular-three-postprocessing`
|
|
2
2
|
|
|
3
|
-
This library
|
|
3
|
+
This is the main entry point for post-processing effects in Angular Three. It provides a way to apply various visual effects to your 3D scene after it has been rendered. This library relies on `maath` and `postprocessing` as dependencies.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```bash
|
|
8
|
+
npm install angular-three-postprocessing maath postprocessing
|
|
9
|
+
# yarn add angular-three-postprocessing maath postprocessing
|
|
10
|
+
# pnpm add angular-three-postprocessing maath postprocessing
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## NgtpEffectComposer
|
|
14
|
+
|
|
15
|
+
This is a wrapper component that manages and applies post-processing effects to your scene. It takes content children of effects and applies them in the order they are provided.
|
|
16
|
+
|
|
17
|
+
### Object Inputs (NgtpEffectComposerOptions)
|
|
18
|
+
|
|
19
|
+
| Property | Description | Default Value |
|
|
20
|
+
| ------------------ | ------------------------------------------------------------------------------------------------- | ------------- |
|
|
21
|
+
| `enabled` | Whether the effect composer is enabled. | true |
|
|
22
|
+
| `depthBuffer` | Whether to use a depth buffer. | undefined |
|
|
23
|
+
| `enableNormalPass` | Whether to enable the normal pass. This is only used for SSGI currently. | undefined |
|
|
24
|
+
| `stencilBuffer` | Whether to use a stencil buffer. | undefined |
|
|
25
|
+
| `autoClear` | Whether to automatically clear the output buffer before rendering. | true |
|
|
26
|
+
| `resolutionScale` | A scaling factor for the resolution of the effect composer. | undefined |
|
|
27
|
+
| `multisampling` | The number of samples to use for multisample anti-aliasing (MSAA). Set to 0 to disable MSAA. | 8 |
|
|
28
|
+
| `frameBufferType` | The data type to use for the frame buffer. | HalfFloatType |
|
|
29
|
+
| `renderPriority` | The render priority of the effect composer. | 1 |
|
|
30
|
+
| `camera` | The camera to use for rendering. If not provided, the default camera from the store will be used. | undefined |
|
|
31
|
+
| `scene` | The scene to render. If not provided, the default scene from the store will be used. | undefined |
|
|
32
|
+
|
|
33
|
+
````html
|
|
34
|
+
<ngtp-effect-composer [options]="{ multisampling: 0, frameBufferType: FloatType, enableNormalPass: true }">
|
|
35
|
+
<ngtp-bloom />
|
|
36
|
+
</ngtp-effect-composer>
|
|
37
|
+
```
|
|
38
|
+
````
|
|
39
|
+
|
|
40
|
+
### NgtpEffectComposerApi
|
|
41
|
+
|
|
42
|
+
This is an interface that provides access to the underlying `NgtpEffectComposer` instance, as well as the `camera` and `scene` being used. It also includes references to the `NormalPass` and `DepthDownsamplingPass` if they are enabled
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
export interface NgtpEffectComposerApi {
|
|
46
|
+
composer: EffectComposer;
|
|
47
|
+
camera: Camera;
|
|
48
|
+
scene: Scene;
|
|
49
|
+
normalPass: NormalPass | null;
|
|
50
|
+
downSamplingPass: DepthDownsamplingPass | null;
|
|
51
|
+
resolutionScale?: number;
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
To retrieve the `NgtpEffectComposerApi` for components within `<ngtp-effect-composer />`, you can use the `injectEffectComposerApi` function.
|
|
56
|
+
|
|
57
|
+
## Effects
|
|
58
|
+
|
|
59
|
+
TBD
|