Skip to content
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.

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

Fix crash because of invalid texture when resetting Panel Sprite instance renderer #6926

Merged
merged 5 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,28 +32,32 @@ namespace gdjs {
const StretchedSprite = !tiled ? PIXI.Sprite : PIXI.TilingSprite;
this._spritesContainer = new PIXI.Container();
this._wrapperContainer = new PIXI.Container();

// All these textures are going to be replaced in the call to `setTexture`.
// But to be safe and preserve the invariant that "these objects own their own
// textures", we create a new texture for each sprite.
this._centerSprite = new StretchedSprite(
new PIXI.Texture(texture.baseTexture)
);
this._borderSprites = [
// Right
new StretchedSprite(new PIXI.Texture(texture.baseTexture)),
// Top-Right
new PIXI.Sprite(texture),
new PIXI.Sprite(new PIXI.Texture(texture.baseTexture)),
// Top
new StretchedSprite(new PIXI.Texture(texture.baseTexture)),
// Top-Left
new PIXI.Sprite(texture),
new PIXI.Sprite(new PIXI.Texture(texture.baseTexture)),
// Left
new StretchedSprite(new PIXI.Texture(texture.baseTexture)),
// Bottom-Left
new PIXI.Sprite(texture),
new PIXI.Sprite(new PIXI.Texture(texture.baseTexture)),
// Bottom
new StretchedSprite(new PIXI.Texture(texture.baseTexture)),
new PIXI.Sprite(texture),
// Bottom-Right
new PIXI.Sprite(new PIXI.Texture(texture.baseTexture)),
];

//Bottom-Right
this.setTexture(textureName, instanceContainer);
this._spritesContainer.removeChildren();
this._spritesContainer.addChild(this._centerSprite);
Expand Down Expand Up @@ -209,7 +213,6 @@ namespace gdjs {
this._textureHeight = texture.height;

function makeInsideTexture(rect) {
//TODO
if (rect.width < 0) {
rect.width = 0;
}
Expand All @@ -236,6 +239,7 @@ namespace gdjs {
}
return rect;
}
this._centerSprite.texture.destroy(false);
this._centerSprite.texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -249,6 +253,7 @@ namespace gdjs {
);

//Top, Bottom, Right, Left borders:
this._borderSprites[0].texture.destroy(false);
this._borderSprites[0].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -260,6 +265,7 @@ namespace gdjs {
)
)
);
this._borderSprites[2].texture.destroy(false);
this._borderSprites[2].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -271,6 +277,7 @@ namespace gdjs {
)
)
);
this._borderSprites[4].texture.destroy(false);
this._borderSprites[4].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -282,6 +289,7 @@ namespace gdjs {
)
)
);
this._borderSprites[6].texture.destroy(false);
this._borderSprites[6].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -293,6 +301,7 @@ namespace gdjs {
)
)
);
this._borderSprites[1].texture.destroy(false);
this._borderSprites[1].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -304,10 +313,12 @@ namespace gdjs {
)
)
);
this._borderSprites[3].texture.destroy(false);
this._borderSprites[3].texture = new PIXI.Texture(
texture,
makeInsideTexture(new PIXI.Rectangle(0, 0, obj._lBorder, obj._tBorder))
);
this._borderSprites[5].texture.destroy(false);
this._borderSprites[5].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -319,6 +330,7 @@ namespace gdjs {
)
)
);
this._borderSprites[7].texture.destroy(false);
this._borderSprites[7].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand Down Expand Up @@ -395,7 +407,8 @@ namespace gdjs {
}

destroy() {
// Destroy textures because they are instantiated by this class.
// Destroy textures because they are instantiated by this class:
// all textures of borderSprites and centerSprite are "owned" by them.
for (const borderSprite of this._borderSprites) {
borderSprite.destroy({ texture: true });
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
pixiResourcesLoader
);

this.makeObjects();
this.updateTexture();
this.makeObjectsAndUpdateTextures();
}

update() {
Expand All @@ -52,10 +51,10 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
this._associatedObjectConfiguration
);
if (panelSprite.isTiled() !== this._tiled) {
this.makeObjects();
this.makeObjectsAndUpdateTextures();
}
if (panelSprite.getTexture() !== this._textureName) {
this.updateTexture();
this.updateTextures();
}

this.updateAngle();
Expand All @@ -79,15 +78,11 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
}
}

makeObjects() {
makeObjectsAndUpdateTextures() {
const panelSprite = gd.asPanelSpriteConfiguration(
this._associatedObjectConfiguration
);
this._textureName = panelSprite.getTexture();
const texture = PixiResourcesLoader.getPIXITexture(
this._project,
this._textureName
);
const texture = PixiResourcesLoader.getInvalidPIXITexture();

this._tiled = panelSprite.isTiled();
var StretchedSprite = !this._tiled ? PIXI.Sprite : PIXI.TilingSprite;
Expand All @@ -96,28 +91,35 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
this._pixiObject = new PIXI.Container();
this._pixiContainer.addChild(this._pixiObject);
}

// All these textures are going to be replaced in the call to updateTextures.
// But to be safe and preserve the invariant that "these objects own their own
// textures", we create a new texture for each sprite.
this._centerSprite = new StretchedSprite(new PIXI.Texture(texture));
this._borderSprites = [
new StretchedSprite(new PIXI.Texture(texture)), //Right
new PIXI.Sprite(texture), //Top-Right
new PIXI.Sprite(new PIXI.Texture(texture)), //Top-Right
D8H marked this conversation as resolved.
Show resolved Hide resolved
new StretchedSprite(new PIXI.Texture(texture)), //Top
new PIXI.Sprite(texture), //Top-Left
new PIXI.Sprite(new PIXI.Texture(texture)), //Top-Left
new StretchedSprite(new PIXI.Texture(texture)), //Left
new PIXI.Sprite(texture), //Bottom-Left
new PIXI.Sprite(new PIXI.Texture(texture)), //Bottom-Left
new StretchedSprite(new PIXI.Texture(texture)), //Bottom
new PIXI.Sprite(texture), //Bottom-Right
new PIXI.Sprite(new PIXI.Texture(texture)), //Bottom-Right
];

this._pixiObject.removeChildren();
this._pixiObject.addChild(this._centerSprite);
for (var i = 0; i < this._borderSprites.length; ++i) {
this._pixiObject.addChild(this._borderSprites[i]);
}

this.updateTextures();
}

onRemovedFromScene(): void {
super.onRemovedFromScene();
// Destroy textures because they are instantiated by this class.
// Destroy textures because they are instantiated by this class:
// all textures of borderSprites and centerSprite are "owned" by them.
for (const borderSprite of this._borderSprites) {
borderSprite.destroy({ texture: true });
}
Expand Down Expand Up @@ -230,7 +232,7 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
this._pixiObject.cacheAsBitmap = false;
}

updateTexture() {
updateTextures() {
const panelSprite = gd.asPanelSpriteConfiguration(
this._associatedObjectConfiguration
);
Expand All @@ -242,7 +244,7 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {

if (!texture.baseTexture.valid) {
// Post pone texture update if texture is not loaded.
texture.once('update', () => this.updateTexture());
texture.once('update', () => this.updateTextures());
return;
}

Expand All @@ -261,6 +263,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
return rect;
}

if (this._centerSprite.texture.valid)
this._centerSprite.texture.destroy(false);
this._centerSprite.texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -278,6 +282,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Right
if (this._borderSprites[0].texture.valid)
this._borderSprites[0].texture.destroy(false);
this._borderSprites[0].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -293,6 +299,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Top-right
if (this._borderSprites[1].texture.valid)
this._borderSprites[1].texture.destroy(false);
this._borderSprites[1].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -306,6 +314,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Top
if (this._borderSprites[2].texture.valid)
this._borderSprites[2].texture.destroy(false);
this._borderSprites[2].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -321,6 +331,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Top-Left
if (this._borderSprites[3].texture.valid)
this._borderSprites[3].texture.destroy(false);
this._borderSprites[3].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -334,6 +346,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Left
if (this._borderSprites[4].texture.valid)
this._borderSprites[4].texture.destroy(false);
this._borderSprites[4].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -349,6 +363,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Bottom-Left
if (this._borderSprites[5].texture.valid)
this._borderSprites[5].texture.destroy(false);
this._borderSprites[5].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -362,6 +378,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Bottom
if (this._borderSprites[6].texture.valid)
this._borderSprites[6].texture.destroy(false);
this._borderSprites[6].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand All @@ -377,6 +395,8 @@ export default class RenderedPanelSpriteInstance extends RenderedInstance {
);

//Bottom-Right
if (this._borderSprites[7].texture.valid)
this._borderSprites[7].texture.destroy(false);
this._borderSprites[7].texture = new PIXI.Texture(
texture,
makeInsideTexture(
Expand Down
Loading