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.

feat(water): the surface mirrors the world, and ripples, surf and foam behave on calm water

yhh2283be79cd4f
diff --git a/docs/astro/src/data/components.generated.json b/docs/astro/src/data/components.generated.json
index b5625b5be..42ddc7466 100644
--- a/docs/astro/src/data/components.generated.json
+++ b/docs/astro/src/data/components.generated.json
@@ -1734,6 +1734,13 @@
"default": "100000",
"doc": "The highest world height plants grow at."
},
+ {
+ "key": "waterDepth",
+ "type": "number",
+ "default": "0",
+ "doc": "How deep under water a plant may stand. 0 keeps them on dry ground; reeds stand in the shallows.",
+ "range": "≥ 0"
+ },
{
"key": "bladeHeight",
"type": "number",
@@ -1807,6 +1814,7 @@
"minUp",
"heightMin",
"heightMax",
+ "waterDepth",
"bladeHeight",
"bladeWidth",
"lodDistance",
@@ -5336,6 +5344,20 @@
"doc": "Samples along each side of the noise ground.",
"range": "17–2049, step 1"
},
+ {
+ "key": "warp",
+ "type": "number",
+ "default": "0",
+ "doc": "How far the noise is bent by noise of its own: winding valleys and bent ridges instead of round hills.",
+ "range": "0–1, step 0.01"
+ },
+ {
+ "key": "erosion",
+ "type": "number",
+ "default": "0",
+ "doc": "How much rain wears the ground (a heightmap's too): gullies down the slopes, silt in the valleys, and dirt painted where the water ran. 0 leaves it as made.",
+ "range": "0–4, step 0.05"
+ },
{
"key": "rockSlope",
"type": "number",
@@ -5395,6 +5417,8 @@
"persistence",
"ridged",
"resolution",
+ "warp",
+ "erosion",
"rockSlope",
"dirtHeight",
"snowHeight",
diff --git a/sdk/etc/foliage.api.md b/sdk/etc/foliage.api.md
index 4c4a28297..308d248b7 100644
--- a/sdk/etc/foliage.api.md
+++ b/sdk/etc/foliage.api.md
@@ -48,6 +48,7 @@ minUp: number
seed: number
sizeX: number
sizeZ: number
+waterDepth: number
```
## FoliageField — class @experimental
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index bc0e82491..106b123d9 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: 115 public · 159 beta · 1746 experimental · 3 deprecated
+Symbols: 115 public · 159 beta · 1756 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -1485,6 +1485,12 @@ sky: SkySpec | SkyRadiance | undefined
texelsPerUnit: number | undefined
```
+## BakeProgress — interface @experimental
+```
+label: string
+progress: number
+```
+
## BakeResult — interface @experimental
```
lumels: number
@@ -1539,6 +1545,23 @@ samples: number
texelsPerUnit: number
```
+## Bakes — class @experimental
+```
+active: BakeProgress[]
+budgetMs: number
+clear: (owner: object) => void
+mark: (owner: object, label: string, progress: number) => void
+run: <T>(label: string, job: WorkJob<T>) => { done: Promise<T>; cancel: () => void; }
+step: (now?: () => number) => void
+static new (): Bakes
+static prototype: Bakes
+```
+
+## BakesRes — const @experimental
+```
+ResourceDef<Bakes>
+```
+
## BatchBreak — enum @experimental
```
Blend = 4
@@ -3741,6 +3764,21 @@ name: string
visible: boolean | undefined
```
+## Eroded — interface @experimental
+```
+field: Heightfield
+flow: Float32Array<ArrayBufferLike>
+```
+
+## ErosionParams — interface @experimental
+```
+amount: number
+height: number
+seed: number
+sizeX: number
+sizeZ: number
+```
+
## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
@@ -4082,6 +4120,7 @@ minUp: number
seed: number
sizeX: number
sizeZ: number
+waterDepth: number
```
## FoliageField — class @experimental
@@ -6949,6 +6988,7 @@ persistence: number
resolution: number
ridged: number
seed: number
+warp: number | undefined
```
## ProcessedEntity — interface @experimental
@@ -9542,6 +9582,7 @@ chunkCells: number
chunks: number
detail: number
dirtHeight: number
+erosion: number
frequency: number
height: number
heightmap: number
@@ -9561,6 +9602,7 @@ sizeX: number
sizeZ: number
snowHeight: number
splatmap: number
+warp: number
```
## TerrainPaint — type @experimental
@@ -11248,6 +11290,7 @@ sample: (x: number, z: number) => FieldSample | null
shore: Float32Array<ArrayBufferLike>
swell: Float32Array<ArrayBufferLike>
static bake: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => WaterField
+static baking: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => Generator<number, WaterField, void>
static new (grid: ZoneGrid, ocean: ZoneOcean | null): WaterField
static prototype: WaterField
```
@@ -11307,8 +11350,11 @@ waveSpeed: number
@internal app_: App | null
@internal field_: WaterField | null
@internal instance_: number
+@internal revision_: number
@internal ripples_: RippleField | null
@internal zone_: WaterZoneData
+baking: boolean
+depthAt: (x: number, z: number, y: number) => number | null
disturb: (x: number, y: number, z: number, radius: number, strength: number) => boolean
heightAt: (x: number, z: number) => number | null
quality: WaterQuality
@@ -11453,6 +11499,11 @@ tabIndex: number | undefined
(component: AnyComponentDef): FilterExpr
```
+## WorkJob — type @experimental
+```
+Generator<number, T, void>
+```
+
## World — class @public
```
@internal addressOfComponent: (component: AnyComponentDef, entity: Entity) => number | undefined
@@ -12026,6 +12077,11 @@ AudioPlugin
(scene: BakeScene): (job: BakeJob, from: number, to: number) => void
```
+## bakesOf — function @experimental
+```
+(app: App): Bakes
+```
+
## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
@@ -12876,6 +12932,16 @@ DragPlugin
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
+## erodeHeightfield — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Eroded
+```
+
+## erosionJob — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Generator<number, Eroded, void>
+```
+
## error — function @experimental
```
(category: string, message: string, data?: unknown): void
@@ -12976,6 +13042,11 @@ EventBindingPlugin
(report: DiagnosticReport): string
```
+## finish — function @experimental
+```
+<T>(job: WorkJob<T>): T
+```
+
## flatSky — function @experimental
```
(colour: readonly [number, number, number]): SkyRadiance
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index 26d918fbb..75731a905 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: 115 public · 164 beta · 1765 experimental · 3 deprecated
+Symbols: 115 public · 164 beta · 1775 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -1485,6 +1485,12 @@ sky: SkySpec | SkyRadiance | undefined
texelsPerUnit: number | undefined
```
+## BakeProgress — interface @experimental
+```
+label: string
+progress: number
+```
+
## BakeResult — interface @experimental
```
lumels: number
@@ -1539,6 +1545,23 @@ samples: number
texelsPerUnit: number
```
+## Bakes — class @experimental
+```
+active: BakeProgress[]
+budgetMs: number
+clear: (owner: object) => void
+mark: (owner: object, label: string, progress: number) => void
+run: <T>(label: string, job: WorkJob<T>) => { done: Promise<T>; cancel: () => void; }
+step: (now?: () => number) => void
+static new (): Bakes
+static prototype: Bakes
+```
+
+## BakesRes — const @experimental
+```
+ResourceDef<Bakes>
+```
+
## BatchBreak — enum @experimental
```
Blend = 4
@@ -3749,6 +3772,21 @@ name: string
visible: boolean | undefined
```
+## Eroded — interface @experimental
+```
+field: Heightfield
+flow: Float32Array<ArrayBufferLike>
+```
+
+## ErosionParams — interface @experimental
+```
+amount: number
+height: number
+seed: number
+sizeX: number
+sizeZ: number
+```
+
## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
@@ -4090,6 +4128,7 @@ minUp: number
seed: number
sizeX: number
sizeZ: number
+waterDepth: number
```
## FoliageField — class @experimental
@@ -7152,6 +7191,7 @@ persistence: number
resolution: number
ridged: number
seed: number
+warp: number | undefined
```
## ProcessedEntity — interface @experimental
@@ -9755,6 +9795,7 @@ chunkCells: number
chunks: number
detail: number
dirtHeight: number
+erosion: number
frequency: number
height: number
heightmap: number
@@ -9774,6 +9815,7 @@ sizeX: number
sizeZ: number
snowHeight: number
splatmap: number
+warp: number
```
## TerrainPaint — type @experimental
@@ -11461,6 +11503,7 @@ sample: (x: number, z: number) => FieldSample | null
shore: Float32Array<ArrayBufferLike>
swell: Float32Array<ArrayBufferLike>
static bake: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => WaterField
+static baking: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => Generator<number, WaterField, void>
static new (grid: ZoneGrid, ocean: ZoneOcean | null): WaterField
static prototype: WaterField
```
@@ -11520,8 +11563,11 @@ waveSpeed: number
@internal app_: App | null
@internal field_: WaterField | null
@internal instance_: number
+@internal revision_: number
@internal ripples_: RippleField | null
@internal zone_: WaterZoneData
+baking: boolean
+depthAt: (x: number, z: number, y: number) => number | null
disturb: (x: number, y: number, z: number, radius: number, strength: number) => boolean
heightAt: (x: number, z: number) => number | null
quality: WaterQuality
@@ -11666,6 +11712,11 @@ tabIndex: number | undefined
(component: AnyComponentDef): FilterExpr
```
+## WorkJob — type @experimental
+```
+Generator<number, T, void>
+```
+
## World — class @public
```
@internal addressOfComponent: (component: AnyComponentDef, entity: Entity) => number | undefined
@@ -12254,6 +12305,11 @@ AudioPlugin
(scene: BakeScene): (job: BakeJob, from: number, to: number) => void
```
+## bakesOf — function @experimental
+```
+(app: App): Bakes
+```
+
## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
@@ -13129,6 +13185,16 @@ DragPlugin
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
+## erodeHeightfield — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Eroded
+```
+
+## erosionJob — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Generator<number, Eroded, void>
+```
+
## error — function @experimental
```
(category: string, message: string, data?: unknown): void
@@ -13229,6 +13295,11 @@ EventBindingPlugin
(report: DiagnosticReport): string
```
+## finish — function @experimental
+```
+<T>(job: WorkJob<T>): T
+```
+
## flatSky — function @experimental
```
(colour: readonly [number, number, number]): SkyRadiance
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index 26cd55b4c..b96f26734 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: 115 public · 161 beta · 1745 experimental · 3 deprecated
+Symbols: 115 public · 161 beta · 1755 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1480,6 +1480,12 @@ sky: SkySpec | SkyRadiance | undefined
texelsPerUnit: number | undefined
```
+## BakeProgress — interface @experimental
+```
+label: string
+progress: number
+```
+
## BakeResult — interface @experimental
```
lumels: number
@@ -1534,6 +1540,23 @@ samples: number
texelsPerUnit: number
```
+## Bakes — class @experimental
+```
+active: BakeProgress[]
+budgetMs: number
+clear: (owner: object) => void
+mark: (owner: object, label: string, progress: number) => void
+run: <T>(label: string, job: WorkJob<T>) => { done: Promise<T>; cancel: () => void; }
+step: (now?: () => number) => void
+static new (): Bakes
+static prototype: Bakes
+```
+
+## BakesRes — const @experimental
+```
+ResourceDef<Bakes>
+```
+
## BatchBreak — enum @experimental
```
Blend = 4
@@ -3736,6 +3759,21 @@ name: string
visible: boolean | undefined
```
+## Eroded — interface @experimental
+```
+field: Heightfield
+flow: Float32Array<ArrayBufferLike>
+```
+
+## ErosionParams — interface @experimental
+```
+amount: number
+height: number
+seed: number
+sizeX: number
+sizeZ: number
+```
+
## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
@@ -4077,6 +4115,7 @@ minUp: number
seed: number
sizeX: number
sizeZ: number
+waterDepth: number
```
## FoliageField — class @experimental
@@ -6944,6 +6983,7 @@ persistence: number
resolution: number
ridged: number
seed: number
+warp: number | undefined
```
## ProcessedEntity — interface @experimental
@@ -9537,6 +9577,7 @@ chunkCells: number
chunks: number
detail: number
dirtHeight: number
+erosion: number
frequency: number
height: number
heightmap: number
@@ -9556,6 +9597,7 @@ sizeX: number
sizeZ: number
snowHeight: number
splatmap: number
+warp: number
```
## TerrainPaint — type @experimental
@@ -11243,6 +11285,7 @@ sample: (x: number, z: number) => FieldSample | null
shore: Float32Array<ArrayBufferLike>
swell: Float32Array<ArrayBufferLike>
static bake: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => WaterField
+static baking: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => Generator<number, WaterField, void>
static new (grid: ZoneGrid, ocean: ZoneOcean | null): WaterField
static prototype: WaterField
```
@@ -11302,8 +11345,11 @@ waveSpeed: number
@internal app_: App | null
@internal field_: WaterField | null
@internal instance_: number
+@internal revision_: number
@internal ripples_: RippleField | null
@internal zone_: WaterZoneData
+baking: boolean
+depthAt: (x: number, z: number, y: number) => number | null
disturb: (x: number, y: number, z: number, radius: number, strength: number) => boolean
heightAt: (x: number, z: number) => number | null
quality: WaterQuality
@@ -11448,6 +11494,11 @@ tabIndex: number | undefined
(component: AnyComponentDef): FilterExpr
```
+## WorkJob — type @experimental
+```
+Generator<number, T, void>
+```
+
## World — class @public
```
@internal addressOfComponent: (component: AnyComponentDef, entity: Entity) => number | undefined
@@ -12021,6 +12072,11 @@ AudioPlugin
(scene: BakeScene): (job: BakeJob, from: number, to: number) => void
```
+## bakesOf — function @experimental
+```
+(app: App): Bakes
+```
+
## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
@@ -12871,6 +12927,16 @@ DragPlugin
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
+## erodeHeightfield — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Eroded
+```
+
+## erosionJob — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Generator<number, Eroded, void>
+```
+
## error — function @experimental
```
(category: string, message: string, data?: unknown): void
@@ -12971,6 +13037,11 @@ EventBindingPlugin
(report: DiagnosticReport): string
```
+## finish — function @experimental
+```
+<T>(job: WorkJob<T>): T
+```
+
## flatSky — function @experimental
```
(colour: readonly [number, number, number]): SkyRadiance
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index 702504e34..d64ab6bca 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: 115 public · 159 beta · 1767 experimental · 3 deprecated
+Symbols: 115 public · 159 beta · 1777 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1480,6 +1480,12 @@ sky: SkySpec | SkyRadiance | undefined
texelsPerUnit: number | undefined
```
+## BakeProgress — interface @experimental
+```
+label: string
+progress: number
+```
+
## BakeResult — interface @experimental
```
lumels: number
@@ -1534,6 +1540,23 @@ samples: number
texelsPerUnit: number
```
+## Bakes — class @experimental
+```
+active: BakeProgress[]
+budgetMs: number
+clear: (owner: object) => void
+mark: (owner: object, label: string, progress: number) => void
+run: <T>(label: string, job: WorkJob<T>) => { done: Promise<T>; cancel: () => void; }
+step: (now?: () => number) => void
+static new (): Bakes
+static prototype: Bakes
+```
+
+## BakesRes — const @experimental
+```
+ResourceDef<Bakes>
+```
+
## BatchBreak — enum @experimental
```
Blend = 4
@@ -3736,6 +3759,21 @@ name: string
visible: boolean | undefined
```
+## Eroded — interface @experimental
+```
+field: Heightfield
+flow: Float32Array<ArrayBufferLike>
+```
+
+## ErosionParams — interface @experimental
+```
+amount: number
+height: number
+seed: number
+sizeX: number
+sizeZ: number
+```
+
## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
@@ -4077,6 +4115,7 @@ minUp: number
seed: number
sizeX: number
sizeZ: number
+waterDepth: number
```
## FoliageField — class @experimental
@@ -7237,6 +7276,7 @@ persistence: number
resolution: number
ridged: number
seed: number
+warp: number | undefined
```
## ProcessedEntity — interface @experimental
@@ -9830,6 +9870,7 @@ chunkCells: number
chunks: number
detail: number
dirtHeight: number
+erosion: number
frequency: number
height: number
heightmap: number
@@ -9849,6 +9890,7 @@ sizeX: number
sizeZ: number
snowHeight: number
splatmap: number
+warp: number
```
## TerrainPaint — type @experimental
@@ -11542,6 +11584,7 @@ sample: (x: number, z: number) => FieldSample | null
shore: Float32Array<ArrayBufferLike>
swell: Float32Array<ArrayBufferLike>
static bake: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => WaterField
+static baking: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => Generator<number, WaterField, void>
static new (grid: ZoneGrid, ocean: ZoneOcean | null): WaterField
static prototype: WaterField
```
@@ -11601,8 +11644,11 @@ waveSpeed: number
@internal app_: App | null
@internal field_: WaterField | null
@internal instance_: number
+@internal revision_: number
@internal ripples_: RippleField | null
@internal zone_: WaterZoneData
+baking: boolean
+depthAt: (x: number, z: number, y: number) => number | null
disturb: (x: number, y: number, z: number, radius: number, strength: number) => boolean
heightAt: (x: number, z: number) => number | null
quality: WaterQuality
@@ -11747,6 +11793,11 @@ tabIndex: number | undefined
(component: AnyComponentDef): FilterExpr
```
+## WorkJob — type @experimental
+```
+Generator<number, T, void>
+```
+
## World — class @public
```
@internal addressOfComponent: (component: AnyComponentDef, entity: Entity) => number | undefined
@@ -12320,6 +12371,11 @@ AudioPlugin
(scene: BakeScene): (job: BakeJob, from: number, to: number) => void
```
+## bakesOf — function @experimental
+```
+(app: App): Bakes
+```
+
## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
@@ -13175,6 +13231,16 @@ DragPlugin
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
+## erodeHeightfield — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Eroded
+```
+
+## erosionJob — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Generator<number, Eroded, void>
+```
+
## error — function @experimental
```
(category: string, message: string, data?: unknown): void
@@ -13275,6 +13341,11 @@ EventBindingPlugin
(report: DiagnosticReport): string
```
+## finish — function @experimental
+```
+<T>(job: WorkJob<T>): T
+```
+
## flatSky — function @experimental
```
(colour: readonly [number, number, number]): SkyRadiance
diff --git a/sdk/etc/terrain.api.md b/sdk/etc/terrain.api.md
index 56bc8f3c6..df9098432 100644
--- a/sdk/etc/terrain.api.md
+++ b/sdk/etc/terrain.api.md
@@ -1,7 +1,22 @@
# API surface — esengine/terrain
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 0 public · 0 beta · 19 experimental · 0 deprecated
+Symbols: 0 public · 0 beta · 23 experimental · 0 deprecated
+
+## Eroded — interface @experimental
+```
+field: Heightfield
+flow: Float32Array<ArrayBufferLike>
+```
+
+## ErosionParams — interface @experimental
+```
+amount: number
+height: number
+seed: number
+sizeX: number
+sizeZ: number
+```
## Heightfield — interface @experimental
```
@@ -18,6 +33,7 @@ persistence: number
resolution: number
ridged: number
seed: number
+warp: number | undefined
```
## Terrain — const @experimental
@@ -31,6 +47,7 @@ chunkCells: number
chunks: number
detail: number
dirtHeight: number
+erosion: number
frequency: number
height: number
heightmap: number
@@ -50,6 +67,7 @@ sizeX: number
sizeZ: number
snowHeight: number
splatmap: number
+warp: number
```
## TerrainPaint — type @experimental
@@ -110,6 +128,16 @@ ResourceDef<Terrains>
(shape: TerrainShape, cx: number, cz: number): [number, number]
```
+## erodeHeightfield — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Eroded
+```
+
+## erosionJob — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Generator<number, Eroded, void>
+```
+
## heightfieldFromPixels — function @experimental
```
(width: number, height: number, pixels: ArrayLike<number>): Heightfield
diff --git a/sdk/etc/water.api.md b/sdk/etc/water.api.md
index a5159e105..9bedf08b7 100644
--- a/sdk/etc/water.api.md
+++ b/sdk/etc/water.api.md
@@ -126,6 +126,7 @@ sample: (x: number, z: number) => FieldSample | null
shore: Float32Array<ArrayBufferLike>
swell: Float32Array<ArrayBufferLike>
static bake: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => WaterField
+static baking: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => Generator<number, WaterField, void>
static new (grid: ZoneGrid, ocean: ZoneOcean | null): WaterField
static prototype: WaterField
```
@@ -185,8 +186,11 @@ waveSpeed: number
@internal app_: App | null
@internal field_: WaterField | null
@internal instance_: number
+@internal revision_: number
@internal ripples_: RippleField | null
@internal zone_: WaterZoneData
+baking: boolean
+depthAt: (x: number, z: number, y: number) => number | null
disturb: (x: number, y: number, z: number, radius: number, strength: number) => boolean
heightAt: (x: number, z: number) => number | null
quality: WaterQuality
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index fb609ec68..b271af70c 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: 115 public · 159 beta · 1758 experimental · 3 deprecated
+Symbols: 115 public · 159 beta · 1768 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1480,6 +1480,12 @@ sky: SkySpec | SkyRadiance | undefined
texelsPerUnit: number | undefined
```
+## BakeProgress — interface @experimental
+```
+label: string
+progress: number
+```
+
## BakeResult — interface @experimental
```
lumels: number
@@ -1534,6 +1540,23 @@ samples: number
texelsPerUnit: number
```
+## Bakes — class @experimental
+```
+active: BakeProgress[]
+budgetMs: number
+clear: (owner: object) => void
+mark: (owner: object, label: string, progress: number) => void
+run: <T>(label: string, job: WorkJob<T>) => { done: Promise<T>; cancel: () => void; }
+step: (now?: () => number) => void
+static new (): Bakes
+static prototype: Bakes
+```
+
+## BakesRes — const @experimental
+```
+ResourceDef<Bakes>
+```
+
## BatchBreak — enum @experimental
```
Blend = 4
@@ -3736,6 +3759,21 @@ name: string
visible: boolean | undefined
```
+## Eroded — interface @experimental
+```
+field: Heightfield
+flow: Float32Array<ArrayBufferLike>
+```
+
+## ErosionParams — interface @experimental
+```
+amount: number
+height: number
+seed: number
+sizeX: number
+sizeZ: number
+```
+
## EventBinding — const @experimental
```
ComponentDef<EventBindingData>
@@ -4077,6 +4115,7 @@ minUp: number
seed: number
sizeX: number
sizeZ: number
+waterDepth: number
```
## FoliageField — class @experimental
@@ -6951,6 +6990,7 @@ persistence: number
resolution: number
ridged: number
seed: number
+warp: number | undefined
```
## ProcessedEntity — interface @experimental
@@ -9544,6 +9584,7 @@ chunkCells: number
chunks: number
detail: number
dirtHeight: number
+erosion: number
frequency: number
height: number
heightmap: number
@@ -9563,6 +9604,7 @@ sizeX: number
sizeZ: number
snowHeight: number
splatmap: number
+warp: number
```
## TerrainPaint — type @experimental
@@ -11250,6 +11292,7 @@ sample: (x: number, z: number) => FieldSample | null
shore: Float32Array<ArrayBufferLike>
swell: Float32Array<ArrayBufferLike>
static bake: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => WaterField
+static baking: (grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround) => Generator<number, WaterField, void>
static new (grid: ZoneGrid, ocean: ZoneOcean | null): WaterField
static prototype: WaterField
```
@@ -11309,8 +11352,11 @@ waveSpeed: number
@internal app_: App | null
@internal field_: WaterField | null
@internal instance_: number
+@internal revision_: number
@internal ripples_: RippleField | null
@internal zone_: WaterZoneData
+baking: boolean
+depthAt: (x: number, z: number, y: number) => number | null
disturb: (x: number, y: number, z: number, radius: number, strength: number) => boolean
heightAt: (x: number, z: number) => number | null
quality: WaterQuality
@@ -11479,6 +11525,11 @@ tabIndex: number | undefined
(component: AnyComponentDef): FilterExpr
```
+## WorkJob — type @experimental
+```
+Generator<number, T, void>
+```
+
## World — class @public
```
@internal addressOfComponent: (component: AnyComponentDef, entity: Entity) => number | undefined
@@ -12052,6 +12103,11 @@ AudioPlugin
(scene: BakeScene): (job: BakeJob, from: number, to: number) => void
```
+## bakesOf — function @experimental
+```
+(app: App): Bakes
+```
+
## bind — function @experimental
```
<C extends object, K extends keyof C>(world: World, entity: Entity, component: ComponentDef<C>, field: K, source: ReadonlySignal<C[K]>): () => void
@@ -12902,6 +12958,16 @@ DragPlugin
(obj: Record<string, unknown>, only?: readonly string[]): ReadonlyArray<{ label: string; value: number; }>
```
+## erodeHeightfield — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Eroded
+```
+
+## erosionJob — function @experimental
+```
+(field: Heightfield, p: ErosionParams): Generator<number, Eroded, void>
+```
+
## error — function @experimental
```
(category: string, message: string, data?: unknown): void
@@ -13002,6 +13068,11 @@ EventBindingPlugin
(report: DiagnosticReport): string
```
+## finish — function @experimental
+```
+<T>(job: WorkJob<T>): T
+```
+
## flatSky — function @experimental
```
(colour: readonly [number, number, number]): SkyRadiance
diff --git a/sdk/src/water/waterPlugin.ts b/sdk/src/water/waterPlugin.ts
index 7397d3fab..20e04ccc8 100644
--- a/sdk/src/water/waterPlugin.ts
+++ b/sdk/src/water/waterPlugin.ts
@@ -30,6 +30,7 @@ import { TextureContent } from '../wasm';
import { TerrainsRes } from '../terrain/terrainPlugin';
import { BlendMode } from '../render/blend';
import { log } from '../util/logger';
+import { bakesOf } from '../runtime/bakes';
import type { Entity } from '../types';
import { surfHeight, waveHeight, waveSlope, type WaveParams } from './waves';
import { buildOceanMesh, oceanReach, oceanSnap } from './waterMesh';
@@ -138,6 +139,16 @@ export class Waters {
ripples_: RippleField | null = null;
/** The material instance the surface is drawn with, for what draws the same water (the underwater effect). @internal */
instance_ = 0;
+ /** Bumped each time a new bake lands, so what is placed by the water (plants kept out of it) knows to place again. @internal */
+ revision_ = 0;
+ /** Whether a bake is in hand: what is placed by the water waits for it. */
+ baking = false;
+
+ /** How deep the water stands at rest over the world height `y` at (x, z): above zero under water, null where there is none. */
+ depthAt(x: number, z: number, y: number): number | null {
+ const s = this.field_?.sample(x, z);
+ return s ? s.height - y : null;
+ }
/**
* The surface over or under `(x, y, z)`: how far above it the point is (negative under), the surface's normal, the current, and the point
@@ -310,6 +321,8 @@ export class WaterPlugin implements Plugin {
private key_ = '';
private surface_: Surface | null = null;
private epoch_ = 0;
+ /** The bake in hand, for the inputs `key` names; the field drawn until it lands is the last one baked. */
+ private baking_: { key: string; cancel: () => void } | null = null;
build(app: App): void {
const waters = new Waters();
@@ -325,16 +338,32 @@ export class WaterPlugin implements Plugin {
const inputs = this.gather(app);
waters.zone_ = inputs.zone;
if (inputs.bodies.length === 0) {
+ this.baking_?.cancel();
+ this.baking_ = null;
+ waters.baking = false;
waters.field_ = null;
this.key_ = '';
this.dropRipples();
this.dropSurface(app);
return;
}
- if (inputs.key !== this.key_ || !waters.field_) {
- this.key_ = inputs.key;
- waters.field_ = WaterField.bake(inputs.grid, inputs.bodies, this.ground(app));
+ if (inputs.key !== this.key_ && this.baking_?.key !== inputs.key) {
+ // A big zone is a second or more of work: it is spread over frames and shown while it runs.
+ this.baking_?.cancel();
+ const key = inputs.key;
+ const job = bakesOf(app).run('Baking the water', WaterField.baking(inputs.grid, inputs.bodies, this.ground(app)));
+ this.baking_ = { key, cancel: job.cancel };
+ waters.baking = true;
+ void job.done.then((field) => {
+ if (this.baking_?.key !== key) return;
+ this.baking_ = null;
+ waters.baking = false;
+ this.key_ = key;
+ waters.field_ = field;
+ waters.revision_++;
+ }, (e) => { log.error('water', 'baking the water failed', e); });
}
+ if (!waters.field_) return;
const eye = this.eye(app);
this.ripple(app, inputs.zone, eye, app.getResource(Time).delta);
if (!app.hasResource(Assets)) return;
@@ -345,6 +374,9 @@ export class WaterPlugin implements Plugin {
cleanup(app?: App): void {
if (!app?.hasResource(WatersRes)) return;
+ this.baking_?.cancel();
+ this.baking_ = null;
+ app.getResource(WatersRes).baking = false;
this.dropRipples();
this.dropSurface(app);
const waters = app.getResource(WatersRes);
diff --git a/sdk/src/water/waterShader.ts b/sdk/src/water/waterShader.ts
index f72f47e89..9aa3d6bb6 100644
--- a/sdk/src/water/waterShader.ts
+++ b/sdk/src/water/waterShader.ts
@@ -149,7 +149,9 @@ vec2 waterSurf(float shore, float height, float time) {
float env = shoal * runUp;
// It breaks in the inner third: the crest whitens, and the water behind it stays white a while.
float breaking = 1.0 - smoothstep(reach * 0.15, reach * 0.4, shore);
- float white = breaking * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
+ // A wave breaks only when it is steep for its length: a lake's small surf laps, the sea's breaks white.
+ float steep = smoothstep(0.012, 0.045, height / u_surfLength);
+ float white = breaking * steep * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
return vec2(height * g * g * env, white);
}
void esMaterialVertex(inout vec3 local, inout vec3 localNormal, in vec2 uv) {
@@ -225,7 +227,8 @@ fn waterSurf(shore : f32, height : f32, time : f32) -> vec2f {
if (shore < 0.0) { runUp = 1.0 - smoothstep(0.0, 1.0, -shore / (reach * 0.2)); }
let env = shoal * runUp;
let breaking = 1.0 - smoothstep(reach * 0.15, reach * 0.4, shore);
- let white = breaking * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
+ let steep = smoothstep(0.012, 0.045, height / mc.u_surfLength);
+ let white = breaking * steep * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
return vec2f(height * g * g * env, white);
}
fn esMaterialVertex(local : ptr<function, vec3f>, localNormal : ptr<function, vec3f>, uv : vec2f) {
@@ -351,7 +354,9 @@ vec2 waterSurf(float shore, float height, float time) {
float env = shoal * runUp;
// It breaks in the inner third: the crest whitens, and the water behind it stays white a while.
float breaking = 1.0 - smoothstep(reach * 0.15, reach * 0.4, shore);
- float white = breaking * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
+ // A wave breaks only when it is steep for its length: a lake's small surf laps, the sea's breaks white.
+ float steep = smoothstep(0.012, 0.045, height / u_surfLength);
+ float white = breaking * steep * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
return vec2(height * g * g * env, white);
}
/// The first directional light that shines: xyz is where it stands in the sky, w 1 if there is one, color its colour and strength, tiles its place in the shadow atlas.
@@ -406,7 +411,9 @@ vec4 waterReflect(vec3 p, vec3 r, float eyeDist) {
float qDist = u_camera.w > 0.5 ? length(q - u_camera.xyz) : -dot(q, u_camera.xyz);
float sceneDist = textureLod(u_sceneDepthMap, uv, 0.0).r;
// The ray has gone behind something the picture holds: that is what it met, if it did not skip clean through a thin one.
- if (sceneDist < qDist && qDist - sceneDist < stride * 2.0 + 1.0) return vec4(textureLod(u_sceneColor, uv, 0.0).rgb, 1.0);
+ // Fading toward the picture's edge: a reflection that runs off screen thins away instead of stopping on a line.
+ vec2 edge = min(uv, 1.0 - uv);
+ if (sceneDist < qDist && qDist - sceneDist < stride * 2.0 + 1.0) return vec4(textureLod(u_sceneColor, uv, 0.0).rgb, smoothstep(0.0, 0.08, min(edge.x, edge.y)));
stride *= 1.25;
travelled += stride;
}
@@ -465,8 +472,11 @@ void main() {
float ripL = texture(u_rippleMap, ripUv - vec2(ripStep.x, 0.0)).r, ripR = texture(u_rippleMap, ripUv + vec2(ripStep.x, 0.0)).r;
float ripD = texture(u_rippleMap, ripUv - vec2(0.0, ripStep.y)).r, ripU = texture(u_rippleMap, ripUv + vec2(0.0, ripStep.y)).r;
bool ripIn = u_rippleOn > 0.5 && u_waveSpace > 0.5 && all(greaterThanEqual(ripUv, vec2(0.0))) && all(lessThanEqual(ripUv, vec2(1.0)));
- vec2 ripSlope = ripIn ? vec2(ripR - ripL, ripU - ripD) * u_rippleRange / ripCell : vec2(0.0);
- float ripFoam = ripIn ? ripC.g : 0.0;
+ // The window follows the camera: its edge fades out, so where it ends the ripples thin away instead of stopping on a line.
+ vec2 ripEdge = min(ripUv, 1.0 - ripUv);
+ float ripFade = smoothstep(0.0, 0.15, min(ripEdge.x, ripEdge.y));
+ vec2 ripSlope = ripIn ? vec2(ripR - ripL, ripU - ripD) * u_rippleRange / ripCell * ripFade : vec2(0.0);
+ float ripFoam = ripIn ? ripC.g * ripFade : 0.0;
float crest;
vec2 slope;
if (dot(flow, flow) > 1e-6) {
@@ -562,6 +572,8 @@ void main() {
float onCrest = u_foamCrest > 0.0 ? smoothstep(1.0 - 0.3 * u_foamCrest, 1.0, crest) * smoothstep(0.35, 0.75, breakup) : 0.0;
float surfFoam = surf.y * smoothstep(0.15, 0.6, breakup + surf.y * 0.4);
float foam = clamp(max(max(max(shore, onCrest * u_foamCrest), ripFoam * (0.55 + 0.45 * breakup)), surfFoam), 0.0, 1.0);
+ // Foam floats on top: from under the water it is a thin shadow on the light, not a white sheet.
+ if (below) foam *= 0.2;
SurfaceExt ext = surfaceExtNone(N);
ext.misc.x = 0.0204;
@@ -581,13 +593,20 @@ void main() {
vec3 mirror = vec3(0.0);
if (below && fresnel > 0.02 && haveColor && haveDepth && u_mirror > 0.5) {
vec4 met = waterReflect(P, reflect(-viewDir, N), waterDist);
- mirror = met.a > 0.5 ? met.rgb : mix(u_shallowColor.rgb, u_deepColor.rgb, 0.5) * 0.25;
+ mirror = mix(mix(u_shallowColor.rgb, u_deepColor.rgb, 0.5) * 0.25, met.rgb, met.a);
}
seen += mirror * fresnel * (1.0 - foam);
+ vec3 color = lit + seen;
+ // From above, what the surface mirrors is the world as well as the sky: the reflected ray followed through the picture. Where it meets
+ // something on screen that takes the reflected share's place; where it leaves the screen, the sky the lighting gave stays.
+ if (!below && fresnel > 0.03 && haveColor && haveDepth && u_mirror > 0.5) {
+ vec4 met = waterReflect(P, reflect(-viewDir, N), waterDist);
+ color = mix(color, met.rgb, met.a * fresnel * (1.0 - foam) * 0.9);
+ }
// Past the shore there is no water, but for the surf running up dry ground (where the ground is no lower than the water: the depth test
// then cuts it where the ground rises above it).
if (shoreDist < 0.0 && (surf.x <= 0.0 || shoreDepth > 1e-3)) discard;
- fragColor = vec4(lit + seen, haveColor ? 1.0 : 0.85);
+ fragColor = vec4(color, haveColor ? 1.0 : 0.85);
#ifdef ES_GBUFFER
// 0.72: a surface, and water (see readSurface): what lands on it is the water's, not a wet floor's.
fragSurface = vec4(packNormal(normalize(N)), roughness, 0.72);
@@ -698,7 +717,8 @@ fn waterSurf(shore : f32, height : f32, time : f32) -> vec2f {
if (shore < 0.0) { runUp = 1.0 - smoothstep(0.0, 1.0, -shore / (reach * 0.2)); }
let env = shoal * runUp;
let breaking = 1.0 - smoothstep(reach * 0.15, reach * 0.4, shore);
- let white = breaking * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
+ let steep = smoothstep(0.012, 0.045, height / mc.u_surfLength);
+ let white = breaking * steep * max(smoothstep(0.75, 1.0, g), (1.0 - smoothstep(0.0, 0.35, u)) * 0.8) * env;
return vec2f(height * g * g * env, white);
}
struct WaterSun { dir : vec4f, color : vec4f, tiles : vec2i };
@@ -754,7 +774,8 @@ fn waterReflect(p : vec3f, r : vec3f, eyeDist : f32) -> vec4f {
var qDist = -dot(q, frame.camera.xyz);
if (frame.camera.w > 0.5) { qDist = length(q - frame.camera.xyz); }
let sceneDist = textureSampleLevel(u_sceneDepthMap, u_sceneDepthMap_s, uv, 0.0).r;
- if (sceneDist < qDist && qDist - sceneDist < stride * 2.0 + 1.0) { return vec4f(textureSampleLevel(u_sceneColor, u_sceneColor_s, uv, 0.0).rgb, 1.0); }
+ let edge = min(uv, vec2f(1.0) - uv);
+ if (sceneDist < qDist && qDist - sceneDist < stride * 2.0 + 1.0) { return vec4f(textureSampleLevel(u_sceneColor, u_sceneColor_s, uv, 0.0).rgb, smoothstep(0.0, 0.08, min(edge.x, edge.y))); }
stride = stride * 1.25;
travelled = travelled + stride;
}
@@ -827,7 +848,9 @@ fn waterSurface(p : vec2f, time : f32, dist : f32, amp : f32, calm : f32) -> vec
let ripIn = mc.u_rippleOn > 0.5 && mc.u_waveSpace > 0.5 && all(ripUv >= vec2f(0.0)) && all(ripUv <= vec2f(1.0));
var ripSlope = vec2f(0.0);
var ripFoam = 0.0;
- if (ripIn) { ripSlope = vec2f(ripR - ripL, ripU - ripD) * mc.u_rippleRange / ripCell; ripFoam = ripC.g; }
+ let ripEdge = min(ripUv, vec2f(1.0) - ripUv);
+ let ripFade = smoothstep(0.0, 0.15, min(ripEdge.x, ripEdge.y));
+ if (ripIn) { ripSlope = vec2f(ripR - ripL, ripU - ripD) * mc.u_rippleRange / ripCell * ripFade; ripFoam = ripC.g * ripFade; }
var surface = vec3f(0.0);
if (dot(flow, flow) > 1e-6) {
// A current: two copies of the surface carried downstream a cycle at a time, each fading in as the other fades out.
@@ -914,7 +937,8 @@ fn waterSurface(p : vec2f, time : f32, dist : f32, amp : f32, calm : f32) -> vec
var onCrest = 0.0;
if (mc.u_foamCrest > 0.0) { onCrest = smoothstep(1.0 - 0.3 * mc.u_foamCrest, 1.0, waves.crest) * smoothstep(0.35, 0.75, breakup); }
let surfFoam = surf.y * smoothstep(0.15, 0.6, breakup + surf.y * 0.4);
- let foam = clamp(max(max(max(shore, onCrest * mc.u_foamCrest), ripFoam * (0.55 + 0.45 * breakup)), surfFoam), 0.0, 1.0);
+ var foam = clamp(max(max(max(shore, onCrest * mc.u_foamCrest), ripFoam * (0.55 + 0.45 * breakup)), surfFoam), 0.0, 1.0);
+ if (below) { foam = foam * 0.2; }
var ext = surfaceExtNone(N);
ext.misc.x = 0.0204;
@@ -932,19 +956,24 @@ fn waterSurface(p : vec2f, time : f32, dist : f32, amp : f32, calm : f32) -> vec
var mirror = vec3f(0.0);
if (below && fresnel > 0.02 && haveColor && haveDepth && mc.u_mirror > 0.5) {
let met = waterReflect(P, reflect(-viewDir, N), waterDist);
- if (met.w > 0.5) { mirror = met.xyz; } else { mirror = mix(mc.u_shallowColor.rgb, mc.u_deepColor.rgb, vec3f(0.5)) * 0.25; }
+ mirror = mix(mix(mc.u_shallowColor.rgb, mc.u_deepColor.rgb, vec3f(0.5)) * 0.25, met.xyz, vec3f(met.w));
}
seen = seen + mirror * fresnel * (1.0 - foam);
+ var color = lit + seen;
+ if (!below && fresnel > 0.03 && haveColor && haveDepth && mc.u_mirror > 0.5) {
+ let met = waterReflect(P, reflect(-viewDir, N), waterDist);
+ color = mix(color, met.xyz, met.w * fresnel * (1.0 - foam) * 0.9);
+ }
var alpha = 0.85;
if (haveColor) { alpha = 1.0; }
if (shoreDist < 0.0 && (surf.x <= 0.0 || shoreDepth > 1e-3)) { discard; }
#ifdef ES_GBUFFER
var frag : FragOut;
- frag.color = vec4f(lit + seen, alpha);
+ frag.color = vec4f(color, alpha);
frag.surface = vec4f(packNormal(normalize(N)), roughness, 0.72);
return frag;
#else
- return vec4f(lit + seen, alpha);
+ return vec4f(color, alpha);
#endif
}
#pragma end
diff --git a/sdk/src/water/zone.ts b/sdk/src/water/zone.ts
index 0257a0d4e..060031556 100644
--- a/sdk/src/water/zone.ts
+++ b/sdk/src/water/zone.ts
@@ -177,6 +177,15 @@ export class WaterField {
* surface's vertices there (which the shore cuts away) do not pull the water's edge down to nothing.
*/
static bake(grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround): WaterField {
+ const job = WaterField.baking(grid, bodies, ground);
+ for (;;) {
+ const next = job.next();
+ if (next.done) return next.value;
+ }
+ }
+
+ /** {@link WaterField.bake} as a job that yields its progress (0 to 1) every few rows, for spreading over frames. */
+ static *baking(grid: ZoneGrid, bodies: readonly ZoneBody[], ground?: ZoneGround): Generator<number, WaterField, void> {
const ocean = (bodies.find((b) => b.kind === 'ocean') as ZoneOcean | undefined) ?? null;
const field = new WaterField(grid, ocean);
const texel = Math.max(grid.sizeX / Math.max(grid.nx - 1, 1), grid.sizeZ / Math.max(grid.nz - 1, 1));
@@ -184,6 +193,7 @@ export class WaterField {
const bounded = bodies.filter((b) => b.kind !== 'ocean') as (ZoneLake | ZoneRiver)[];
const boxes = bounded.map((b) => boundsOf(b));
for (let j = 0; j < grid.nz; j++) {
+ if (j % 16 === 0) yield 0.8 * (j / grid.nz);
for (let i = 0; i < grid.nx; i++) {
const k = j * grid.nx + i;
const x = grid.minX + (i / Math.max(grid.nx - 1, 1)) * grid.sizeX;
@@ -227,8 +237,8 @@ export class WaterField {
field.depth[k] = g === null ? DEEP : Math.max(0, (w > 0 ? h / w : 0) - g);
}
}
- levelShore(field, texel);
- fillDry(field);
+ yield* levelShore(field, texel);
+ yield* fillDry(field);
return field;
}
@@ -373,7 +383,7 @@ function boundsOf(body: ZoneLake | ZoneRiver): [number, number, number, number]
* texels on either side of an edge keep it, held to a texel, and every other texel is that plus how far it is from the nearest of them
* (each texel carries its nearest edge texel, two sweeps).
*/
-function levelShore(field: WaterField, texel: number): void {
+function* levelShore(field: WaterField, texel: number): Generator<number, void, void> {
const { nx, nz, sizeX, sizeZ } = field.grid;
const n = nx * nz;
if (nx < 2 || nz < 2) return;
@@ -382,6 +392,7 @@ function levelShore(field: WaterField, texel: number): void {
const seed = new Int32Array(n).fill(-1);
const offset = new Float32Array(n);
const dist = new Float32Array(n).fill(Infinity);
+ yield 0.85;
for (let j = 0; j < nz; j++) for (let i = 0; i < nx; i++) {
const k = j * nx + i, w = wet(k);
const edge = (i > 0 && wet(k - 1) !== w) || (i < nx - 1 && wet(k + 1) !== w) || (j > 0 && wet(k - nx) !== w) || (j < nz - 1 && wet(k + nx) !== w);
@@ -397,11 +408,13 @@ function levelShore(field: WaterField, texel: number): void {
const d = Math.hypot(ex, ez) + offset[s]!;
if (d < dist[k]!) { dist[k] = d; seed[k] = s; }
};
+ yield 0.85;
for (let j = 0; j < nz; j++) for (let i = 0; i < nx; i++) {
const k = j * nx + i;
if (i > 0) relax(k, k - 1);
if (j > 0) { relax(k, k - nx); if (i > 0) relax(k, k - nx - 1); if (i < nx - 1) relax(k, k - nx + 1); }
}
+ yield 0.92;
for (let j = nz - 1; j >= 0; j--) for (let i = nx - 1; i >= 0; i--) {
const k = j * nx + i;
if (i < nx - 1) relax(k, k + 1);
@@ -414,7 +427,7 @@ function levelShore(field: WaterField, texel: number): void {
}
/** A texel no body holds takes the height of the nearest that one does: two passes of a chamfer sweep over which texel is nearest. */
-function fillDry(field: WaterField): void {
+function* fillDry(field: WaterField): Generator<number, void, void> {
const { nx, nz } = field.grid;
const n = nx * nz;
const src = new Int32Array(n).fill(-1);
@@ -425,6 +438,7 @@ function fillDry(field: WaterField): void {
dist[k] = dist[from]! + step;
src[k] = src[from]!;
};
+ yield 0.85;
for (let j = 0; j < nz; j++) for (let i = 0; i < nx; i++) {
const k = j * nx + i;
if (i > 0) relax(k, k - 1, 1);
@@ -432,6 +446,7 @@ function fillDry(field: WaterField): void {
if (i > 0 && j > 0) relax(k, k - nx - 1, Math.SQRT2);
if (i < nx - 1 && j > 0) relax(k, k - nx + 1, Math.SQRT2);
}
+ yield 0.92;
for (let j = nz - 1; j >= 0; j--) for (let i = nx - 1; i >= 0; i--) {
const k = j * nx + i;
if (i < nx - 1) relax(k, k + 1, 1);