Skip to content

Support background(image) in WEBGL Renderer3D #8352

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
reshma045 wants to merge 1 commit into
base: dev-2.0
Choose a base branch
from
+29 −0
Open

Support background(image) in WEBGL Renderer3D #8352

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
29 changes: 29 additions & 0 deletions src/core/p5.Renderer3D.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,35 @@
}

background(...args) {
const a0 = args[0];

const isImageLike =
a0 instanceof p5.Image ||

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgb unsigned-int depth 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgb no depth antialiased 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgb float depth antialiased 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgb unsigned-int depth antialiased 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgba no depth 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgba float depth 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgba unsigned-int depth 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgba no depth antialiased 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgba float depth antialiased 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15

Check failure on line 734 in src/core/p5.Renderer3D.js

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, chrome)

test/unit/webgl/p5.Framebuffer.js > p5.Framebuffer > formats and channels > framebuffers work with WebGL 1, unsigned-byte rgba unsigned-int depth antialiased 

ReferenceError: p5 is not defined
 ❯ RendererGL.background src/core/p5.Renderer3D.js:734:21
 ❯ fn.background src/color/setting.js:671:20
 ❯ p5.background src/core/friendly_errors/param_validator.js:583:23
 ❯ test/unit/webgl/p5.Framebuffer.js:65:18
 ❯ Framebuffer.draw src/webgl/p5.Framebuffer.js:999:5
 ❯ test/unit/webgl/p5.Framebuffer.js:64:15
Copy link
Contributor

@davepagurek davepagurek Dec 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right, tests are failing currently because p5 isn't globally available in p5 2.0 so that we can create smaller, more modular builds without importing everything.

Maybe rather than checking if something is an instance of a class, we use duck typing and check to see if it has the properties of an image, graphics, or media element? I think that would imply checking that a0 is not undefined and it has width, height, and canvas properties.

a0 instanceof p5.Graphics ||
a0 instanceof p5.MediaElement ||
(typeof HTMLImageElement !== 'undefined' && a0 instanceof HTMLImageElement) ||
(typeof HTMLVideoElement !== 'undefined' && a0 instanceof HTMLVideoElement) ||
(typeof HTMLCanvasElement !== 'undefined' && a0 instanceof HTMLCanvasElement);

// WEBGL / 3D: support background(image)
if (args.length > 0 && isImageLike) {
this._pInst.clear();
this._pInst.push();
this._pInst.resetMatrix();
this._pInst.imageMode(constants.CORNER);
this._pInst.image(
a0,
-this._pInst.width / 2,
-this._pInst.height / 2,
this._pInst.width,
this._pInst.height
);

this._pInst.pop();
return;
}

// Default: background(color)
const _col = this._pInst.color(...args);
this.clear(..._col._getRGBA());
}
Expand Down
Loading