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.

chore(api): refresh the surface snapshots for the asset lease doors

esengined3c0aaec074a
diff --git a/docs/astro/src/data/apiStability.generated.json b/docs/astro/src/data/apiStability.generated.json
index fefa22e37..462099d11 100644
--- a/docs/astro/src/data/apiStability.generated.json
+++ b/docs/astro/src/data/apiStability.generated.json
@@ -3,10 +3,10 @@
"counts": {
"public": 113,
"beta": 89,
- "experimental": 1640,
+ "experimental": 1642,
"deprecated": 3
},
- "total": 1842,
+ "total": 1844,
"subsystems": [
{
"id": "ecs",
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 3dc556f21..27eeeac5f 100644
--- a/sdk/etc/index.api.md
+++ b/sdk/etc/index.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/index
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 113 public · 82 beta · 1503 experimental · 3 deprecated
+Symbols: 113 public · 82 beta · 1505 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -682,6 +682,14 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
+## AssetLease — interface @experimental
+```
+generation: number
+key: string
+release: () => void
+value: T
+```
+
## AssetPlugin — class @experimental
```
build: (app: App) => void
@@ -728,6 +736,17 @@ entities: number[]
refCount: number
```
+## AssetScope — class @experimental
+```
+@internal leases: () => readonly AssetLease[]
+add: <T>(lease: AssetLease<T>) => AssetLease<T>
+forget: (lease: AssetLease) => boolean
+releaseAll: () => void
+size: number
+static new (): AssetScope
+static prototype: AssetScope
+```
+
## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
@@ -746,8 +765,12 @@ ResourceDef<AssetsClass>
## AssetsData — type @beta
```
+@internal releaseTextureLease: (lease: AssetRefLease<number>) => void
@internal releaseTyped: (type: string, ref: string) => void
+@internal releaseTypedLease: (type: string, lease: AssetRefLease<unknown>) => void
@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+acquireTexture: (ref: string) => Promise<AssetLease<TextureResult>>
+acquireTyped: <T>(type: string, ref: string) => Promise<AssetLease<T>>
applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
backend: Backend
baseUrl: string | undefined
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index d320ba7c8..8afd9c246 100644
--- a/sdk/etc/index.native.api.md
+++ b/sdk/etc/index.native.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/index.native
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 113 public · 87 beta · 1522 experimental · 3 deprecated
+Symbols: 113 public · 87 beta · 1524 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -682,6 +682,14 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
+## AssetLease — interface @experimental
+```
+generation: number
+key: string
+release: () => void
+value: T
+```
+
## AssetPlugin — class @experimental
```
build: (app: App) => void
@@ -728,6 +736,17 @@ entities: number[]
refCount: number
```
+## AssetScope — class @experimental
+```
+@internal leases: () => readonly AssetLease[]
+add: <T>(lease: AssetLease<T>) => AssetLease<T>
+forget: (lease: AssetLease) => boolean
+releaseAll: () => void
+size: number
+static new (): AssetScope
+static prototype: AssetScope
+```
+
## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
@@ -746,8 +765,12 @@ ResourceDef<AssetsClass>
## AssetsData — type @beta
```
+@internal releaseTextureLease: (lease: AssetRefLease<number>) => void
@internal releaseTyped: (type: string, ref: string) => void
+@internal releaseTypedLease: (type: string, lease: AssetRefLease<unknown>) => void
@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+acquireTexture: (ref: string) => Promise<AssetLease<TextureResult>>
+acquireTyped: <T>(type: string, ref: string) => Promise<AssetLease<T>>
applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
backend: Backend
baseUrl: string | undefined
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index c93826c0a..45a84a772 100644
--- a/sdk/etc/index.node.api.md
+++ b/sdk/etc/index.node.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/index.node
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 113 public · 84 beta · 1502 experimental · 3 deprecated
+Symbols: 113 public · 84 beta · 1504 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -677,6 +677,14 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
+## AssetLease — interface @experimental
+```
+generation: number
+key: string
+release: () => void
+value: T
+```
+
## AssetPlugin — class @experimental
```
build: (app: App) => void
@@ -723,6 +731,17 @@ entities: number[]
refCount: number
```
+## AssetScope — class @experimental
+```
+@internal leases: () => readonly AssetLease[]
+add: <T>(lease: AssetLease<T>) => AssetLease<T>
+forget: (lease: AssetLease) => boolean
+releaseAll: () => void
+size: number
+static new (): AssetScope
+static prototype: AssetScope
+```
+
## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
@@ -741,8 +760,12 @@ ResourceDef<AssetsClass>
## AssetsData — type @beta
```
+@internal releaseTextureLease: (lease: AssetRefLease<number>) => void
@internal releaseTyped: (type: string, ref: string) => void
+@internal releaseTypedLease: (type: string, lease: AssetRefLease<unknown>) => void
@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+acquireTexture: (ref: string) => Promise<AssetLease<TextureResult>>
+acquireTyped: <T>(type: string, ref: string) => Promise<AssetLease<T>>
applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
backend: Backend
baseUrl: string | undefined
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index 0b610f463..564695e1e 100644
--- a/sdk/etc/minigame.api.md
+++ b/sdk/etc/minigame.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/minigame
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 113 public · 82 beta · 1524 experimental · 3 deprecated
+Symbols: 113 public · 82 beta · 1526 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -677,6 +677,14 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
+## AssetLease — interface @experimental
+```
+generation: number
+key: string
+release: () => void
+value: T
+```
+
## AssetPlugin — class @experimental
```
build: (app: App) => void
@@ -723,6 +731,17 @@ entities: number[]
refCount: number
```
+## AssetScope — class @experimental
+```
+@internal leases: () => readonly AssetLease[]
+add: <T>(lease: AssetLease<T>) => AssetLease<T>
+forget: (lease: AssetLease) => boolean
+releaseAll: () => void
+size: number
+static new (): AssetScope
+static prototype: AssetScope
+```
+
## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
@@ -741,8 +760,12 @@ ResourceDef<AssetsClass>
## AssetsData — type @beta
```
+@internal releaseTextureLease: (lease: AssetRefLease<number>) => void
@internal releaseTyped: (type: string, ref: string) => void
+@internal releaseTypedLease: (type: string, lease: AssetRefLease<unknown>) => void
@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+acquireTexture: (ref: string) => Promise<AssetLease<TextureResult>>
+acquireTyped: <T>(type: string, ref: string) => Promise<AssetLease<T>>
applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
backend: Backend
baseUrl: string | undefined
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index 9e5e590a9..29f12921d 100644
--- a/sdk/etc/wechat.api.md
+++ b/sdk/etc/wechat.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/wechat
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 113 public · 82 beta · 1514 experimental · 3 deprecated
+Symbols: 113 public · 82 beta · 1516 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -677,6 +677,14 @@ profiles: Record<string, BuildProfile> | undefined
version: string
```
+## AssetLease — interface @experimental
+```
+generation: number
+key: string
+release: () => void
+value: T
+```
+
## AssetPlugin — class @experimental
```
build: (app: App) => void
@@ -723,6 +731,17 @@ entities: number[]
refCount: number
```
+## AssetScope — class @experimental
+```
+@internal leases: () => readonly AssetLease[]
+add: <T>(lease: AssetLease<T>) => AssetLease<T>
+forget: (lease: AssetLease) => boolean
+releaseAll: () => void
+size: number
+static new (): AssetScope
+static prototype: AssetScope
+```
+
## AssetTypeEntry — interface @experimental
```
addressableType: AddressableAssetType | null
@@ -741,8 +760,12 @@ ResourceDef<AssetsClass>
## AssetsData — type @beta
```
+@internal releaseTextureLease: (lease: AssetRefLease<number>) => void
@internal releaseTyped: (type: string, ref: string) => void
+@internal releaseTypedLease: (type: string, lease: AssetRefLease<unknown>) => void
@internal sizes: () => { textureCached: number; pendingLoads: number; refCounts: number; refRows: number; genericCaches: number; genericCached: number; handlePaths: number; invalidateListeners: number; registryEntries: number; trackedRefRows: number; }
+acquireTexture: (ref: string) => Promise<AssetLease<TextureResult>>
+acquireTyped: <T>(type: string, ref: string) => Promise<AssetLease<T>>
applyUpdate: (onProgress?: (loaded: number, total: number) => void) => Promise<ApplyUpdateResult>
backend: Backend
baseUrl: string | undefined
diff --git a/sdk/src/asset/Assets.ts b/sdk/src/asset/Assets.ts
index 514e0d121..dc9ee2208 100644
--- a/sdk/src/asset/Assets.ts
+++ b/sdk/src/asset/Assets.ts
@@ -1406,8 +1406,9 @@ export class Assets {
}
/**
- * Give back one texture acquisition by its receipt — exact even when
- * `invalidate()` left two generations of the same path live.
+ * @internal Give back one texture acquisition by its receipt — exact even
+ * when `invalidate()` left two generations of the same path live. Callers
+ * hold an {@link AssetLease} and use its `release()`.
*/
releaseTextureLease(lease: AssetRefLease<number>): void {
const dropped = this.textureRefs_.release(lease);
@@ -1497,8 +1498,8 @@ export class Assets {
}
/**
- * Give back one typed acquisition by its receipt — exact even when
- * `invalidate()` left two generations of the same path live.
+ * @internal The typed twin of {@link releaseTextureLease}; callers use the
+ * lease's own `release()`.
*/
releaseTypedLease(type: string, lease: AssetRefLease<unknown>): void {
const dropped = this.genericRefs_.release(lease);