Add sample scripts for loading sprites and textures; update existing samples for clarity and consistency

Author: IvanMurzak

Assets/_PackageRoot/Runtime/ImageLoader.Cache.Memory.cs

@@ -40,19 +40,33 @@ private static void ClearMemoryCacheOnEnterPlayMode()
         /// <param name="replace">replace existed cached sprite if any</param>
         public static void SaveToMemoryCache(string url, Texture2D texture, bool replace = false) => FutureTexture.SaveToMemoryCache(url, texture, replace);
 
+        /// <summary>
+        /// Loads directly from Memory cache if exists and allowed
+        /// </summary>
+        /// <param name="url">URL to the picture, web or local</param>
+        /// <returns>Returns null if not allowed to use Memory cache or if there is no cached Texture2D</returns>
+        public static Reference<Texture2D> LoadTextureRefFromMemoryCache(string url) => FutureTexture.LoadFromMemoryCacheRef(url);
+
         /// <summary>
         /// Loads directly from Memory cache if exists and allowed
         /// </summary>
         /// <param name="url">URL to the picture, web or local</param>
         /// <returns>Returns null if not allowed to use Memory cache or if there is no cached Sprite</returns>
-        public static Reference<Sprite> LoadFromMemoryCacheRef(string url) => FutureSprite.LoadFromMemoryCacheRef(url);
+        public static Reference<Sprite> LoadSpriteRefFromMemoryCache(string url) => FutureSprite.LoadFromMemoryCacheRef(url);
+
+        /// <summary>
+        /// Loads directly from Memory cache if exists and allowed
+        /// </summary>
+        /// <param name="url">URL to the picture, web or local</param>
+        /// <returns>Returns null if not allowed to use Memory cache or if there is no cached Texture2D</returns>
+        public static Texture2D LoadTextureFromMemoryCache(string url) => FutureTexture.LoadFromMemoryCache(url);
 
         /// <summary>
         /// Loads directly from Memory cache if exists and allowed
         /// </summary>
         /// <param name="url">URL to the picture, web or local</param>
         /// <returns>Returns null if not allowed to use Memory cache or if there is no cached Sprite</returns>
-        public static Sprite LoadFromMemoryCache(string url) => FutureSprite.LoadFromMemoryCache(url);
+        public static Sprite LoadSpriteFromMemoryCache(string url) => FutureSprite.LoadFromMemoryCache(url);
 
         /// <summary>
         /// Clear Memory cache for the given url

Assets/_PackageRoot/Samples/Extensions.Unity.ImageLoader.Samples.asmdef

@@ -0,0 +1,16 @@
+{
+    "name": "Extensions.Unity.ImageLoader.Samples",
+    "references": [
+        "UniTask",
+        "Extensions.Unity.ImageLoader"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Assets/_PackageRoot/Samples/Extensions.Unity.ImageLoader.Samples.asmdef.meta

@@ -15,7 +15,7 @@ async void Start()
         // Load image, set image and wait
         await ImageLoader.LoadSprite(imageURL).ThenSet(image);
 
-        // Let's skip waiting for completion.
+        // Skip waiting for completion.
         // To do that we can simply remove 'await' from the start.
         // To avoid compilation warning need to add '.Forget()'.
         ImageLoader.LoadSprite(imageURL).ThenSet(image).Forget();

Assets/_PackageRoot/Samples/SampleAwaitAndForget.cs

@@ -16,7 +16,7 @@ static void OverrideCache()
         ImageLoader.SaveToMemoryCache(url, sprite);
 
         // Take from Memory cache for specific image if exists
-        ImageLoader.LoadFromMemoryCache(url);
+        ImageLoader.LoadSpriteFromMemoryCache(url);
     }
     static void DoesCacheContainImage()
     {
@@ -26,7 +26,7 @@ static void DoesCacheContainImage()
         // Check if Memory cache contains specific image
         ImageLoader.MemoryCacheContains(url);
 
-        // Check if Memory cache contains specific image
+        // Check if Disk cache contains specific image
         ImageLoader.DiskCacheContains(url);
     }
     static void ClearImage()

Assets/_PackageRoot/Samples/SampleCache.cs

@@ -1,4 +1,5 @@
-using Extensions.Unity.ImageLoader;
+using Cysharp.Threading.Tasks;
+using Extensions.Unity.ImageLoader;
 using System.Threading;
 using UnityEngine;
 using UnityEngine.UI;
@@ -30,6 +31,15 @@ void Start()
             .Forget();
     }
 
+    void DestroyWithMonoBehaviour()
+    {
+        ImageLoader.LoadSprite(imageURL)
+            .ThenSet(image)
+            .CancelOnEnable(this)   // cancel on OnEnable event of current MonoBehaviour
+            .CancelOnDisable(this)  // cancel on OnDisable event of current MonoBehaviour
+            .CancelOnDestroy(this); // cancel on OnDestroy event of current MonoBehaviour
+    }
+
     void SimpleCancellation()
     {
         var future = ImageLoader.LoadSprite(imageURL).ThenSet(image);

Assets/_PackageRoot/Samples/SampleCancellation.cs

@@ -4,20 +4,20 @@
 
 public class SampleErrorHandle : MonoBehaviour
 {
-    [SerializeField] string imageURL;
-    [SerializeField] Image image;
+    [SerializeField] string imageURL; // URL of the image to be loaded
+    [SerializeField] Image image; // UI Image component to display the loaded sprite
 
     void Start()
     {
-        ImageLoader.LoadSprite(imageURL) // load sprite
-            .ThenSet(image) // if success set sprite into image
-            .Failed(exception => Debug.LogException(exception)) // if fail print exception
-            .Forget();
+        ImageLoader.LoadSprite(imageURL) // Attempt to load a sprite
+            .ThenSet(image) // If successful, set the sprite to the Image component
+            .Failed(exception => Debug.LogException(exception)) // If an error occurs, log the exception
+            .Forget(); // Forget the task to avoid compilation warning
 
-        ImageLoader.LoadSprite(imageURL) // load sprite
-            .ThenSet(image) // if success set sprite into image
-            .Then(sprite => image.gameObject.SetActive(true)) // if success activate gameObject
-            .Failed(exception => image.gameObject.SetActive(false)) // if fail deactivate gameObject
-            .Forget();
+        ImageLoader.LoadSprite(imageURL) // Attempt to load a sprite
+            .ThenSet(image) // If successful, set the sprite to the Image component
+            .Then(sprite => image.gameObject.SetActive(true)) // If successful, activate the GameObject
+            .Failed(exception => image.gameObject.SetActive(false)) // If an error occurs, deactivate the GameObject
+            .Forget(); // Forget the task to avoid compilation warning
     }
 }

Assets/_PackageRoot/Samples/SampleErrorHandle.cs

@@ -4,12 +4,12 @@
 
 public class SampleLifecycle : MonoBehaviour
 {
-    [SerializeField] string imageURL;
-    [SerializeField] Image image;
+    [SerializeField] string imageURL; // URL of the image to be loaded
+    [SerializeField] Image image; // UI Image component to display the loaded sprite
 
     void Start()
     {
-        ImageLoader.LoadSprite(imageURL) // load sprite
+        ImageLoader.LoadSprite(imageURL) // loading process started
             // ┌──────────────────────────┬────────────────────────────────────────────────────────────────────────┐
             // │ Loading lifecycle events │                                                                        │
             // └──────────────────────────┘                                                                        │

Assets/_PackageRoot/Samples/SampleImageLoading.cs

@@ -0,0 +1,18 @@
+using Extensions.Unity.ImageLoader;
+using UnityEngine;
+using UnityEngine.UI;
+
+public class SampleLoadSpriteThenSetImage : MonoBehaviour
+{
+    [SerializeField] string imageURL; // URL of the image to be loaded
+    [SerializeField] Image image; // UI Image component to display the loaded sprite
+
+    async void Start()
+    {
+        // Load a sprite from the web and cache it for faster loading next time
+        image.sprite = await ImageLoader.LoadSprite(imageURL);
+
+        // Load a sprite from the web and set it directly to the Image component
+        await ImageLoader.LoadSprite(imageURL).ThenSet(image);
+    }
+}