Add resolution scaling

Author: Codas

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.10.0
+
+- Add reduced render scaling option for lighting passes.
+  - By default, only illumination and darkness effects are rendered with reduced resolution. This should have no visible impact at all as illumination passes don't have detailed features anyway.
+- Tweak noise textures for improved fidelity
+- Add option to disable blurred window backgrounds in Application V2
+
 ## 0.9.2
 
 - Update polish translations (thanks @Lioheart)

asset-sources/noise/noise.ptex

@@ -30,12 +30,6 @@
 			"to": "tones_map_3",
 			"to_port": 0
 		},
-		{
-			"from": "tones_map_3",
-			"from_port": 0,
-			"to": "combine",
-			"to_port": 1
-		},
 		{
 			"from": "tones_map",
 			"from_port": 0,
@@ -48,12 +42,6 @@
 			"to": "tones_map_4",
 			"to_port": 0
 		},
-		{
-			"from": "tones_map_4",
-			"from_port": 0,
-			"to": "combine",
-			"to_port": 0
-		},
 		{
 			"from": "fbm3_5",
 			"from_port": 0,
@@ -71,6 +59,18 @@
 			"from_port": 0,
 			"to": "tones_map_5",
 			"to_port": 0
+		},
+		{
+			"from": "tones_map_4",
+			"from_port": 0,
+			"to": "combine",
+			"to_port": 0
+		},
+		{
+			"from": "tones_map_3",
+			"from_port": 0,
+			"to": "combine",
+			"to_port": 1
 		}
 	],
 	"label": "Graph",
@@ -105,7 +105,7 @@
 				"metallic": 0.0,
 				"normal": 1.0,
 				"roughness": 1.0,
-				"size": 12,
+				"size": 12.0,
 				"sss": 1.0
 			},
 			"seed_int": 0,
@@ -132,7 +132,7 @@
 			"parameters": {
 				"folds": 0.0,
 				"iterations": 3.0,
-				"noise": 1,
+				"noise": 1.0,
 				"offset": 0.0,
 				"persistence": 0.5,
 				"scale_x": 3.0,
@@ -303,7 +303,7 @@
 			"parameters": {
 				"folds": 0.0,
 				"iterations": 4.0,
-				"noise": 1,
+				"noise": 1.0,
 				"offset": 0.0,
 				"persistence": 0.5,
 				"scale_x": 3.0,
@@ -333,7 +333,7 @@
 			"parameters": {
 				"folds": 0.0,
 				"iterations": 4.0,
-				"noise": 1,
+				"noise": 1.0,
 				"offset": 0.0,
 				"persistence": 0.5,
 				"scale_x": 20.0,

assets/noise/fbm2_3.avif

@@ -3,7 +3,7 @@
 		"settings": {
 			"optimize-interface-layer-clipping": {
 				"name": "Optimize Token UI Render Batching",
-				"hint": "Optimizes render batching of Token UI elements. No visual degredation expected. Needed in order for the other settings to have a noticable impact."
+				"hint": "Optimizes render batching of Token UI elements. No visual degredation expected. Required in order for the token bars and effects caching settings to have a noticable impact."
 			},
 			"token-bars-caching": {
 				"name": "Cache Token Resource Bars",
@@ -13,6 +13,14 @@
 				"name": "Cache Token Effects",
 				"hint": "Caches the token effects bar. Very minor visual degradataion on high zoom levels expected."
 			},
+			"precomputed-noise-textures": {
+				"name": "Optimize animated lights",
+				"hint": "Optimizes the shader of certain animated lights (Bewitching Wave, Fairy Light, Ghostly Light, Smoke Patch, Swirling Fog, Vortex) by utilizing precomputed FBM noise textures. The visual impact is minimal, but the performance impact is significant, especially on lower-end GPUs."
+			},
+			"reduce-lighting-resolution": {
+				"name": "Scale Lighting Effects Resolution",
+				"hint": "Reduces the internal resolution of lighting effects to improve performance. This can dramatically improve performance, especially when using many lights or large light sources. The visual impact should be minimal, except for some very high zoom levels and some lighting effects like hexa dome that have very clear outlines. You can configure the render scale for the individual lighting layers in the settings menu."
+			},
 			"spritesheet-substitution": {
 				"name": "Texture Replacement with Spritesheets",
 				"hint": "Substitutes core SVG icons and other graphic elements with optimized spriteshseets. This can improve performance and resource usage when displaying many UI icons for journals, lights, doors, etc."
@@ -37,9 +45,40 @@
 				"name": "Dynamic Token Spritesheet Support",
 				"hint": "Allows tokens with dynamic rings to be replaced with spritesheet textures. This is only needed if you use dynamic token rings and the spritesheet substitution feature to replace token textures."
 			},
-			"precomputed-noise-textures": {
-				"name": "Optimize animated lights",
-				"hint": "Optimizes the shader of certain animated lights (Bewitching Wave, Fairy Light, Ghostly Light, Smoke Patch, Swirling Fog, Vortex) by utilizing precomputed FBM noise textures."
+			"disable-app-v2-background-blur": {
+				"name": "Disable background blur effects",
+				"hint": "Disables the background blur effects in the app v2 and all other UI elements. This can dramatically improve performance, especially on lower-end GPUs and certain operating systems like MacOS."
+			},
+
+			"custom-render-scale": {
+				"name": "Lighting Effects Render Scale",
+				"label": "Configure Render Scale",
+				"hint": "Configure the rennder scale for lighting effects on the canvas. This can improve performance significantly, especially on lower-end GPUs. Visual impact ranges from unnoticable to very noticable, depending on the effects layer. Activate \"Reduce resolution of lighting effects\" for this configuration to work.",
+				"menu": {
+					"title": "Custom Render Scale",
+					"label": "Custom Render Scale",
+					"description": "Configure individual render scales for different lighting effects. The render scale is a multiplier for the internal resolution of the lighting effects. A value of 100 means 100% render scale, so no change. A value of 50 means the resolution is halved and so on.",
+					"confirm": "Confirm",
+					"cancel": "Reset",
+					"FIELDS": {
+						"background": {
+							"label": "Background",
+							"hint": "Background effects render scale. High visual impact, minimal performance impact. Optimized default is 100%"
+						},
+						"illumination": {
+							"label": "Illumination",
+							"hint": "Illumination effects render scale. Very low visual impact, medium performance impact. Optimized default is 40%"
+						},
+						"coloration": {
+							"label": "Coloration",
+							"hint": "Coloration effects render scale. Medium to very high visual impact, depending on coloration technique. High performance impact. Optimized default is 100%."
+						},
+						"darkness": {
+							"label": "Darkness",
+							"hint": "Darkness effects render scale. Minimal visual impact, minmal performance impact. Optimized default is 50%"
+						}
+					}
+				}
 			}
 		}
 	}

img/visual-comparison/default.avif

@@ -1,7 +1,7 @@
 {
 	"id": "fvtt-perf-optim",
 	"title": "Prime Performance",
-	"version": "0.9.2",
+	"version": "0.10.0",
 	"description": "Provides a collection of unofficial performance optimizations and hacks for foundry vtt.",
 	"esmodules": ["dist/fvtt-perf-optim.js"],
 	"languages": [
@@ -30,6 +30,7 @@
 			"flags": {}
 		}
 	],
+	"styles": ["styles/disable-blur.css"],
 	"compatibility": {
 		"minimum": "12.324",
 		"verified": "13.341",

img/visual-comparison/default.png

@@ -0,0 +1,155 @@
+import { NAMESPACE } from 'src/constants.ts';
+import { configureEffectsResolution } from 'src/hacks/reduceLightingResolution.ts';
+import { RENDER_SCALE_DEFAULTS, SETTINGS } from 'src/settings/constants.ts';
+import { getSetting } from 'src/settings/settings.ts';
+import { FOUNDRY_API } from 'src/utils/foundryShim.ts';
+
+const fields = foundry.data.fields;
+
+export class CustomRenderScaleConfig extends foundry.applications.api.HandlebarsApplicationMixin(
+	foundry.applications.api.ApplicationV2,
+) {
+	static override DEFAULT_OPTIONS = {
+		id: 'render-scale-config',
+		tag: 'form',
+		window: {
+			contentClasses: ['standard-form'],
+			title: `${NAMESPACE}.settings.${SETTINGS.CustomRenderScale}.menu.title`,
+			icon: 'fa-solid fa-percent',
+		},
+		position: {
+			width: 600,
+		},
+		form: {
+			closeOnSubmit: true,
+			handler: CustomRenderScaleConfig.#onSubmit,
+		},
+		actions: {
+			reset: CustomRenderScaleConfig.#onReset,
+		},
+	};
+
+	static override PARTS = {
+		body: {
+			template: `modules/${NAMESPACE}/templates/render-resolution-menu.hbs`,
+			scrollable: [''],
+		},
+		footer: {
+			template: 'templates/generic/form-footer.hbs',
+		},
+	};
+
+	static #schema = new fields.SchemaField({
+		background: new fields.NumberField({
+			required: true,
+			min: 25,
+			max: 100,
+			step: 5,
+			initial: RENDER_SCALE_DEFAULTS.background,
+		}),
+		illumination: new fields.NumberField({
+			required: true,
+			min: 25,
+			max: 100,
+			step: 5,
+			initial: RENDER_SCALE_DEFAULTS.illumination,
+		}),
+		coloration: new fields.NumberField({
+			required: true,
+			min: 25,
+			max: 100,
+			step: 5,
+			initial: RENDER_SCALE_DEFAULTS.coloration,
+		}),
+		darkness: new fields.NumberField({
+			required: true,
+			min: 25,
+			max: 100,
+			step: 5,
+			initial: RENDER_SCALE_DEFAULTS.darkness,
+		}),
+	});
+
+	/**
+	 * The data schema for the core.uiConfig setting.
+	 * @type {SchemaField}
+	 */
+	static get schema() {
+		return CustomRenderScaleConfig.#schema;
+	}
+
+	static #localized = false;
+
+	/** @inheritDoc */
+	override async _preFirstRender(_context: any, _options: any) {
+		const LocalizationHelper: Localization = FOUNDRY_API.generation >= 13 ? foundry.helpers.Localization : Localization;
+		await super._preFirstRender(_context, _options);
+
+		if (!CustomRenderScaleConfig.#localized) {
+			LocalizationHelper.localizeDataModel(
+				{ schema: CustomRenderScaleConfig.#schema },
+				{ prefixes: ['fvtt-perf-optim.settings.custom-render-scale.menu'] },
+			);
+			CustomRenderScaleConfig.#localized = true;
+		}
+	}
+
+	#setting: typeof RENDER_SCALE_DEFAULTS | undefined;
+
+	override async _prepareContext(options: any) {
+		if (options.isFirstRender) {
+			this.#setting = getSetting<typeof RENDER_SCALE_DEFAULTS>(SETTINGS.CustomRenderScale) ?? RENDER_SCALE_DEFAULTS;
+		}
+
+		return {
+			renderScale: this.#setting,
+			fields: CustomRenderScaleConfig.#schema.fields,
+			buttons: [
+				{
+					type: 'button',
+					label: `${NAMESPACE}.settings.${SETTINGS.CustomRenderScale}.menu.cancel`,
+					icon: 'fa-solid fa-arrow-rotate-left',
+					action: 'reset',
+				},
+				{
+					type: 'submit',
+					label: `${NAMESPACE}.settings.${SETTINGS.CustomRenderScale}.menu.confirm`,
+					icon: 'fa-solid fa-check',
+					action: 'confirm',
+				},
+			],
+		};
+	}
+
+	static async #onSubmit() {
+		game.settings.set(NAMESPACE, SETTINGS.CustomRenderScale, this.#setting);
+		const enabled = getSetting<boolean>(SETTINGS.ReduceLightingResolution);
+		configureEffectsResolution(enabled ? this.#setting : null);
+	}
+
+	static async #onReset() {
+		this.#setting = RENDER_SCALE_DEFAULTS;
+	}
+
+	override _onClose(options: any) {
+		super._onClose(options);
+		if (!options.submitted) {
+			const enabled = getSetting<boolean>(SETTINGS.ReduceLightingResolution);
+			const renderScale = getSetting<typeof RENDER_SCALE_DEFAULTS>(SETTINGS.CustomRenderScale);
+			configureEffectsResolution(enabled ? renderScale : null);
+		}
+	}
+
+	/* -------------------------------------------- */
+
+	/** @override */
+	override _onChangeForm(_formConfig: any, _event: any) {
+		const FormDataExtendedConstructor =
+			FOUNDRY_API.generation >= 13 ? foundry.applications.ux.FormDataExtended : FormDataExtended;
+
+		const formData = new FormDataExtendedConstructor(this.form);
+
+		this.#setting = foundry.utils.expandObject(formData.object) as typeof RENDER_SCALE_DEFAULTS;
+		configureEffectsResolution(this.#setting);
+	}
+}

img/visual-comparison/prime-performance.avif

@@ -0,0 +1,22 @@
+import { SETTINGS } from 'src/settings/constants.ts';
+import { getSetting } from 'src/settings/settings.ts';
+
+function enableDisableAppBackgroundBlur() {
+	const enabled = getSetting<boolean>(SETTINGS.DisableAppV2BackgroundBlur);
+
+	if (!enabled) {
+		return;
+	}
+
+	toggleDisableAppBackgroundBlur(enabled);
+}
+
+function toggleDisableAppBackgroundBlur(enabled: boolean) {
+	if (enabled) {
+		document.body.classList.add('disable-app-background-blur');
+	} else {
+		document.body.classList.remove('disable-app-background-blur');
+	}
+}
+
+export { enableDisableAppBackgroundBlur, toggleDisableAppBackgroundBlur };