File strips are displaying incorrectly

[SoupTaels]

What version of Collage are you using?

v1.0.1 alpha

Description

Sprite strips only seem to work correctly if they're perfectly square. Sometimes they show both sprites, other times incorrect sprites, but if the sprite resolution is perfectly square, then the sprite actually displays correctly. I've done further testing with the default sprite_add function and strips display correct there no matter what.

I've made a test demonstration using Sonic Mania sprites. I have a control sprite(right) and a sprite I intentionally padded out width wise(left). Top row are Collage sprites, bottom sprite_add.

Here's the code.

CREATE EVENT:
soupTex_test = new Collage("Test"); //Create a texture page for these sprites
soupTex_test.StartBatch();
	soupTex_test.AddFileStrip("spr_sonic_collage_no_strip12.png", "sonic_no", , , CollageOrigin.CENTER, CollageOrigin.CENTER); //Add sprite to texture pack
	soupTex_test.AddFileStrip("spr_sonic_collage_yes_strip12.png", "sonic_yes", , , CollageOrigin.CENTER, CollageOrigin.CENTER); //Add sprite to texture pack
soupTex_test.FinishBatch();
soupTex_test = soupTex_test.ToStatic(true, true);

sonic_normal = sprite_add("spr_sonic_collage_no_strip12.png", 12, false, 0, 0, 0);
sonic_normal2 = sprite_add("spr_sonic_collage_yes_strip12.png", 12, false, 0, 0, 0);

DRAW EVENT:
var sonic_no = asset_get_index("sonic_no"), sonic_yes = asset_get_index("sonic_yes"), anim = current_time/ 100, scale = 2;
draw_set_halign(fa_center); draw_set_valign(fa_middle);
if ( sonic_no != -1 ) {
	var w_ = sprite_get_width(sonic_no) * scale, h_ = sprite_get_height(sonic_no) * scale;
	draw_text_color(320 - 60, 240 - 70, $"W: {w_}\nH: {h_}", -1, -1, -1, -1, 1);
	draw_sprite_ext(sonic_no, anim, 320 - 60, 240, scale, scale, 0, -1, 1); //Collage sprite with different width and height
} 
if ( sonic_yes != -1 ) {
	var w_ = sprite_get_width(sonic_yes) * scale, h_ = sprite_get_height(sonic_yes) * scale;
	draw_text_color(320 + 60, 240 - 70, $"W: {w_}\nH: {h_}", -1, -1, -1, -1, 1);
	draw_sprite_ext(sonic_yes, anim, 320 + 60, 240, scale, scale, 0, -1, 1); //Collage sprite with same width and height
} 

var w_ = sprite_get_width(sonic_normal) * scale, h_ = sprite_get_height(sonic_normal) * scale;
draw_text_color(270, 420, $"W: {w_}\nH: {h_}", -1, -1, -1, -1, 1);
draw_sprite_ext(sonic_normal, anim, 220, 240 + 60, scale, scale, 0, -1, 1); //Sprite added with sprite_add, different width and height

var w_ = sprite_get_width(sonic_normal2) * scale, h_ = sprite_get_height(sonic_normal2) * scale;
draw_text_color(370, 420, $"W: {w_}\nH: {h_}", -1, -1, -1, -1, 1);
draw_sprite_ext(sonic_normal2, anim, 340, 240 + 60, scale, scale, 0, -1, 1); //Sprite added with sprite_add, same width and height

Expected Change

No response

[tabularelf]

After some discussions on Discord, I've come to realise that this isn't technically a bug, but rather Collage working as expected. Though, at the same time I think Collage could do a much better job and I think it is worth investigating further if that can be improved.

In the meantime, I've added support for files with _strip* at the end of the extension, for .AddFileStrip(). Currently on dev branch.

[tabularelf]

Alright, got something much better. Sprites added via .AddFileStrip() without the _strip* argument, should instead use the approximation of frames instead, which will give off much better results than before. Will be out in the next release!

[tabularelf]

Reverted, been informed that there's some sprite issues. I cannot currently put in more time to fix this, and I'm suggesting for the meantime for anyone else having these issues, please make sure that each frame is approximately the same width as the height of the sprite (that being, a height of 41 should also be a width of 41, to compensate potential issues)