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.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
/**
* @file The `.meta` importer block → texture load settings.
*
* One parser for the editor viewport and a shipped build, so this is where the
* meaning of that block is pinned. The 9-slice rule earns its own cases: an
* all-zero border means "not sliced" and must stay ABSENT, because a present
* border is stamped onto the texture and would clear one set elsewhere.
*/
import { describe, it, expect } from 'vitest';
import { indexTextureImportSettings, textureImportSettingsFrom } from '../src/asset/textureImportSettings';
describe('textureImportSettingsFrom', () => {
it('maps filterMode/wrapMode to the loader filter/wrap shape', () => {
expect(textureImportSettingsFrom({ filterMode: 'nearest', wrapMode: 'clamp' }))
.toEqual({ filter: 'nearest', wrap: 'clamp', srgb: undefined, sliceBorder: undefined });
expect(textureImportSettingsFrom({ filterMode: 'linear' }))
.toEqual({ filter: 'linear', wrap: undefined, srgb: undefined, sliceBorder: undefined });
});
it('carries sRGB only when the block states it', () => {
expect(textureImportSettingsFrom({ sRGB: false })?.srgb).toBe(false);
expect(textureImportSettingsFrom({ sRGB: true })?.srgb).toBe(true);
expect(textureImportSettingsFrom({ filterMode: 'linear' })?.srgb).toBeUndefined();
});
it('is undefined when the block carries nothing the loader needs', () => {
expect(textureImportSettingsFrom({ maxSize: 2048 })).toBeUndefined();
expect(textureImportSettingsFrom({})).toBeUndefined();
expect(textureImportSettingsFrom(undefined)).toBeUndefined();
expect(textureImportSettingsFrom(null)).toBeUndefined();
});
it('ignores junk values rather than passing them to the loader', () => {
expect(textureImportSettingsFrom({ filterMode: 'wobbly', wrapMode: 7 })).toBeUndefined();
expect(textureImportSettingsFrom({ sRGB: 'yes' })).toBeUndefined();
});
describe('9-slice border', () => {
it('reads a full border', () => {
expect(textureImportSettingsFrom({ sliceBorder: { left: 12, right: 13, top: 14, bottom: 15 } })?.sliceBorder)
.toEqual({ left: 12, right: 13, top: 14, bottom: 15 });
});
it('keeps a partial border, zero-filling the edges that do not slice', () => {
expect(textureImportSettingsFrom({ sliceBorder: { left: 24, right: 24 } })?.sliceBorder)
.toEqual({ left: 24, right: 24, top: 0, bottom: 0 });
});
it('treats an all-zero border as NOT sliced, so it is never stamped', () => {
expect(textureImportSettingsFrom({ sliceBorder: { left: 0, right: 0, top: 0, bottom: 0 } }))
.toBeUndefined();
});
it('drops negative and non-finite edges', () => {
expect(textureImportSettingsFrom({ sliceBorder: { left: -5, right: NaN, top: 8, bottom: 'x' } })?.sliceBorder)
.toEqual({ left: 0, right: 0, top: 8, bottom: 0 });
});
it('survives a hand-edited block that is not an object', () => {
expect(textureImportSettingsFrom({ sliceBorder: 12 })).toBeUndefined();
expect(textureImportSettingsFrom({ sliceBorder: null })).toBeUndefined();
});
it('comes through alongside sampler settings', () => {
expect(textureImportSettingsFrom({ filterMode: 'nearest', sliceBorder: { left: 4 } }))
.toEqual({
filter: 'nearest', wrap: undefined, srgb: undefined,
sliceBorder: { left: 4, right: 0, top: 0, bottom: 0 },
});
});
});
});
describe('indexTextureImportSettings', () => {
const sliced = textureImportSettingsFrom({ sliceBorder: { left: 24, right: 22, top: 25, bottom: 31 } });
const lookup = indexTextureImportSettings([
{ uuid: 'abc-123', path: 'staged/9f3a.png', address: 'assets/ui/Button.png', settings: sliced },
]);
// Which spelling a component carries is the PROJECT's choice: the meta-driven
// pipeline writes `@uuid:`, a ported or hand-authored scene holds a path. An
// index that answers only one of them loses the settings for every project
// that picked the other — the exact shape of "sliced in the editor, stretched
// in the build".
it('answers to every spelling of the same asset', () => {
for (const ref of [
'abc-123', '@uuid:abc-123',
'assets/ui/Button.png', '/assets/ui/Button.png',
'staged/9f3a.png', '/staged/9f3a.png',
]) {
expect(lookup(ref), ref).toBe(sliced);
}
});
it('does not answer for an asset it was never given', () => {
expect(lookup('assets/ui/Other.png')).toBeUndefined();
expect(lookup('@uuid:no-such')).toBeUndefined();
});
it('skips assets whose importer says nothing the renderer acts on', () => {
const empty = indexTextureImportSettings([
{ uuid: 'x', path: 'a.png', settings: undefined },
]);
expect(empty('x')).toBeUndefined();
expect(empty('a.png')).toBeUndefined();
});
it('reads whether a texture generates mip maps, and says nothing when the block does not', () => {
expect(textureImportSettingsFrom({ mipmaps: false })?.mipmaps).toBe(false);
expect(textureImportSettingsFrom({ mipmaps: true })?.mipmaps).toBe(true);
expect(textureImportSettingsFrom({ filterMode: 'nearest' })?.mipmaps).toBeUndefined();
});
});