Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

Skip stale queued material previews after disposal or reconnect

yhhc6714c311dbd
diff --git a/sdk/src/render/assetPreview.ts b/sdk/src/render/assetPreview.ts
index 8f951c1f2..f1e3eddfd 100644
--- a/sdk/src/render/assetPreview.ts
+++ b/sdk/src/render/assetPreview.ts
@@ -43,7 +43,10 @@ export function drawPreview(m: PreviewCore, draw: () => void): Promise<ImageData
}
async function readPreview(m: PreviewCore, draw: () => void): Promise<ImageData | null> {
- draw();
+ // An owner can disappear while waiting for another preview's readback.
+ // Skip both draw and poll, rather than return the previous task's pixels.
+ const submitted: unknown = draw();
+ if (submitted === false) return null;
if (await awaitReadback(() => m.renderer_pollPreviewReadback()) !== READBACK_READY) return null;
const size = m.renderer_getPreviewSize();
const w = m.renderer_getPreviewWidth();
diff --git a/sdk/src/render/material.ts b/sdk/src/render/material.ts
index bd769fc0b..e30502be6 100644
--- a/sdk/src/render/material.ts
+++ b/sdk/src/render/material.ts
@@ -647,10 +647,14 @@ export const Material = {
*/
async renderPreview(material: MaterialHandle, w: number, h: number): Promise<ImageData | null> {
const m = previewCore(module);
- if (!m) return null;
+ const data = materials.get(material);
+ if (!m || !data) return null;
const held: TextureLease[] = [];
try {
return await drawPreview(m, () => {
+ // IDs can be reused after reconnect. Check both identities at
+ // submission time, once the shared readback queue reaches us.
+ if (module !== m || materials.get(material) !== data) return false;
const seen = new Set<number>(); let handle: number | undefined = material;
while (handle !== undefined && !seen.has(handle)) {
seen.add(handle);
diff --git a/sdk/tests/material-texture-leases.test.ts b/sdk/tests/material-texture-leases.test.ts
index bfa856077..ebbff01bb 100644
--- a/sdk/tests/material-texture-leases.test.ts
+++ b/sdk/tests/material-texture-leases.test.ts
@@ -6,6 +6,24 @@ import type{AssetLease}from'../src/asset/AssetLease';
const lease=(handle:number):AssetLease<{handle:number}>=>({key:'texture:'+handle,generation:handle,value:{handle},release:vi.fn(),retain:()=>null});
afterEach(()=>{shutdownMaterialAPI();vi.unstubAllGlobals();});
describe('material-owned edited textures',()=>{
+ it.each([false,true])('skips queued previews after their material is disposed (core replaced: %s)',async(reconnect)=>{
+ let ready=false;
+ const core={HEAPU8:new Uint8Array(4),material_define:vi.fn(),material_setUniform:vi.fn(),material_setTexture:vi.fn(),material_undefine:vi.fn(),
+ renderer_renderMaterialPreview:vi.fn(),renderer_pollPreviewReadback:()=>ready?1:0,renderer_getPreviewSize:()=>4,renderer_getPreviewWidth:()=>1,renderer_getPreviewHeight:()=>1,renderer_getPreviewPtr:()=>0};
+ vi.stubGlobal('ImageData',class{constructor(public data:Uint8ClampedArray,public width:number,public height:number){}});
+ initMaterialAPI(core as never);
+ const first=Material.create({shader:1}),second=Material.create({shader:1});
+ const pending=Material.renderPreview(first,1,1),queued=Material.renderPreview(second,1,1);
+ try{
+ await vi.waitFor(()=>expect(core.renderer_renderMaterialPreview).toHaveBeenCalledTimes(1));
+ if(reconnect){
+ shutdownMaterialAPI();initMaterialAPI({...core,renderer_renderMaterialPreview:vi.fn()}as never);
+ Material.create({shader:1});expect(Material.create({shader:1})).toBe(second);
+ }else Material.release(second);
+ }finally{ready=true;await pending;}
+ expect(await queued).toBeNull();
+ expect(core.renderer_renderMaterialPreview).toHaveBeenCalledTimes(1);
+ });
it('keeps the submitted texture generation alive through pending preview readback',async()=>{
let ready=false;
const core={HEAPU8:new Uint8Array(4),material_define:vi.fn(),material_setUniform:vi.fn(),material_setTexture:vi.fn(),material_undefine:vi.fn(),