Play GIFs and Play GIFs Unfocused options

Author: WillyJL

CHANGELOG.md

@@ -1,11 +1,14 @@
 ### Added:
-- ASTC Image Compression option:
+- ASTC Image Compression option (#212 by @Willy-JL):
   - Compresses images for instantaneous load times (after first compression which is slower)
   - Potentially less VRAM usage, overall slightly less disk usage on average (if ASTC Replace is also enabled, otherwise files are duplicated)
   - Some GPUs may not be compatible, some others may render images less efficiently like this
-- Unload Images Off-screen option:
+- Unload Images Off-screen option (#212 by @Willy-JL):
   - Saves a lot of VRAM usage by unloading images not currently shown
   - Only recommended together with ASTC Image Compression, otherwise it is very slow
+- Play GIFs and Play GIFs Unfocused options (#212 by @Willy-JL):
+  - Saves a lot of VRAM if completely disabled, no GIFs play and only first frame is loaded
+  - Saves CPU/GPU usage by redrawing less if disabled when unfocused, but still uses same VRAM
 
 ### Updated:
 - Nothing

common/structs.py

@@ -756,6 +756,8 @@ class Settings:
     mark_installed_after_add    : bool
     max_connections             : int
     max_retries                 : int
+    play_gifs                   : bool
+    play_gifs_unfocused         : bool
     proxy_type                  : ProxyType
     proxy_host                  : str
     proxy_port                  : int

external/imagehelper.py

@@ -361,6 +361,8 @@ def astc_compress_one(src_path: pathlib.Path):
                 if duration < 1:
                     duration = 100
                 self.durations.append(duration / 1000)
+                if not globals.settings.play_gifs:
+                    break
             self.animated = len(self.textures) > 1
 
             if self.glob and globals.settings.astc_compression and globals.settings.astc_replace:
@@ -398,6 +400,8 @@ def astc_compress_one(src_path: pathlib.Path):
                 if (duration := frame.info.get("duration", 0)) < 1:
                     duration = 100
                 self.durations.append(duration / 1000)
+                if not globals.settings.play_gifs:
+                    break
             self.animated = len(self.textures) > 1
 
         self.loaded = True
@@ -457,7 +461,7 @@ def texture_id(self):
         if not self.applied:
             return dummy_texture_id()
 
-        if self.animated:
+        if self.animated and globals.settings.play_gifs and (globals.gui.focused or globals.settings.play_gifs_unfocused):
             if self.prev_time != (new_time := imgui.get_time()):
                 self.prev_time = new_time
                 self.elapsed += imgui.get_io().delta_time

modules/db.py

@@ -206,6 +206,8 @@ async def connect():
             "mark_installed_after_add":    f'INTEGER DEFAULT {int(False)}',
             "max_connections":             f'INTEGER DEFAULT 10',
             "max_retries":                 f'INTEGER DEFAULT 2',
+            "play_gifs":                   f'INTEGER DEFAULT {int(True)}',
+            "play_gifs_unfocused":         f'INTEGER DEFAULT {int(False)}',
             "proxy_type":                  f'INTEGER DEFAULT {ProxyType.Disabled}',
             "proxy_host":                  f'TEXT    DEFAULT ""',
             "proxy_port":                  f'INTEGER DEFAULT 8080',

modules/gui.py

@@ -896,6 +896,7 @@ def main_loop(self):
                     # Redraw only when needed
                     draw = (
                         (api.downloads and any(dl.state in (dl.State.Verifying, dl.State.Extracting) for dl in api.downloads.values()))
+                        or (imagehelper.redraw and globals.settings.play_gifs and (self.focused or globals.settings.play_gifs_unfocused))
                         or imgui.io.mouse_wheel or self.input_chars or any(imgui.io.mouse_down) or any(imgui.io.keys_down)
                         or (prev_mouse_pos != mouse_pos and (prev_win_hovered or win_hovered))
                         or prev_scaling != globals.settings.interface_scaling
@@ -906,7 +907,6 @@ def main_loop(self):
                         or prev_hidden != self.hidden
                         or size != self.prev_size
                         or self.recalculate_ids
-                        or imagehelper.redraw
                         or self.new_styles
                         or api.updating
                     )
@@ -4299,6 +4299,18 @@ def cant_install_extension_tooltip():
             if not set.zoom_enabled:
                 imgui.pop_disabled()
 
+            draw_settings_label("Play GIFs:")
+            if draw_settings_checkbox("play_gifs"):
+                for image in imagehelper.ImageHelper.instances:
+                    image.loaded = False
+
+            if not set.play_gifs:
+                imgui.push_disabled()
+            draw_settings_label("Play GIFs unfocused:")
+            draw_settings_checkbox("play_gifs_unfocused")
+            if not set.play_gifs:
+                imgui.pop_disabled()
+
             draw_settings_label(
                 "ASTC compression:",
                 "Compress images using ASTC 6x6/80. Results in dramatically faster image loading and smaller filesize on disk, "