@react-three/postprocessing 2.1.0 → 2.1.1

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.
@@ -7,7 +7,7 @@ export declare const Bloom: import("react").ForwardRefExoticComponent<{
7
7
  intensity?: number;
8
8
  width?: number;
9
9
  height?: number;
10
- kernelSize?: any;
10
+ kernelSize?: KernelSize;
11
11
  } & Partial<{
12
12
  blendFunction: BlendFunction;
13
13
  opacity: number;
@@ -11,7 +11,7 @@ export declare const GodRays: React.ForwardRefExoticComponent<{
11
11
  clampMax?: number;
12
12
  width?: number;
13
13
  height?: number;
14
- kernelSize?: any;
14
+ kernelSize?: KernelSize;
15
15
  blur?: number;
16
16
  } & {
17
17
  sun: Mesh | Points;
@@ -15,7 +15,7 @@ export declare const Outline: React.ForwardRefExoticComponent<Partial<{
15
15
  hiddenEdgeColor: number;
16
16
  width: number;
17
17
  height: number;
18
- kernelSize: any;
18
+ kernelSize: KernelSize;
19
19
  blur: boolean;
20
20
  xRay: boolean;
21
21
  }> & Partial<{
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- import{BlendFunction as e,BloomEffect as t,BrightnessContrastEffect as n,ChromaticAberrationEffect as r,ColorAverageEffect as i,ColorDepthEffect as o,DepthEffect as l,EffectComposer as s,RenderPass as c,NormalPass as a,EffectPass as u,DepthOfFieldEffect as d,DotScreenEffect as m,GlitchEffect as f,GlitchMode as p,GodRaysEffect as h,GridEffect as b,HueSaturationEffect as g,NoiseEffect as w,OutlineEffect as E,PixelationEffect as y,ScanlineEffect as v,SelectiveBloomEffect as S,SepiaEffect as T,SSAOEffect as j,SMAAPreset as x,EdgeDetectionMode as C,SMAAImageLoader as P,SMAAEffect as A,TextureEffect as L,ToneMappingEffect as O,VignetteEffect as R,ShockWaveEffect as z,LUTEffect as F}from"postprocessing";import B,{forwardRef as D,useMemo as I,useLayoutEffect as M,createContext as k,useEffect as N,useRef as _,useImperativeHandle as G,useContext as H}from"react";import{Vector2 as U,Vector3 as Y,TextureLoader as q,sRGBEncoding as V,RepeatWrapping as J}from"three";import{useThree as K,useFrame as Q,useLoader as W}from"@react-three/fiber";import{isWebGL2Available as X}from"three-stdlib";const Z=(t,n=e.NORMAL)=>D((function({blendFunction:e,opacity:r,...i},o){const l=I((()=>new t(i)),[i]);return M((()=>{l.blendMode.blendFunction=e||n,void 0!==r&&(l.blendMode.opacity.value=r)}),[e,l.blendMode,r]),B.createElement("primitive",{ref:o,object:l,dispose:null})})),$=(e,t)=>{const n=e[t];return I((()=>{if(n instanceof U)return(new U).set(n.x,n.y);if(Array.isArray(n)){const[e,t]=n;return(new U).set(e,t)}}),[n])},ee=Z(t,e.SCREEN),te=Z(n),ne=D((function(e,t){const n=$(e,"offset"),i=I((()=>new r({...e,offset:n})),[n,e]);return B.createElement("primitive",{ref:t,object:i,dispose:null})})),re=D((function({blendFunction:t=e.NORMAL},n){const r=I((()=>new i(t)),[t]);return B.createElement("primitive",{ref:n,object:r,dispose:null})})),ie=Z(o),oe=Z(l),le=k(null),se=B.memo(D((({children:e,camera:t,scene:n,renderPriority:r=1,autoClear:i=!0,depthBuffer:o,disableNormalPass:l,stencilBuffer:d,multisampling:m=8,frameBufferType:f},p)=>{const{gl:h,scene:b,camera:g,size:w}=K();n=n||b,t=t||g;const[E,y]=I((()=>{const e=new s(h,{depthBuffer:o,stencilBuffer:d,multisampling:X()?m:0,frameBufferType:f});e.addPass(new c(n,t));const r=l?null:new a(n,t);return r&&e.addPass(r),[e,r]}),[t,h,o,d,m,f,n,l]);N((()=>null==E?void 0:E.setSize(w.width,w.height)),[E,w]),Q(((e,t)=>(h.autoClear=i,void E.render(t))),r);const v=_(null);N((()=>{let e;return v.current&&v.current.__r3f&&E&&(e=new u(t,...v.current.__r3f.objects),E.addPass(e),e.renderToScreen=!0),()=>{e&&(null==E||E.removePass(e))}}),[E,e,t]);const S=I((()=>({composer:E,normalPass:y,camera:t,scene:n})),[E,y,t,n]);return G(p,(()=>E),[E]),B.createElement(le.Provider,{value:S},B.createElement("group",{ref:v},e))}))),ce=D((function({target:e,depthTexture:t,...n},r){const{camera:i}=H(le),o=I((()=>new d(i,n)),[i,n]);return M((()=>{if(e){const t=e instanceof Y?(new Y).set(e.x,e.y,e.z):(new Y).set(e[0],e[1],e[2]);o.target=t}t&&o.setDepthTexture(t.texture,t.packing)}),[e,t,o]),B.createElement("primitive",{ref:r,object:o,dispose:null})})),ae=Z(m),ue=D((function({active:e=!0,...t},n){const r=$(t,"delay"),i=$(t,"duration"),o=$(t,"strength"),l=I((()=>new f({...t,delay:r,duration:i,strength:o})),[r,i,t,o]);return M((()=>{l.mode=e?t.mode||p.SPORADIC:p.DISABLED}),[e,l,t.mode]),B.createElement("primitive",{ref:n,object:l,dispose:null})})),de=D((function(e,t){const{camera:n}=H(le),r=I((()=>new h(n,e.sun,e)),[n,e]);return B.createElement("primitive",{ref:t,object:r,dispose:null})})),me=D((function({size:e,...t},n){const r=I((()=>new b(t)),[t]);return M((()=>{e&&r.setSize(e.width,e.height)}),[r,e]),B.createElement("primitive",{ref:n,object:r,dispose:null})})),fe=Z(g),pe=Z(w,e.COLOR_DODGE),he=D((function({selection:e=[],selectionLayer:t=10,blendFunction:n,patternTexture:r,edgeStrength:i,pulseSpeed:o,visibleEdgeColor:l,hiddenEdgeColor:s,width:c,height:a,kernelSize:u,blur:d,xRay:m,...f},p){const{scene:h,camera:b}=H(le),g=I((()=>new E(h,b,{blendFunction:n,patternTexture:r,edgeStrength:i,pulseSpeed:o,visibleEdgeColor:l,hiddenEdgeColor:s,width:c,height:a,kernelSize:u,blur:d,xRay:m})),[n,d,b,i,a,s,u,r,o,h,l,c,m]);return N((()=>{g.clearSelection(),g.setSelection(Array.isArray(e)?e.map((e=>e.current)):[e.current])}),[g,e]),N((()=>{g.selectionLayer=t}),[g,t]),B.createElement("primitive",{ref:p,object:g,dispose:null})})),be=D((function({granularity:e=5},t){const n=I((()=>new y(e)),[e]);return B.createElement("primitive",{ref:t,object:n,dispose:null})})),ge=Z(v,e.OVERLAY),we=D((function({selection:t=[],selectionLayer:n=10,lights:r=[],luminanceThreshold:i,luminanceSmoothing:o,intensity:l,width:s,height:c,kernelSize:a},u){0===r.length&&console.warn("SelectiveBloom requires lights to work.");const{scene:d,camera:m}=H(le),f=I((()=>new S(d,m,{blendFunction:e.SCREEN,luminanceThreshold:i,luminanceSmoothing:o,intensity:l,width:s,height:c,kernelSize:a})),[m,c,l,a,o,i,d,s]);return N((()=>{f.selection.set(Array.isArray(t)?t.map((e=>e.current)):[t.current])}),[f,t]),N((()=>{f.selection.layer=n}),[f,n]),N((()=>(r.forEach((e=>((e,t)=>{e.current&&e.current.layers.enable(t.selection.layer)})(e,f))),()=>r.forEach((e=>((e,t)=>{e.current&&e.current.layers.disable(t.selection.layer)})(e,f))))),[f,r,n]),B.createElement("primitive",{ref:u,object:f,dispose:null})})),Ee=Z(T),ye=D((function(t,n){const{camera:r,normalPass:i}=H(le),o=I((()=>null===i?(console.error("Please enable the NormalPass in the EffectComposer in order to use SSAO."),null):new j(r,i.renderTarget.texture,{blendFunction:e.MULTIPLY,samples:30,rings:4,distanceThreshold:1,distanceFalloff:0,rangeThreshold:.5,rangeFalloff:.1,luminanceInfluence:.9,radius:20,scale:.5,bias:.5,intensity:1,color:null,...t})),[r,i,t]);return B.createElement("primitive",{ref:n,object:o,dispose:null})})),ve=D((function({preset:e=x.HIGH,edgeDetectionMode:t=C.COLOR},n){const r=W(P,""),i=I((()=>new A(...r,e,t)),[r,e,t]);return B.createElement("primitive",{ref:n,object:i,dispose:null})})),Se=D((function({textureSrc:e,texture:t,...n},r){const i=W(q,e);M((()=>{i.encoding=V,i.wrapS=i.wrapT=J}),[i]);const o=I((()=>new L({...n,texture:i||t})),[n,i,t]);return B.createElement("primitive",{ref:r,object:o,dispose:null})})),Te=Z(O),je=Z(R),xe=Z(z),Ce=D((function({lut:e,tetrahedralInterpolation:t,...n},r){const i=I((()=>new F(e,n)),[e,n]);return M((()=>{e&&i.setLUT(e),t&&i.setTetrahedralInterpolationEnabled(t)}),[i,e,t]),B.createElement("primitive",{ref:r,object:i,dispose:null})}));export{ee as Bloom,te as BrightnessContrast,ne as ChromaticAberration,re as ColorAverage,ie as ColorDepth,oe as Depth,ce as DepthOfField,ae as DotScreen,se as EffectComposer,le as EffectComposerContext,ue as Glitch,de as GodRays,me as Grid,fe as HueSaturation,Ce as LUT,pe as Noise,he as Outline,be as Pixelation,ve as SMAA,ye as SSAO,ge as Scanline,we as SelectiveBloom,Ee as Sepia,xe as ShockWave,Se as Texture,Te as ToneMapping,je as Vignette};
1
+ import{BlendFunction as e,BloomEffect as t,BrightnessContrastEffect as n,ChromaticAberrationEffect as r,ColorAverageEffect as i,ColorDepthEffect as o,DepthEffect as l,EffectComposer as s,RenderPass as c,NormalPass as a,EffectPass as u,DepthOfFieldEffect as d,DotScreenEffect as m,GlitchEffect as f,GlitchMode as p,GodRaysEffect as h,GridEffect as b,HueSaturationEffect as g,NoiseEffect as E,OutlineEffect as w,PixelationEffect as y,ScanlineEffect as v,SelectiveBloomEffect as S,SepiaEffect as T,SSAOEffect as j,SMAAPreset as x,EdgeDetectionMode as C,SMAAImageLoader as P,SMAAEffect as A,TextureEffect as L,ToneMappingEffect as O,VignetteEffect as R,ShockWaveEffect as z,LUTEffect as F}from"postprocessing";import B,{forwardRef as D,useMemo as I,useLayoutEffect as M,createContext as k,useEffect as N,useRef as _,useImperativeHandle as G,useContext as H}from"react";import{Vector2 as U,Vector3 as Y,TextureLoader as q,sRGBEncoding as V,RepeatWrapping as J}from"three";import{useThree as K,useFrame as Q,useLoader as W}from"@react-three/fiber";import{isWebGL2Available as X}from"three-stdlib";const Z=function(t,n){return void 0===n&&(n=e.NORMAL),D((function(e,r){let{blendFunction:i,opacity:o,...l}=e;const s=I((()=>new t(l)),[l]);return M((()=>{s.blendMode.blendFunction=i||n,void 0!==o&&(s.blendMode.opacity.value=o)}),[i,s.blendMode,o]),B.createElement("primitive",{ref:r,object:s,dispose:null})}))},$=(e,t)=>{const n=e[t];return I((()=>{if(n instanceof U)return(new U).set(n.x,n.y);if(Array.isArray(n)){const[e,t]=n;return(new U).set(e,t)}}),[n])},ee=Z(t,e.SCREEN),te=Z(n),ne=D((function(e,t){const n=$(e,"offset"),i=I((()=>new r({...e,offset:n})),[n,e]);return B.createElement("primitive",{ref:t,object:i,dispose:null})})),re=D((function(t,n){let{blendFunction:r=e.NORMAL}=t;const o=I((()=>new i(r)),[r]);return B.createElement("primitive",{ref:n,object:o,dispose:null})})),ie=Z(o),oe=Z(l),le=k(null);var se=B.memo(D(((e,t)=>{let{children:n,camera:r,scene:i,renderPriority:o=1,autoClear:l=!0,depthBuffer:d,disableNormalPass:m,stencilBuffer:f,multisampling:p=8,frameBufferType:h}=e;const{gl:b,scene:g,camera:E,size:w}=K();i=i||g,r=r||E;const[y,v]=I((()=>{const e=new s(b,{depthBuffer:d,stencilBuffer:f,multisampling:X()?p:0,frameBufferType:h});e.addPass(new c(i,r));const t=m?null:new a(i,r);return t&&e.addPass(t),[e,t]}),[r,b,d,f,p,h,i,m]);N((()=>null==y?void 0:y.setSize(w.width,w.height)),[y,w]),Q(((e,t)=>(b.autoClear=l,void y.render(t))),o);const S=_(null);N((()=>{let e;return S.current&&S.current.__r3f&&y&&(e=new u(r,...S.current.__r3f.objects),y.addPass(e),e.renderToScreen=!0),()=>{e&&(null==y||y.removePass(e))}}),[y,n,r]);const T=I((()=>({composer:y,normalPass:v,camera:r,scene:i})),[y,v,r,i]);return G(t,(()=>y),[y]),B.createElement(le.Provider,{value:T},B.createElement("group",{ref:S},n))})));const ce=D((function(e,t){let{target:n,depthTexture:r,...i}=e;const{camera:o}=H(le),l=I((()=>new d(o,i)),[o,i]);return M((()=>{if(n){const e=n instanceof Y?(new Y).set(n.x,n.y,n.z):(new Y).set(n[0],n[1],n[2]);l.target=e}r&&l.setDepthTexture(r.texture,r.packing)}),[n,r,l]),B.createElement("primitive",{ref:t,object:l,dispose:null})})),ae=Z(m),ue=D((function(e,t){let{active:n=!0,...r}=e;const i=$(r,"delay"),o=$(r,"duration"),l=$(r,"strength"),s=I((()=>new f({...r,delay:i,duration:o,strength:l})),[i,o,r,l]);return M((()=>{s.mode=n?r.mode||p.SPORADIC:p.DISABLED}),[n,s,r.mode]),B.createElement("primitive",{ref:t,object:s,dispose:null})})),de=D((function(e,t){const{camera:n}=H(le),r=I((()=>new h(n,e.sun,e)),[n,e]);return B.createElement("primitive",{ref:t,object:r,dispose:null})})),me=D((function(e,t){let{size:n,...r}=e;const i=I((()=>new b(r)),[r]);return M((()=>{n&&i.setSize(n.width,n.height)}),[i,n]),B.createElement("primitive",{ref:t,object:i,dispose:null})})),fe=Z(g),pe=Z(E,e.COLOR_DODGE),he=D((function(e,t){let{selection:n=[],selectionLayer:r=10,blendFunction:i,patternTexture:o,edgeStrength:l,pulseSpeed:s,visibleEdgeColor:c,hiddenEdgeColor:a,width:u,height:d,kernelSize:m,blur:f,xRay:p,...h}=e;const{scene:b,camera:g}=H(le),E=I((()=>new w(b,g,{blendFunction:i,patternTexture:o,edgeStrength:l,pulseSpeed:s,visibleEdgeColor:c,hiddenEdgeColor:a,width:u,height:d,kernelSize:m,blur:f,xRay:p})),[i,f,g,l,d,a,m,o,s,b,c,u,p]);return N((()=>{E.clearSelection(),E.setSelection(Array.isArray(n)?n.map((e=>e.current)):[n.current])}),[E,n]),N((()=>{E.selectionLayer=r}),[E,r]),B.createElement("primitive",{ref:t,object:E,dispose:null})})),be=D((function(e,t){let{granularity:n=5}=e;const r=I((()=>new y(n)),[n]);return B.createElement("primitive",{ref:t,object:r,dispose:null})})),ge=Z(v,e.OVERLAY),Ee=D((function(t,n){let{selection:r=[],selectionLayer:i=10,lights:o=[],luminanceThreshold:l,luminanceSmoothing:s,intensity:c,width:a,height:u,kernelSize:d}=t;0===o.length&&console.warn("SelectiveBloom requires lights to work.");const{scene:m,camera:f}=H(le),p=I((()=>new S(m,f,{blendFunction:e.SCREEN,luminanceThreshold:l,luminanceSmoothing:s,intensity:c,width:a,height:u,kernelSize:d})),[f,u,c,d,s,l,m,a]);return N((()=>{p.selection.set(Array.isArray(r)?r.map((e=>e.current)):[r.current])}),[p,r]),N((()=>{p.selection.layer=i}),[p,i]),N((()=>(o.forEach((e=>((e,t)=>{e.current&&e.current.layers.enable(t.selection.layer)})(e,p))),()=>o.forEach((e=>((e,t)=>{e.current&&e.current.layers.disable(t.selection.layer)})(e,p))))),[p,o,i]),B.createElement("primitive",{ref:n,object:p,dispose:null})})),we=Z(T),ye=D((function(t,n){const{camera:r,normalPass:i}=H(le),o=I((()=>null===i?(console.error("Please enable the NormalPass in the EffectComposer in order to use SSAO."),null):new j(r,i.renderTarget.texture,{blendFunction:e.MULTIPLY,samples:30,rings:4,distanceThreshold:1,distanceFalloff:0,rangeThreshold:.5,rangeFalloff:.1,luminanceInfluence:.9,radius:20,scale:.5,bias:.5,intensity:1,color:null,...t})),[r,i,t]);return B.createElement("primitive",{ref:n,object:o,dispose:null})})),ve=D((function(e,t){let{preset:n=x.HIGH,edgeDetectionMode:r=C.COLOR}=e;const i=W(P,""),o=I((()=>new A(...i,n,r)),[i,n,r]);return B.createElement("primitive",{ref:t,object:o,dispose:null})})),Se=D((function(e,t){let{textureSrc:n,texture:r,...i}=e;const o=W(q,n);M((()=>{o.encoding=V,o.wrapS=o.wrapT=J}),[o]);const l=I((()=>new L({...i,texture:o||r})),[i,o,r]);return B.createElement("primitive",{ref:t,object:l,dispose:null})})),Te=Z(O),je=Z(R),xe=Z(z),Ce=D((function(e,t){let{lut:n,tetrahedralInterpolation:r,...i}=e;const o=I((()=>new F(n,i)),[n,i]);return M((()=>{n&&o.setLUT(n),r&&o.setTetrahedralInterpolationEnabled(r)}),[o,n,r]),B.createElement("primitive",{ref:t,object:o,dispose:null})}));export{ee as Bloom,te as BrightnessContrast,ne as ChromaticAberration,re as ColorAverage,ie as ColorDepth,oe as Depth,ce as DepthOfField,ae as DotScreen,se as EffectComposer,le as EffectComposerContext,ue as Glitch,de as GodRays,me as Grid,fe as HueSaturation,Ce as LUT,pe as Noise,he as Outline,be as Pixelation,ve as SMAA,ye as SSAO,ge as Scanline,Ee as SelectiveBloom,we as Sepia,xe as ShockWave,Se as Texture,Te as ToneMapping,je as Vignette};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@react-three/postprocessing",
3
- "version": "2.1.0",
3
+ "version": "2.1.1",
4
4
  "description": "postprocessing wrapper for React and @react-three/fiber",
5
5
  "keywords": [
6
6
  "postprocessing",
@@ -38,48 +38,48 @@
38
38
  "typegen": "tsc --emitDeclarationOnly || true"
39
39
  },
40
40
  "dependencies": {
41
- "postprocessing": "^6.22.2",
41
+ "postprocessing": "^6.23.3",
42
42
  "react-merge-refs": "^1.1.0",
43
43
  "three-stdlib": "^2.6.2"
44
44
  },
45
45
  "devDependencies": {
46
- "@babel/core": "^7.14.6",
47
- "@babel/plugin-transform-modules-commonjs": "7.14.5",
48
- "@babel/plugin-transform-parameters": "7.14.5",
49
- "@babel/plugin-transform-runtime": "7.14.5",
50
- "@babel/plugin-transform-template-literals": "7.14.5",
51
- "@babel/preset-env": "^7.14.7",
52
- "@babel/preset-react": "7.14.5",
53
- "@babel/preset-typescript": "^7.14.5",
54
- "@react-three/fiber": "^6.0.1",
46
+ "@babel/core": "^7.16.5",
47
+ "@babel/plugin-transform-modules-commonjs": "7.16.5",
48
+ "@babel/plugin-transform-parameters": "7.16.5",
49
+ "@babel/plugin-transform-runtime": "7.16.5",
50
+ "@babel/plugin-transform-template-literals": "7.16.5",
51
+ "@babel/preset-env": "^7.16.5",
52
+ "@babel/preset-react": "7.16.5",
53
+ "@babel/preset-typescript": "^7.16.5",
54
+ "@react-three/fiber": "^7.0.24",
55
55
  "@rollup/plugin-babel": "^5.3.0",
56
- "@rollup/plugin-commonjs": "^19.0.1",
56
+ "@rollup/plugin-commonjs": "^21.0.1",
57
57
  "@rollup/plugin-json": "^4.1.0",
58
- "@rollup/plugin-node-resolve": "^13.0.2",
59
- "@types/react": "^17.0.14",
60
- "@types/react-dom": "^17.0.9",
58
+ "@rollup/plugin-node-resolve": "^13.1.1",
59
+ "@types/react": "^17.0.37",
60
+ "@types/react-dom": "^17.0.11",
61
61
  "@types/react-test-renderer": "^17.0.1",
62
- "@types/three": "^0.130.0",
63
- "@typescript-eslint/eslint-plugin": "^4.28.4",
64
- "@typescript-eslint/parser": "^4.28.4",
65
- "eslint": "^7.31.0",
62
+ "@types/three": "^0.135.0",
63
+ "@typescript-eslint/eslint-plugin": "^5.8.0",
64
+ "@typescript-eslint/parser": "^5.8.0",
65
+ "eslint": "^8.5.0",
66
66
  "eslint-config-prettier": "^8.3.0",
67
67
  "eslint-import-resolver-alias": "^1.1.2",
68
- "eslint-plugin-import": "^2.23.4",
69
- "eslint-plugin-prettier": "^3.4.0",
70
- "eslint-plugin-react": "^7.24.0",
71
- "eslint-plugin-react-hooks": "^4.2.0",
72
- "husky": "^7.0.1",
68
+ "eslint-plugin-import": "^2.25.3",
69
+ "eslint-plugin-prettier": "^4.0.0",
70
+ "eslint-plugin-react": "^7.27.1",
71
+ "eslint-plugin-react-hooks": "^4.3.0",
72
+ "husky": "^7.0.4",
73
73
  "husky-run": "^0.0.0",
74
- "lint-staged": "^11.0.1",
75
- "prettier": "^2.3.2",
74
+ "lint-staged": "^12.1.3",
75
+ "prettier": "^2.5.1",
76
76
  "react": "^17.0.2",
77
77
  "react-dom": "^17.0.2",
78
78
  "rimraf": "^3.0.2",
79
- "rollup": "^2.53.2",
79
+ "rollup": "^2.61.1",
80
80
  "rollup-plugin-filesize": "^9.1.1",
81
81
  "rollup-plugin-terser": "^7.0.2",
82
- "typescript": "^4.3.5"
82
+ "typescript": "^4.5.4"
83
83
  },
84
84
  "peerDependencies": {
85
85
  "@react-three/fiber": ">=7.0",