Skip to content

feat: add enableClear flag to disable glw.clear #728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chiefcll wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add enableClear flag to disable glw.clear #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/core/Stage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export type StageOptions = Omit<
platform: Platform | WebPlatform;
inspector: boolean;
maxRetryCount: number;
enableClear: boolean;
};

export type StageFpsUpdateHandler = (
Expand Down
4 changes: 3 additions & 1 deletion src/core/renderers/webgl/WebGlRenderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,9 @@ export class WebGlRenderer extends CoreRenderer {
this.curRenderOp = null;
this.renderOps.length = 0;
glw.setScissorTest(false);
glw.clear();
if (this.stage.options.enableClear !== false) {
glw.clear();
}
}

createShaderProgram(
Expand Down
13 changes: 13 additions & 0 deletions src/main-api/Renderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,17 @@ export interface RendererRuntimeSettings {
*/
fpsUpdateInterval: number;

/**
* Clears the render buffer on reset
*
* @remarks
* If false, the renderer will not clear the buffer before rendering a new frame.
* This is useful if you want to preserve the previous frame.
*
* @defaultValue `true`
*/
enableClear: boolean;

/**
* DOM Inspector
*
Expand Down Expand Up @@ -525,6 +536,7 @@ export class RendererMain extends EventEmitter {
settings.devicePhysicalPixelRatio || window.devicePixelRatio || 1,
clearColor: settings.clearColor ?? 0x00000000,
fpsUpdateInterval: settings.fpsUpdateInterval || 0,
enableClear: settings.enableClear ?? true,
targetFPS: settings.targetFPS || 0,
numImageWorkers:
settings.numImageWorkers !== undefined ? settings.numImageWorkers : 2,
Expand Down Expand Up @@ -586,6 +598,7 @@ export class RendererMain extends EventEmitter {
enableContextSpy: settings.enableContextSpy!,
forceWebGL2: settings.forceWebGL2!,
fpsUpdateInterval: settings.fpsUpdateInterval!,
enableClear: settings.enableClear!,
numImageWorkers: settings.numImageWorkers!,
renderEngine: settings.renderEngine!,
textureMemory: resolvedTxSettings,
Expand Down