added the option to advance a frame with frameloop set to "never"

threlte · May 18, 2022 · 272d17c · 272d17c
1 parent 183dcef
commit 272d17c
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/src/lib/Canvas.svelte b/src/lib/Canvas.svelte
@@ -33,7 +33,7 @@
   export let dpr: typeof devicePixelRatio = browser ? window.devicePixelRatio : 1
   export let flat: boolean = false
   export let linear: boolean = false
-  export let frameloop: 'always' | 'demand' = 'demand'
+  export let frameloop: 'always' | 'demand' | 'never' = 'demand'
   export let debugFrameloop: boolean = false
   export let shadows: boolean = true
   export let shadowMapType: ShadowMapType = PCFSoftShadowMap

diff --git a/src/lib/lib/contexts.ts b/src/lib/lib/contexts.ts
@@ -20,7 +20,7 @@ export const createContexts = (
   userSize: Writable<Size | undefined>,
   parentSize: Writable<Size>,
   debugFrameloop: boolean,
-  frameloop: 'always' | 'demand'
+  frameloop: 'always' | 'demand' | 'never'
 ): {
   ctx: ThrelteContext
   rootCtx: ThrelteRootContext
@@ -66,7 +66,8 @@ export const createContexts = (
     frameInvalidated: true,
     pointerInvalidated: true,
     invalidations: {},
-    frameHandlers: new Set()
+    frameHandlers: new Set(),
+    advance: false
   }
 
   const ctx: ThrelteContext = {
@@ -89,6 +90,9 @@ export const createContexts = (
           ? renderCtx.invalidations[debugFrameloopMessage] + 1
           : 1
       }
+    },
+    advance: () => {
+      renderCtx.advance = true
     }
   }
 

diff --git a/src/lib/lib/frameloop.ts b/src/lib/lib/frameloop.ts
@@ -52,8 +52,9 @@ export const useFrameloop = (
   useRaf(() => {
     const shouldRender =
       renderCtx.frameloop === 'always' ||
-      renderCtx.frameInvalidated ||
-      renderCtx.frameHandlers.size > 0
+      (renderCtx.frameloop === 'demand' &&
+        (renderCtx.frameInvalidated || renderCtx.frameHandlers.size > 0)) ||
+      (renderCtx.frameloop === 'never' && renderCtx.advance)
 
     const shouldRaycast = shouldRender || renderCtx.pointerInvalidated
 
@@ -74,5 +75,6 @@ export const useFrameloop = (
     }
     debugFrame(renderCtx)
     renderCtx.frameInvalidated = false
+    renderCtx.advance = false
   })
 }
diff --git a/src/lib/types/types.ts b/src/lib/types/types.ts
@@ -67,17 +67,25 @@ export type ThrelteContext = {
   scene: Scene
   renderer?: WebGLRenderer
   composer?: EffectComposer
+  /**
+   * Invalidates the current frame when frameloop === 'demand'
+   */
   invalidate: (debugFrameloopMessage?: string) => void
+  /**
+   * Advance one frame when frameloop === 'never'
+   */
+  advance: () => void
 }
 
 export type ThrelteRenderContext = {
-  frameloop: 'always' | 'demand'
+  frameloop: 'always' | 'demand' | 'never'
   debugFrameloop: boolean
   pointerInvalidated: boolean
   frameInvalidated: boolean
   frame: number
   invalidations: Record<string, number>
   frameHandlers: Set<ThrelteFrameHandler>
+  advance: boolean
 }
 
 export type ThrelteAudioContext = {