minecraft-renderer 0.1.73 → 0.1.75

package/src/three/tests/signTextureCache.test.ts

@@ -1,11 +1,6 @@
 //@ts-nocheck
 import { test, expect, vi, beforeEach } from 'vitest'
 import * as THREE from 'three'
-import { Vec3 } from 'vec3'
-
-vi.mock('../entity/EntityMesh', () => ({
-  getMesh: vi.fn(),
-}))
 
 const renderSignMock = vi.fn()
 vi.mock('../../sign-renderer', () => ({
@@ -16,25 +11,11 @@ vi.mock('prismarine-chat', () => ({
   default: () => () => ({}),
 }))
 
-import { ChunkMeshManager } from '../chunkMeshManager'
+import { getSignTexture, releaseSignTexture, disposeAllSignTextures } from '../signTextureCache'
 import type { WorldRendererThree } from '../worldRendererThree'
 
-function createManager (): ChunkMeshManager {
-  const scene = new THREE.Scene()
-  const material = new THREE.MeshBasicMaterial()
-  const worldRenderer = {
-    version: '1.20',
-    shaderCubeBlocksEnabled: () => false,
-    getModule: () => undefined,
-    sceneOrigin: {
-      track: () => {},
-      removeAndUntrack: () => {},
-      removeAndUntrackAll: () => {},
-    },
-    blockEntities: {},
-    worldRendererConfig: {},
-  } as unknown as WorldRendererThree
-  return new ChunkMeshManager(worldRenderer, scene, material, 256, 1)
+function createWorldRenderer (): WorldRendererThree {
+  return { version: '1.20' } as WorldRendererThree
 }
 
 function stubCanvas () {
@@ -44,40 +25,80 @@ function stubCanvas () {
 beforeEach(() => {
   renderSignMock.mockReset()
   renderSignMock.mockImplementation(() => stubCanvas())
+  disposeAllSignTextures()
 })
 
-test('getSignTexture: same blockEntity returns cached texture without re-render', () => {
-  const manager = createManager()
-  const signHeadsRenderer = (manager as unknown as { signHeadsRenderer: { getSignTexture: Function } }).signHeadsRenderer
-  const pos = new Vec3(10, 64, 10)
+test('getSignTexture: same content at different positions shares one texture', () => {
+  const wr = createWorldRenderer()
   const blockEntity = { Text1: '{"text":"Hello"}' }
 
-  const tex1 = signHeadsRenderer.getSignTexture(pos, blockEntity, false)
-  const tex2 = signHeadsRenderer.getSignTexture(pos, blockEntity, false)
+  const tex1 = getSignTexture(wr, blockEntity, false)
+  const tex2 = getSignTexture(wr, { ...blockEntity }, false)
 
   expect(tex1).toBeDefined()
   expect(tex2).toBe(tex1)
   expect(renderSignMock).toHaveBeenCalledTimes(1)
+})
+
+test('getSignTexture: different text yields different textures', () => {
+  const wr = createWorldRenderer()
 
-  manager.dispose()
+  const tex1 = getSignTexture(wr, { Text1: '{"text":"Hello"}' }, false)!
+  const tex2 = getSignTexture(wr, { Text1: '{"text":"World"}' }, false)!
+
+  expect(tex2).not.toBe(tex1)
+  expect(renderSignMock).toHaveBeenCalledTimes(2)
 })
 
-test('getSignTexture: changed blockEntity disposes old texture and renders anew', () => {
-  const manager = createManager()
-  const signHeadsRenderer = (manager as unknown as { signHeadsRenderer: { getSignTexture: Function } }).signHeadsRenderer
-  const pos = new Vec3(10, 64, 10)
+test('releaseSignTexture: partial release keeps texture in cache', () => {
+  const wr = createWorldRenderer()
   const blockEntity = { Text1: '{"text":"Hello"}' }
 
-  const tex1 = signHeadsRenderer.getSignTexture(pos, blockEntity, false)!
+  const tex1 = getSignTexture(wr, blockEntity, false)!
+  const tex2 = getSignTexture(wr, blockEntity, false)!
+  expect(tex1).toBe(tex2)
+
   const disposeSpy = vi.spyOn(tex1, 'dispose')
+  releaseSignTexture(tex1)
+
+  expect(disposeSpy).not.toHaveBeenCalled()
+  expect(getSignTexture(wr, blockEntity, false)).toBe(tex1)
+  expect(renderSignMock).toHaveBeenCalledTimes(1)
+})
 
-  const changed = { Text1: '{"text":"World"}' }
-  const tex2 = signHeadsRenderer.getSignTexture(pos, changed, false)
+test('releaseSignTexture: dispose at zero refcount removes cache entry', () => {
+  const wr = createWorldRenderer()
+  const blockEntity = { Text1: '{"text":"Hello"}' }
 
-  expect(tex2).toBeDefined()
-  expect(tex2).not.toBe(tex1)
+  const tex = getSignTexture(wr, blockEntity, false)!
+  const disposeSpy = vi.spyOn(tex, 'dispose')
+
+  releaseSignTexture(tex)
   expect(disposeSpy).toHaveBeenCalledTimes(1)
+
+  const tex2 = getSignTexture(wr, blockEntity, false)!
+  expect(tex2).not.toBe(tex)
   expect(renderSignMock).toHaveBeenCalledTimes(2)
+})
+
+test('getSignTexture: key ignores irrelevant NBT fields', () => {
+  const wr = createWorldRenderer()
+  const base = { Text1: '{"text":"Hello"}', Color: 'black' }
 
-  manager.dispose()
+  const tex1 = getSignTexture(wr, base, false)!
+  const tex2 = getSignTexture(wr, { ...base, GlowingText: 1, is_waxed: 1 }, false)!
+
+  expect(tex2).toBe(tex1)
+  expect(renderSignMock).toHaveBeenCalledTimes(1)
+})
+
+test('getSignTexture: isHanging is part of cache key', () => {
+  const wr = createWorldRenderer()
+  const blockEntity = { Text1: '{"text":"Hello"}' }
+
+  const standing = getSignTexture(wr, blockEntity, false)!
+  const hanging = getSignTexture(wr, blockEntity, true)!
+
+  expect(hanging).not.toBe(standing)
+  expect(renderSignMock).toHaveBeenCalledTimes(2)
 })

package/src/three/worldRendererThree.ts

@@ -2,12 +2,10 @@
 import * as THREE from 'three'
 import { Vec3 } from 'vec3'
 import nbt from 'prismarine-nbt'
-import PrismarineChatLoader from 'prismarine-chat'
 import * as tweenJs from '@tweenjs/tween.js'
 import { Biome } from 'minecraft-data'
-import { renderSign } from '../sign-renderer'
 import { DisplayWorldOptions, GraphicsInitOptions } from '../graphicsBackend/types'
-import { chunkPos, sectionPos } from '../lib/simpleUtils'
+import { sectionPos } from '../lib/simpleUtils'
 import { WorldRendererCommon } from '../lib/worldrendererCommon'
 import { calculateSkyLightSimple } from '../lib/skyLight'
 import { addNewStat, MC_RENDERER_DEBUG_OVERLAY_CLASS } from '../lib/ui/newStats'
@@ -55,8 +53,6 @@ export class WorldRendererThree extends WorldRendererCommon {
   get sectionObjects() {
     return this.chunkMeshManager.sectionObjects
   }
-  chunkTextures = new Map<string, { [pos: string]: THREE.Texture }>()
-  signsCache = new Map<string, any>()
   cameraSectionPos: Vec3 = new Vec3(0, 0, 0)
   holdingBlock: IHoldingBlock
   holdingBlockLeft: IHoldingBlock
@@ -355,6 +351,11 @@ export class WorldRendererThree extends WorldRendererCommon {
     return targetState
   }
 
+  setRain(enabled: boolean): void {
+    this.worldRendererConfig.isRaining = enabled
+    this.toggleModule('rain', enabled)
+  }
+
   /**
    * Dispose all modules
    */
@@ -696,7 +697,7 @@ export class WorldRendererThree extends WorldRendererCommon {
     this.syncSkyLevelFromTime(newTime)
   }
 
-  private syncSkyLevelFromTime (timeOfDay: number): void {
+  private syncSkyLevelFromTime(timeOfDay: number): void {
     const skyLevel = calculateSkyLightSimple(timeOfDay) / 15
     this.chunkMeshManager.setSkyLevel(skyLevel)
   }
@@ -792,10 +793,6 @@ export class WorldRendererThree extends WorldRendererCommon {
     }
   }
 
-  override updateViewerPosition(pos: Vec3): void {
-    this.viewerChunkPosition = pos
-  }
-
   cameraSectionPositionUpdate() {
     // eslint-disable-next-line guard-for-in
     for (const key in this.sectionObjects) {
@@ -928,28 +925,6 @@ export class WorldRendererThree extends WorldRendererCommon {
   }
 
 
-  getSignTexture(position: Vec3, blockEntity, isHanging, backSide = false) {
-    const chunk = chunkPos(position)
-    let textures = this.chunkTextures.get(`${chunk[0]},${chunk[1]}`)
-    if (!textures) {
-      textures = {}
-      this.chunkTextures.set(`${chunk[0]},${chunk[1]}`, textures)
-    }
-    const texturekey = `${position.x},${position.y},${position.z}`
-    // todo investigate bug and remove this so don't need to clean in section dirty
-    if (textures[texturekey]) return textures[texturekey]
-
-    const PrismarineChat = PrismarineChatLoader(this.version)
-    const canvas = renderSign(blockEntity, isHanging, PrismarineChat)
-    if (!canvas) return
-    const tex = new THREE.Texture(canvas)
-    tex.magFilter = THREE.NearestFilter
-    tex.minFilter = THREE.NearestFilter
-    tex.needsUpdate = true
-    textures[texturekey] = tex
-    return tex
-  }
-
   getCameraPosition(target?: THREE.Vector3): THREE.Vector3 {
     return (target ?? this._tmpCameraPos).set(this.cameraWorldPos.x, this.cameraWorldPos.y, this.cameraWorldPos.z)
   }
@@ -1442,49 +1417,6 @@ export class WorldRendererThree extends WorldRendererCommon {
     }
   }
 
-  renderSign(position: Vec3, rotation: number, isWall: boolean, isHanging: boolean, blockEntity) {
-    const tex = this.getSignTexture(position, blockEntity, isHanging)
-
-    if (!tex) return
-
-    // todo implement
-    // const key = JSON.stringify({ position, rotation, isWall })
-    // if (this.signsCache.has(key)) {
-    //   console.log('cached', key)
-    // } else {
-    //   this.signsCache.set(key, tex)
-    // }
-
-    const mesh = new THREE.Mesh(new THREE.PlaneGeometry(1, 1), new THREE.MeshBasicMaterial({ map: tex, transparent: true }))
-    mesh.renderOrder = 999
-
-    const lineHeight = 7 / 16
-    const scaleFactor = isHanging ? 1.3 : 1
-    mesh.scale.set(1 * scaleFactor, lineHeight * scaleFactor, 1 * scaleFactor)
-
-    const thickness = (isHanging ? 2 : 1.5) / 16
-    const wallSpacing = 0.25 / 16
-    if (isWall && !isHanging) {
-      mesh.position.set(0, 0, -0.5 + thickness + wallSpacing + 0.0001)
-    } else {
-      mesh.position.set(0, 0, thickness / 2 + 0.0001)
-    }
-
-    const group = new THREE.Group()
-    group.rotation.set(
-      0,
-      -THREE.MathUtils.degToRad(rotation * (isWall ? 90 : 45 / 2)),
-      0
-    )
-    group.add(mesh)
-    const height = (isHanging ? 10 : 8) / 16
-    const heightOffset = (isHanging ? 0 : isWall ? 4.333 : 9.333) / 16
-    const textPosition = height / 2 + heightOffset
-    this.sceneOrigin.track(group)
-    group.position.set(position.x + 0.5, position.y + textPosition, position.z + 0.5)
-    return group
-  }
-
   lightUpdate(chunkX: number, chunkZ: number) {
     // set all sections in the chunk dirty
     for (let y = this.worldSizeParams.minY; y < this.worldSizeParams.worldHeight; y += 16) {
@@ -1534,19 +1466,6 @@ export class WorldRendererThree extends WorldRendererCommon {
     }))
   }
 
-  cleanChunkTextures(x, z) {
-    const textures = this.chunkTextures.get(`${Math.floor(x / 16)},${Math.floor(z / 16)}`) ?? {}
-    for (const key of Object.keys(textures)) {
-      textures[key].dispose()
-      delete textures[key]
-    }
-    // Sign / head textures moved to ChunkMeshManager.signHeadsRenderer in PR
-    // #16; without invalidating that cache here, sign edits (and any other
-    // block-entity NBT change picked up via setSectionDirty) would re-render
-    // with the stale cached canvas until a full world reset.
-    this.chunkMeshManager.cleanSignChunkTextures(x, z)
-  }
-
   readdChunks() {
     for (const key of Object.keys(this.sectionObjects)) {
       this.scene.remove(this.sectionObjects[key])
@@ -1568,7 +1487,6 @@ export class WorldRendererThree extends WorldRendererCommon {
   removeColumn(x, z) {
     super.removeColumn(x, z)
 
-    this.cleanChunkTextures(x, z)
     this.clearPendingSectionUpdatesForChunk(x, z)
     const sectionHeight = this.getSectionHeight()
     const worldMinY = this.worldMinYRender
@@ -1583,7 +1501,7 @@ export class WorldRendererThree extends WorldRendererCommon {
     this.chunkMeshManager.onChunkRemovedFromGate(`${x},${z}`)
   }
 
-  updateViewerPosition(pos: Vec3) {
+  override updateViewerPosition(pos: Vec3) {
     super.updateViewerPosition(pos)
     if (this.chunkMeshManager.pendingNearReveal.size > 0) {
       this.chunkMeshManager.tryRevealPending()

package/src/wasm-mesher/tests/shaderCubeInstances.test.ts

@@ -23,6 +23,12 @@ import { renderWasmOutputToGeometry } from '../bridge/render-from-wasm'
 
 const VERSION = '1.16.5'
 const STONE = 1
+
+function requireShaderCubeResources() {
+  const resources = getShaderCubeResources()
+  if (!resources) throw new Error('shader cube resources unavailable in test')
+  return resources
+}
 /** mc-assets blocksAtlases.json → stone */
 const STONE_ATLAS_TILE_INDEX = 552
 
@@ -39,7 +45,7 @@ test('packWord2: AO diagonal flip sets bit 12', () => {
     light_data: [[1, 1, 1, 1]],
     light_combined: [[255, 255, 255, 255]],
   }
-  const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+  const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
   const model = {
     elements: [{
       faces: {
@@ -78,7 +84,7 @@ test('packWord0: section-local lx/ly/lz and face id', () => {
     light_data: [[0.5, 0.5, 0.5, 0.5]],
     light_combined: [[128, 128, 128, 128]],
   }
-  const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+  const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
   const model = {
     elements: [{
       faces: {
@@ -111,7 +117,7 @@ test('packWord0: section-local lx/ly/lz and face id', () => {
 })
 
 test('isShaderCubeBlock: rejects model rotation and sectionHeight !== 16', () => {
-  const { textureIndexMapping } = getShaderCubeResources()
+  const { textureIndexMapping } = requireShaderCubeResources()
   const baseModel = {
     elements: [{
       faces: {
@@ -222,7 +228,7 @@ test('south face: AO corners remapped to shader order (elemFaces [0,3,1,2] → s
     light_data: [[1, 1, 1, 1]],
     light_combined: [[10, 20, 30, 40]],
   }
-  const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+  const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
   const model = { elements: [{ faces: SIX_FACE_TEXTURES }] }
   tryBuildShaderCubeInstances(
     block,
@@ -248,7 +254,7 @@ test('south face: diagonal flip uses remapped AO (differs from raw elemFaces for
     light_data: [[1, 1, 1, 1]],
     light_combined: [[255, 255, 255, 255]],
   }
-  const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+  const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
   const model = { elements: [{ faces: SIX_FACE_TEXTURES }] }
   const opts = {
     sectionOrigin: { x: 0, y: 0, z: 0 },
@@ -285,7 +291,7 @@ test('doAO false: full bright AO/light and no diagonal flip', () => {
     light_data: [[0, 0, 0, 0]],
     light_combined: [[0, 0, 0, 0]],
   }
-  const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+  const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
   const model = { elements: [{ faces: SIX_FACE_TEXTURES }] }
   tryBuildShaderCubeInstances(
     block,
@@ -329,7 +335,7 @@ test.each(SECTION_ORIGIN_ROUND_TRIP_CASES)(
       light_data: [[1, 1, 1, 1]],
       light_combined: [[255, 255, 255, 255]],
     }
-    const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+    const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
     const model = { elements: [{ faces: SIX_FACE_TEXTURES }] }
     tryBuildShaderCubeInstances(
       block,
@@ -361,7 +367,7 @@ test('section index relative decode past 2^20: exact integer subtract', () => {
     light_data: [[1, 1, 1, 1]],
     light_combined: [[255, 255, 255, 255]],
   }
-  const { textureIndexMapping, tintPalette } = getShaderCubeResources()
+  const { textureIndexMapping, tintPalette } = requireShaderCubeResources()
   const model = { elements: [{ faces: SIX_FACE_TEXTURES }] }
   tryBuildShaderCubeInstances(
     block,