Fix mesh instance sort key when using drawBucket #7819
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
mvaligursky
commented
Jul 4, 2025
mvaligursky
commented
- we need 8 bits for the drawBucket, but only gave it 6 bits, which would cause incorrect sorting in some cases
There was a problem hiding this comment.
Pull Request Overview
This PR corrects the bit allocation for the draw bucket in the mesh instance sort key, expanding it from 6 bits to 8 bits to avoid sorting errors.
- Adjusted comment to reflect new 8-bit draw bucket range.
- Updated bit shifts and masks in
updateKey()to use 8 bits for draw bucket and 22 bits for material ID. - Shifted alpha test bit accordingly.
Comments suppressed due to low confidence (1)
src/scene/mesh-instance.js:1086
- Add unit tests for
updateKey()that cover drawBucket values above 63 to verify the new 8-bit allocation and ensure correct sort ordering.
updateKey() {
willeastcott
approved these changes
Jul 4, 2025
mvaligursky
added a commit
that referenced
this pull request
Jul 4, 2025
Co-authored-by: Martin Valigursky <[email protected]>
|
Hm, I used this code before to have depthTest without complicating everything with layers for a prototype: const material = new pc.StandardMaterial({diffuse: pc.Color.RED});
const test = Math.random() > 0.5;
if (test) {
console.log("Setting depthTest to false");
material.depthTest = false;
//material.depthFunc = pc.FUNC_ALWAYS;
material.update();
}
const marker = new pc.Entity("marker");
marker.addComponent('model', {type: 'box', material});
marker.setPosition(intersection);
marker.setLocalScale(0.1, 0.1, 0.1);
if (test) {
marker.model.meshInstances[0].drawBucket = 254;
}
this.app.root.addChild(marker);But now this trick doesn't work any longer, do you happen to know what's wrong? |
|
are you saying this PR makes it not working? |
yep, I just tested more and it does work when I make it lower than the default 127 value - so when I set it to 126, I can prioritize the mesh instance to make |
|
Mini cube-in-cube example where the inner cube as deactivated depth testing: <!DOCTYPE html>
<html>
<head>
<title>PlayCanvas Two Cubes</title>
<meta charset="utf-8">
<style>
body {margin: 0;}
canvas {width: 100%;height: 100%;display: block;}
</style>
<script type="importmap">{"imports": {
"playcanvas": "/playcanvas-engine-clean/src/index.js",
"fflate": "/playcanvas-engine-clean/node_modules/fflate/esm/browser.js",
"playcanvas/scripts/": "https://cdn.jsdelivr.net/npm/[email protected]/scripts/esm/"
}}</script>
</head>
<body>
<canvas id="application-canvas"></canvas>
<script type="module">
import * as pc from 'playcanvas';
const canvas = document.getElementById('application-canvas');
const app = new pc.Application(canvas);
app.setCanvasFillMode(pc.FILLMODE_FILL_WINDOW);
app.setCanvasResolution(pc.RESOLUTION_AUTO);
window.addEventListener('resize', () => app.resizeCanvas());
// Set up the camera
const camera = new pc.Entity('camera');
camera.addComponent('camera', {clearColor: new pc.Color(0, 0, 0.5)});
camera.setPosition(0, 0, 5);
app.root.addChild(camera);
// Create outer cube
const outerCube = new pc.Entity('outerCube');
outerCube.addComponent('render', {type: 'box'});
outerCube.setLocalScale(2, 2, 2);
app.root.addChild(outerCube);
// Create inner cube with depth testing disabled
const innerCube = new pc.Entity('innerCube');
const innerMaterial = new pc.StandardMaterial();
innerMaterial.diffuse = new pc.Color(1, 0, 0); // Red to distinguish
innerMaterial.depthTest = false;
innerMaterial.update();
innerCube.addComponent('render', {type: 'box', material: innerMaterial});
innerCube.render.meshInstances[0].drawBucket = 126;
app.root.addChild(innerCube);
// Random rotation speeds and directions
const outerRotationSpeed = new pc.Vec3(Math.random() - 0.5, Math.random() - 0.5, Math.random() - 0.5).scale(50);
const innerRotationSpeed = new pc.Vec3(Math.random() - 0.5, Math.random() - 0.5, Math.random() - 0.5).scale(50);
// Update loop for rotation
app.on('update', (dt) => {
outerCube.rotate(outerRotationSpeed.x * dt, outerRotationSpeed.y * dt, outerRotationSpeed.z * dt);
innerCube.rotate(innerRotationSpeed.x * dt, innerRotationSpeed.y * dt, innerRotationSpeed.z * dt);
});
app.scene.ambientLight = new pc.Color(0.75, 0.75, 0.75);
app.start();
</script>
</body>
</html>Ideally it should look like:
Interesting line required now: innerCube.render.meshInstances[0].drawBucket = 126; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.