Improved screenshot plugin + screenshot effects in screenshot / after state change fix

source/funkin/Preferences.hx

@@ -199,6 +199,101 @@ class Preferences
   public static var lockedFramerateFunction = untyped js.Syntax.code("window.requestAnimationFrame");
   #end
 
+  /**
+   * If enabled, the game will hide the mouse when taking a screenshot.
+   * @default `true`
+   */
+  public static var shouldHideMouse(get, set):Bool;
+
+  static function get_shouldHideMouse():Bool
+  {
+    return Save?.instance?.options?.screenshot?.shouldHideMouse ?? true;
+  }
+
+  static function set_shouldHideMouse(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.shouldHideMouse = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * If enabled, the game will show a preview after taking a screenshot.
+   * @default `true`
+   */
+  public static var fancyPreview(get, set):Bool;
+
+  static function get_fancyPreview():Bool
+  {
+    return Save?.instance?.options?.screenshot?.fancyPreview ?? true;
+  }
+
+  static function set_fancyPreview(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.fancyPreview = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * If enabled, the game will show the preview only after a screenshot is saved.
+   * @default `true`
+   */
+  public static var previewOnSave(get, set):Bool;
+
+  static function get_previewOnSave():Bool
+  {
+    return Save?.instance?.options?.screenshot?.previewOnSave ?? true;
+  }
+
+  static function set_previewOnSave(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.previewOnSave = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * The game will save any screenshots taken to this format.
+   * @default `PNG`
+   */
+  public static var saveFormat(get, set):Any;
+
+  static function get_saveFormat():Any
+  {
+    return Save?.instance?.options?.screenshot?.saveFormat ?? 'PNG';
+  }
+
+  static function set_saveFormat(value):Any
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.saveFormat = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * The game will save JPEG screenshots with this quality percentage.
+   * @default `80`
+   */
+  public static var jpegQuality(get, set):Int;
+
+  static function get_jpegQuality():Int
+  {
+    return Save?.instance?.options?.screenshot?.jpegQuality ?? 80;
+  }
+
+  static function set_jpegQuality(value:Int):Int
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.jpegQuality = value;
+    save.flush();
+    return value;
+  }
+
   /**
    * Loads the user's preferences from the save data and apply them.
    */

source/funkin/save/Save.hx

@@ -101,6 +101,15 @@ class Save
           audioVisualOffset: 0,
           unlockedFramerate: false,
 
+          screenshot:
+            {
+              shouldHideMouse: true,
+              fancyPreview: true,
+              previewOnSave: true,
+              saveFormat: 'PNG',
+              jpegQuality: 80,
+            },
+
           controls:
             {
               // Leave controls blank so defaults are loaded.
@@ -1357,6 +1366,23 @@ typedef SaveDataOptions =
    */
   var unlockedFramerate:Bool;
 
+  /**
+   * Screenshot options
+   * @param shouldHideMouse Should the mouse be hidden when taking a screenshot? Default: `true`
+   * @param fancyPreview Show a fancy preview? Default: `true`
+   * @param previewOnSave Only show the fancy preview after a screenshot is saved? Default: `true`
+   * @param saveFormat The save format of the screenshot, PNG or JPEG. Default: `PNG`
+   * @param jpegQuality The JPEG Quality, if we're saving to the format. Default: `80`
+   */
+  var screenshot:
+    {
+      var shouldHideMouse:Bool;
+      var fancyPreview:Bool;
+      var previewOnSave:Bool;
+      var saveFormat:String;
+      var jpegQuality:Int;
+    };
+
   var controls:
     {
       var p1:

source/funkin/ui/options/PreferencesMenu.hx

@@ -103,9 +103,10 @@ class PreferencesMenu extends Page
     }, Preferences.downscroll);
     createPrefItemCheckbox('Flashing Lights', 'If disabled, it will dampen flashing effects. Useful for people with photosensitive epilepsy.',
       function(value:Bool):Void {
-        Preferences.flashingLights = value;
-      }, Preferences.flashingLights);
-    createPrefItemCheckbox('Camera Zooms', 'If disabled, camera stops bouncing to the song.', function(value:Bool):Void {
+      Preferences.flashingLights = value;
+      funkin.util.plugins.ScreenshotPlugin.instance.updateFlashColor(); // immediately update the flash color of the screenshot plugin
+    }, Preferences.flashingLights);
+    createPrefItemCheckbox('Camera Zooming on Beat', 'Disable to stop the camera bouncing to the song', function(value:Bool):Void {
       Preferences.zoomCamera = value;
     }, Preferences.zoomCamera);
     createPrefItemCheckbox('Debug Display', 'If enabled, FPS and other debug stats will be displayed.', function(value:Bool):Void {
@@ -116,14 +117,30 @@ class PreferencesMenu extends Page
     }, Preferences.autoPause);
 
     #if web
-    createPrefItemCheckbox('Unlocked Framerate', 'Enable to unlock the framerate', function(value:Bool):Void {
+    createPrefItemCheckbox('Unlocked Framerate', 'If enabled, the framerate will be unlocked.', function(value:Bool):Void {
       Preferences.unlockedFramerate = value;
     }, Preferences.unlockedFramerate);
     #else
-    createPrefItemNumber('FPS', 'The maximum framerate that the game targets', function(value:Float) {
+    createPrefItemNumber('FPS', 'The maximum framerate that the game targets.', function(value:Float) {
       Preferences.framerate = Std.int(value);
     }, null, Preferences.framerate, 30, 300, 5, 0);
     #end
+
+    createPrefItemCheckbox('Hide Mouse', 'If enabled, the mouse will be hidden when taking a screenshot.', function(value:Bool):Void {
+      Preferences.shouldHideMouse = value;
+    }, Preferences.shouldHideMouse);
+    createPrefItemCheckbox('Fancy Preview', 'If enabled, a preview will be shown after taking a screenshot.', function(value:Bool):Void {
+      Preferences.fancyPreview = value;
+    }, Preferences.fancyPreview);
+    createPrefItemCheckbox('Preview on save', 'If enabled, the preview will be shown only after a screenshot is saved.', function(value:Bool):Void {
+      Preferences.previewOnSave = value;
+    }, Preferences.previewOnSave);
+    createPrefItemEnum('Save Format', 'Save screenshots to this format.', ['PNG' => 'PNG', 'JPEG' => 'JPEG'], function(value:String):Void {
+      Preferences.saveFormat = value;
+    }, Preferences.saveFormat);
+    createPrefItemNumber('JPEG Quality', 'The quality of JPEG screenshots.', function(value:Float) {
+      Preferences.jpegQuality = Std.int(value);
+    }, null, Preferences.jpegQuality, 0, 100, 5, 0);
   }
 
   override function update(elapsed:Float):Void