[RC] clearColor etc. flags

hmans · Oct 8, 2022 · 1d74dfc · 1d74dfc
1 parent 3b1d516
commit 1d74dfc
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.changeset/red-months-attend.md b/.changeset/red-months-attend.md
@@ -0,0 +1,5 @@
+---
+"render-composer": patch
+---
+
+**New:** `<RC.RenderPass>` now offers three new props, `clearColor`, `clearDepth` and `clearStencil`, that allow the user to configure which information the built-in clear pass should actually clear when enabled.
diff --git a/packages/render-composer/src/passes/RenderPass.tsx b/packages/render-composer/src/passes/RenderPass.tsx
@@ -15,10 +15,24 @@ export type RenderPassProps = {
   scene?: THREE.Scene
   ignoreBackground?: boolean
   clear?: boolean
+  clearColor?: boolean
+  clearDepth?: boolean
+  clearStencil?: boolean
 }
 
 export const RenderPass = forwardRef<PP.RenderPass, RenderPassProps>(
-  ({ camera, scene, ignoreBackground = false, clear = false }, ref) => {
+  (
+    {
+      camera,
+      scene,
+      ignoreBackground = false,
+      clear = false,
+      clearColor = true,
+      clearDepth = true,
+      clearStencil = true
+    },
+    ref
+  ) => {
     const r3fCamera = useThree((state) => state.camera)
     const r3fScene = useThree((state) => state.scene)
 
@@ -30,6 +44,7 @@ export const RenderPass = forwardRef<PP.RenderPass, RenderPassProps>(
     useLayoutEffect(() => {
       pass.ignoreBackground = ignoreBackground
       pass.clearPass.enabled = clear
+      pass.clearPass.setClearFlags(clearColor, clearDepth, clearStencil)
     })
 
     useImperativeHandle(ref, () => pass)