Replaced AddToGC w/ GCBehavior Flags

Author: DigiWorm0

LevelImposter/AssetLoader/AudioLoader.cs

@@ -5,7 +5,7 @@
 
 namespace LevelImposter.AssetLoader;
 
-public class AudioLoader : AsyncQueue<LoadableAudio, AudioClip>
+public class AudioLoader : AsyncQueue<LoadableAudio, LoadedAudioClip>
 {
     private AudioLoader()
     {
@@ -22,8 +22,6 @@ public static void LoadAsync(Guid? assetID, Action<AudioClip> onLoad)
     {
         if (assetID == null)
             return;
-
-            
 
         // Get Data Store from AssetDB
         var soundDataStore = GameConfiguration.CurrentMap?.mapAssetDB?.Get(assetID);
@@ -34,11 +32,12 @@ public static void LoadAsync(Guid? assetID, Action<AudioClip> onLoad)
         var loadableAudio = new LoadableAudio(assetID?.ToString() ?? "", soundDataStore);
 
         // Enqueue Loadable
-        Instance.AddToQueue(loadableAudio, onLoad);
+        Instance.AddToQueue(loadableAudio, loadedAudioClip => onLoad(loadedAudioClip.AudioClip));
     }
 
-    protected override AudioClip Load(LoadableAudio loadable)
+    protected override LoadedAudioClip Load(LoadableAudio loadable)
     {
-        return WAVLoader.Load(loadable.DataStore, loadable.ID);
+        var audioClip = WAVLoader.Load(loadable.DataStore, loadable.ID);
+        return new LoadedAudioClip(audioClip);
     }
 }

LevelImposter/AssetLoader/FileContainers/GIFFile.cs

@@ -41,7 +41,7 @@ public enum FrameDisposalMethod
 
     // Other Data
     private Color[]? _pixelBuffer; // Buffer of pixel colors
-    private bool _addToGC = true;
+    private GCBehavior? _gcBehavior;
 
     // GIF File
     public bool IsLoaded { get; private set; }
@@ -88,13 +88,13 @@ public static bool IsGIF(byte[] data)
     ///     Loads the GIF file from a given stream.
     /// </summary>
     /// <param name="dataStream">Stream of raw GIF data</param>
-    /// <param name="addToGC">Whether to handle texture garbage collection automatically</param>
-    public void Load(Stream dataStream, bool addToGC = true)
+    /// <param name="gcBehavior">Garbage collection behavior for the loaded textures</param>
+    public void Load(Stream dataStream, GCBehavior? gcBehavior = null)
     {
         using var reader = new BinaryReader(dataStream);
 
         IsLoaded = false;
-        _addToGC = addToGC;
+        _gcBehavior = gcBehavior;
         ReadHeader(reader);
         ReadDescriptor(reader);
         ReadGlobalColorTable(reader);
@@ -573,8 +573,7 @@ public void RenderFrame(int frameIndex)
             texture.Apply(false, true); // Remove from CPU memory
 
             // Add to GC
-            if (_addToGC)
-                GCHandler.Register(texture);
+            GCHandler.Register(texture, _gcBehavior);
 
             // Handle frame disposal
             switch (frame.DisposalMethod)

LevelImposter/AssetLoader/Loadables/LoadableAudio.cs

@@ -2,8 +2,16 @@
 
 namespace LevelImposter.AssetLoader;
 
-public readonly struct LoadableAudio(string id, IDataStore dataStore) : ICachable
+public readonly struct LoadableAudio(string id, IDataStore dataStore) : IIdentifiable
 {
     public string ID => id;
     public IDataStore DataStore => dataStore;
+    public AudioOptions Options { get; } = new();
+
+    public class AudioOptions
+    {
+        /// Changes how and when the texture is disposed of. 
+        /// <c>null</c> will use <see cref="GCHandler"/>'s current default behavior.
+        public GCBehavior? GCBehavior { get; set; } = null;
+    }
 }

LevelImposter/AssetLoader/Loadables/LoadableSprite.cs

@@ -1,8 +1,9 @@
-using UnityEngine;
+using LevelImposter.Core;
+using UnityEngine;
 
 namespace LevelImposter.AssetLoader;
 
-public readonly struct LoadableSprite(string id, LoadableTexture tex) : ICachable
+public readonly struct LoadableSprite(string id, LoadableTexture tex) : IIdentifiable
 {
     public string ID => id;
     public LoadableTexture Texture => tex;
@@ -16,9 +17,9 @@ public class SpriteOptions
         /// If set, defines the portion of the texture to use for the sprite. Otherwise, the full texture is used.
         public Rect? Frame { get; set; }
 
-        /// If true (default), the sprite will be disposed automatically after the map is unloaded.
-        /// If false, you must manage the sprite's lifecycle manually.
-        public bool AddToGC { get; set; } = true;
+        /// Changes how and when the texture is disposed of. 
+        /// <c>null</c> will use <see cref="GCHandler"/>'s current default behavior.
+        public GCBehavior? GCBehavior { get; set; } = null;
     }
 
     /// <summary>

LevelImposter/AssetLoader/Loadables/LoadableTexture.cs

@@ -1,12 +1,8 @@
-using System;
-using Il2CppInterop.Runtime.InteropTypes.Arrays;
-using Il2CppSystem.IO;
-using LevelImposter.Core;
-using UnityEngine;
+using LevelImposter.Core;
 
 namespace LevelImposter.AssetLoader;
 
-public readonly struct LoadableTexture(string id, IDataStore dataStore) : ICachable
+public readonly struct LoadableTexture(string id, IDataStore dataStore) : IIdentifiable
 {
     public string ID => id;
     public IDataStore DataStore => dataStore;
@@ -16,10 +12,10 @@ public class TextureOptions
     {
         /// If true, the texture will use pixel art filtering (point filtering)
         public bool PixelArt { get; set; } = false;
-        
-        /// If true (default), the texture will be disposed automatically after the map is unloaded.
-        /// If false, you must manage the texture's lifecycle manually.
-        public bool AddToGC { get; set; } = true;
+
+        /// Changes how and when the texture is disposed of. 
+        /// <c>null</c> will use <see cref="GCHandler"/>'s current default behavior.
+        public GCBehavior? GCBehavior { get; set; } = null;
     }
 
     /// <summary>

LevelImposter/AssetLoader/Loadables/LoadedAudioClip.cs

@@ -0,0 +1,13 @@
+using System;
+using LevelImposter.Core;
+using UnityEngine;
+
+namespace LevelImposter.AssetLoader;
+
+public class LoadedAudioClip(AudioClip audioClip) : ICachable
+{
+    public AudioClip AudioClip => audioClip;
+    public bool IsExpired => audioClip == null;
+    
+    public static implicit operator AudioClip(LoadedAudioClip loadedAudioClip) => loadedAudioClip.AudioClip;
+}

LevelImposter/AssetLoader/Loadables/LoadedSprite.cs

@@ -4,10 +4,11 @@
 
 namespace LevelImposter.AssetLoader;
 
-public class LoadedSprite(Sprite sprite, LoadedTexture texture)
+public class LoadedSprite(Sprite sprite, LoadedTexture texture) : ICachable
 {
     public Sprite Sprite => sprite;
     public LoadedTexture Texture => texture;
-    
+    public bool IsExpired => sprite == null || texture.IsExpired;
+
     public static implicit operator Sprite(LoadedSprite loadedSprite) => loadedSprite.Sprite;
 }

LevelImposter/AssetLoader/Loadables/LoadedTexture.cs

@@ -4,9 +4,10 @@
 
 namespace LevelImposter.AssetLoader;
 
-public class LoadedTexture(Texture2D texture)
+public class LoadedTexture(Texture2D texture) : ICachable
 {
     public Texture2D Texture => texture;
+    public bool IsExpired => texture == null;
 
     public static implicit operator Texture2D(LoadedTexture loadedTexture) => loadedTexture.Texture;
 }

LevelImposter/AssetLoader/Loaders/DDSLoader.cs

@@ -153,8 +153,7 @@ private static Texture2D ImageDataToTexture2D(
         texture.Apply(false, true);
 
         // Register in GC
-        if (options?.AddToGC ?? true)
-            GCHandler.Register(texture);
+        GCHandler.Register(texture, options?.GCBehavior);
 
         return texture;
     }

LevelImposter/AssetLoader/Loaders/GIFLoader.cs

@@ -13,20 +13,16 @@ public static class GIFLoader
     /// <returns>A fully-loaded GIFFile containing the image data</returns>
     public static LoadedGIFTexture Load(LoadableTexture loadable)
     {
-        // Get whether to add to GC
-        var addToGC = loadable.Options?.AddToGC ?? true;
-        
         // Create new file
         var gifFile = new GIFFile(loadable.ID);
-        if (addToGC)
-            GCHandler.Register(gifFile);
+        GCHandler.Register(gifFile, loadable.Options.GCBehavior);
 
         // Load data into managed memory
         var imgData = loadable.DataStore.LoadToManagedMemory();
 
         // Load the GIF file from the stream
         using var imgStream = new MemoryStream(imgData);
-        gifFile.Load(imgStream, addToGC);
+        gifFile.Load(imgStream, loadable.Options.GCBehavior);
 
         // Return the GIF file
         return new LoadedGIFTexture(gifFile);