Skip to content

Fix transforms in clip() by using shape system for primitives using manual method #8236

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

Merged
perminder-17 merged 13 commits into from
Jan 4, 2026
+115 −37
Merged

Fix transforms in clip() by using shape system for primitives using manual method #8236

Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a5e1523
Fix transforms in clip() by using shape system for primitives using m…
VANSH3104 Nov 6, 2025
c4b5ca5
Merge branch 'dev-2.0' into transform/Clip
perminder-17 Nov 11, 2025
cc98f19
Handle negative scales in clipping by using absolute values for scale…
VANSH3104 Nov 12, 2025
34c4706
Merge branch 'dev-2.0' into transform/Clip
perminder-17 Nov 13, 2025
e5f5a41
Prevent double transform application in clip() with absolute coordinates
VANSH3104 Nov 19, 2025
22f8093
Merge branch 'dev-2.0' into transform/Clip
perminder-17 Nov 26, 2025
fc826d4
Reset transforms during clip application to ensure proper coordinate …
VANSH3104 Nov 27, 2025
5a49130
implement clipping with transform support for all 2D shapes
VANSH3104 Dec 1, 2025
902d2f6
Merge branch 'dev-2.0' into transform/Clip
perminder-17 Dec 5, 2025
0ac9c52
Merge branch 'dev-2.0' into transform/Clip
perminder-17 Dec 26, 2025
c3ffe0e
Update clip transforms per code review suggestions
VANSH3104 Jan 1, 2026
0552008
Removed unnecessary else blocks by using early return pattern in shap…
VANSH3104 Jan 4, 2026
ced12cd
Merge branch 'dev-2.0' into transform/Clip
perminder-17 Jan 4, 2026
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
141 changes: 111 additions & 30 deletions src/core/p5.Renderer2D.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@ class Renderer2D extends Renderer {
// Start a new path. Everything from here on out should become part of this
// one path so that we can clip to the whole thing.
this.clipPath = new Path2D();
this._clipBaseTransform = this.drawingContext.getTransform();

if (this._clipInvert) {
// Slight hack: draw a big rectangle over everything with reverse winding
Expand All @@ -331,7 +332,11 @@ class Renderer2D extends Renderer {
}

endClip() {
const savedTransform = this.drawingContext.getTransform();
this.drawingContext.setTransform(this._clipBaseTransform);
this.drawingContext.clip(this.clipPath);
this.drawingContext.setTransform(savedTransform);

this.clipPath = null;

super.endClip();
Expand Down Expand Up @@ -652,7 +657,7 @@ class Renderer2D extends Renderer {
* start <= stop < start + TWO_PI
*/
arc(x, y, w, h, start, stop, mode) {
const ctx = this.clipPa || this.drawingContext;
const ctx = this.drawingContext;
const rx = w / 2.0;
const ry = h / 2.0;
const epsilon = 0.00001; // Smallest visible angle on displays up to 4K.
Expand All @@ -663,7 +668,14 @@ class Renderer2D extends Renderer {
centerY = y + h / 2,
radiusX = w / 2,
radiusY = h / 2;

if (this._clipping) {
const tempPath = new Path2D();
tempPath.ellipse(centerX, centerY, radiusX, radiusY, 0, start, stop);
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
Copy link
Contributor

@davepagurek davepagurek Dec 31, 2025

Choose a reason for hiding this comment

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

Super minor, but generally we only start class names with a capital letter. Could we rename this to clipBaseTransform to avoid confusion?

const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
Copy link
Contributor

@davepagurek davepagurek Dec 31, 2025

Choose a reason for hiding this comment

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

Should we return early here like we do in the other cases?

Copy link
Contributor Author

@VANSH3104 VANSH3104 Jan 1, 2026

Choose a reason for hiding this comment

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

yes, we should return early here like in the other cases. I'll add return this; after the clipping logic to ensure consistency across all shape functions and prevent the normal drawing code from executing when clipping is active.

}
// Determines whether to add a line to the center, which should be done
// when the mode is PIE or default; as well as when the start and end
// angles do not form a full circle.
Expand Down Expand Up @@ -706,7 +718,7 @@ class Renderer2D extends Renderer {
}

ellipse(args) {
const ctx = this.clipPath || this.drawingContext;
const ctx = this.drawingContext;
const doFill = !!this.states.fillColor,
doStroke = this.states.strokeColor;
const x = parseFloat(args[0]),
Expand All @@ -726,42 +738,71 @@ class Renderer2D extends Renderer {
centerY = y + h / 2,
radiusX = w / 2,
radiusY = h / 2;
if (!this._clipping) ctx.beginPath();

ctx.ellipse(centerX, centerY, radiusX, radiusY, 0, 0, 2 * Math.PI);
ctx.closePath();

if (!this._clipping && doFill) {
ctx.fill();
}
if (!this._clipping && doStroke) {
ctx.stroke();
if (this._clipping) {
const tempPath = new Path2D();
tempPath.ellipse(centerX, centerY, radiusX, radiusY, 0, 0, 2 * Math.PI);
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
Copy link
Contributor

@davepagurek davepagurek Nov 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This looks right to me! The next step I think is to do this for the other shapes that directly draw to ctx.

} else {
ctx.beginPath();
ctx.ellipse(centerX, centerY, radiusX, radiusY, 0, 0, 2 * Math.PI);
ctx.closePath();
if (doFill) {
ctx.fill();
}
if (doStroke) {
ctx.stroke();
}
}

return this;
}

line(x1, y1, x2, y2) {
const ctx = this.clipPath || this.drawingContext;
const ctx = this.drawingContext;
if (!this.states.strokeColor) {
return this;
} else if (this._getStroke() === styleEmpty) {
return this;
}
if (this._clipping) {
const tempPath = new Path2D();
tempPath.moveTo(x1, y1);
tempPath.lineTo(x2, y2);
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
return this;
}
if (!this._clipping) ctx.beginPath();
ctx.moveTo(x1, y1);
ctx.lineTo(x2, y2);
ctx.stroke();
if (!this._clipping) ctx.stroke();
return this;
}

point(x, y) {
const ctx = this.clipPath || this.drawingContext;
const ctx = this.drawingContext;
if (!this.states.strokeColor) {
return this;
} else if (this._getStroke() === styleEmpty) {
return this;
}
const s = this._getStroke();
const f = this._getFill();
if (this._clipping) {
const tempPath = new Path2D();
const drawingContextWidth = this.drawingContext.lineWidth;
tempPath.arc(x, y, drawingContextWidth / 2, 0, constants.TWO_PI);
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
return this;
}
if (!this._clipping) {
Copy link
Contributor

@davepagurek davepagurek Dec 31, 2025

Choose a reason for hiding this comment

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

We can clean up if statements like this, since we'll have returned early if we were clipping, making these checks no longer necessary

// swapping fill color to stroke and back after for correct point rendering
this._setFill(s);
Expand All @@ -772,10 +813,11 @@ class Renderer2D extends Renderer {
ctx.fill();
this._setFill(f);
}
return this;
}

quad(x1, y1, x2, y2, x3, y3, x4, y4) {
const ctx = this.clipPath || this.drawingContext;
const ctx = this.drawingContext;
const doFill = !!this.states.fillColor,
doStroke = this.states.strokeColor;
if (doFill && !doStroke) {
Expand All @@ -787,17 +829,30 @@ class Renderer2D extends Renderer {
return this;
}
}
if (!this._clipping) ctx.beginPath();
ctx.moveTo(x1, y1);
ctx.lineTo(x2, y2);
ctx.lineTo(x3, y3);
ctx.lineTo(x4, y4);
ctx.closePath();
if (!this._clipping && doFill) {
ctx.fill();
}
if (!this._clipping && doStroke) {
ctx.stroke();
if (this._clipping) {
const tempPath = new Path2D();
tempPath.moveTo(x1, y1);
tempPath.lineTo(x2, y2);
tempPath.lineTo(x3, y3);
tempPath.lineTo(x4, y4);
tempPath.closePath();
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
} else{
ctx.beginPath();
ctx.moveTo(x1, y1);
ctx.lineTo(x2, y2);
ctx.lineTo(x3, y3);
ctx.lineTo(x4, y4);
ctx.closePath();
if (!this._clipping && doFill) {
Copy link
Contributor

@davepagurek davepagurek Dec 31, 2025

Choose a reason for hiding this comment

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

We can take out the !this._clipping from this condition since we'll only be in the else block if this is the case

ctx.fill();
}
if (!this._clipping && doStroke) {
ctx.stroke();
}
}
return this;
}
Expand All @@ -811,7 +866,7 @@ class Renderer2D extends Renderer {
let tr = args[5];
let br = args[6];
let bl = args[7];
const ctx = this.clipPath || this.drawingContext;
const ctx = this.drawingContext;
const doFill = !!this.states.fillColor,
doStroke = this.states.strokeColor;
if (doFill && !doStroke) {
Expand All @@ -823,6 +878,19 @@ class Renderer2D extends Renderer {
return this;
}
}
if (this._clipping) {
const tempPath = new Path2D();
if (typeof tl === 'undefined') {
tempPath.rect(x, y, w, h);
} else {
tempPath.roundRect(x, y, w, h, [tl, tr, br, bl]);
}
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
return this;
}
if (!this._clipping) ctx.beginPath();

if (typeof tl === 'undefined') {
Expand Down Expand Up @@ -886,7 +954,7 @@ class Renderer2D extends Renderer {


triangle(args) {
const ctx = this.clipPath || this.drawingContext;
const ctx = this.drawingContext;
const doFill = !!this.states.fillColor,
doStroke = this.states.strokeColor;
const x1 = args[0],
Expand All @@ -904,6 +972,18 @@ class Renderer2D extends Renderer {
return this;
}
}
if (this._clipping) {
const tempPath = new Path2D();
tempPath.moveTo(x1, y1);
tempPath.lineTo(x2, y2);
tempPath.lineTo(x3, y3);
tempPath.closePath();
const currentTransform = this.drawingContext.getTransform();
const ClipBaseTransform = this._clipBaseTransform.inverse();
const relativeTransform = ClipBaseTransform.multiply(currentTransform);
this.clipPath.addPath(tempPath, relativeTransform);
return this;
}
if (!this._clipping) ctx.beginPath();
ctx.moveTo(x1, y1);
ctx.lineTo(x2, y2);
Expand All @@ -915,6 +995,7 @@ class Renderer2D extends Renderer {
if (!this._clipping && doStroke) {
ctx.stroke();
}
return this;
}

//////////////////////////////////////////////
Expand Down
Loading