Noah Petherbridge
93623e4e8a
Especially to further optimize memory for large levels, Levels and
Doodads can now read and write to a ZIP file format on disk with
chunks in external files within the zip.
Existing doodads and levels can still load as normal, and will be
converted into ZIP files on the next save:
* The Chunker.ChunkMap which used to hold ALL chunks in the main json/gz
file, now becomes the cache of "hot chunks" loaded from ZIP. If there is
a ZIP file, chunks not accessed recently are flushed from the ChunkMap
to save on memory.
* During save, the ChunkMap is flushed to ZIP along with any non-loaded
chunks from a previous zipfile. So legacy levels "just work" when
saving, and levels loaded FROM Zip will manage their ChunkMap hot
memory more carefully.
Memory savings observed on "Azulian Tag - Forest.level":
* Before: 1716 MB was loaded from the old level format into RAM along
with a slow load screen.
* After: only 243 MB memory was used by the game and it loaded with
a VERY FAST load screen.
Updates to the F3 Debug Overlay:
* "Chunks: 20 in 45 out 20 cached" shows the count of chunks inside the
viewport (having bitmaps and textures loaded) vs. chunks outside which
have their textures freed (but data kept), and the number of chunks
currently hot cached in the ChunkMap.
The `doodad` tool has new commands to "touch" your existing levels
and doodads, to upgrade them to the new format (or you can simply
open and re-save them in-game):
doodad edit-level --touch ./example.level
doodad edit-doodad --touch ./example.doodad
The output from that and `doodad show` should say "File format: zipfile"
in the headers section.
To do:
* File attachments should also go in as ZIP files, e.g. wallpapers
91 lines
2.3 KiB
Go
91 lines
2.3 KiB
Go
package uix
|
|
|
|
import (
|
|
"runtime"
|
|
"sync"
|
|
|
|
"git.kirsle.net/apps/doodle/pkg/balance"
|
|
"git.kirsle.net/apps/doodle/pkg/level"
|
|
"git.kirsle.net/apps/doodle/pkg/log"
|
|
"git.kirsle.net/apps/doodle/pkg/shmem"
|
|
"git.kirsle.net/go/render"
|
|
)
|
|
|
|
// Memory optimization features of the Canvas.
|
|
|
|
/*
|
|
LoadUnloadChunks optimizes memory for (level) canvases by warming up chunk images
|
|
that fall within the LoadingViewport and freeing chunks that are outside of it.
|
|
*/
|
|
func (w *Canvas) LoadUnloadChunks() {
|
|
if w.level == nil || shmem.Tick%balance.CanvasLoadUnloadModuloTicks != 0 || !balance.Feature.LoadUnloadChunk {
|
|
return
|
|
}
|
|
|
|
var (
|
|
vp = w.LoadingViewport()
|
|
chunks = make(chan render.Point)
|
|
chunksInside = map[render.Point]interface{}{}
|
|
chunksTeardown = []*level.Chunk{}
|
|
cores = runtime.NumCPU()
|
|
wg sync.WaitGroup
|
|
|
|
// Collect metrics for the debug overlay.
|
|
resultInside int
|
|
resultOutside int
|
|
)
|
|
|
|
// Collect the chunks that are inside the viewport so we know which ones are not.
|
|
for chunk := range w.level.Chunker.IterViewportChunks(vp) {
|
|
chunksInside[chunk] = nil
|
|
}
|
|
|
|
// Spawn background goroutines to process the chunks quickly.
|
|
for i := 0; i < cores; i++ {
|
|
wg.Add(1)
|
|
go func(i int) {
|
|
for coord := range chunks {
|
|
if _, ok := chunksInside[coord]; ok {
|
|
// This chunk is INSIDE our viewport, preload its bitmap.
|
|
if chunk, ok := w.level.Chunker.GetChunk(coord); ok {
|
|
_ = chunk.CachedBitmap(render.Invisible)
|
|
resultInside++
|
|
continue
|
|
}
|
|
}
|
|
|
|
// Chunks outside the viewport, we won't load them and
|
|
// the Chunker will flush them out to (zip) file.
|
|
resultOutside++
|
|
}
|
|
wg.Done()
|
|
}(i)
|
|
}
|
|
|
|
for chunk := range w.level.Chunker.IterChunks() {
|
|
chunks <- chunk
|
|
}
|
|
close(chunks)
|
|
wg.Wait()
|
|
|
|
// Tear down the SDL2 textures of chunks to free.
|
|
for i, chunk := range chunksTeardown {
|
|
if chunk == nil {
|
|
log.Error("LoadUnloadChunks: chunksTeardown#%d was nil??", i)
|
|
continue
|
|
}
|
|
|
|
chunk.Teardown()
|
|
}
|
|
|
|
// Export the metrics for the debug overlay.
|
|
w.loadUnloadInside = resultInside
|
|
w.loadUnloadOutside = resultOutside
|
|
}
|
|
|
|
// LoadUnloadMetrics returns the canvas's stored metrics from the LoadUnloadChunks
|
|
// function, for the debug overlay.
|
|
func (w *Canvas) LoadUnloadMetrics() (inside, outside int) {
|
|
return w.loadUnloadInside, w.loadUnloadOutside
|
|
}
|