Skip to content

🎥 Make videos programmatically with React

Studio: Read canvas pixel ratio override from URL

Jonny Burger29bc3c2c26ff
diff --git a/packages/studio/src/helpers/studio-pixel-ratio.ts b/packages/studio/src/helpers/studio-pixel-ratio.ts
index 19b7a59d7a..1fff54b613 100644
--- a/packages/studio/src/helpers/studio-pixel-ratio.ts
+++ b/packages/studio/src/helpers/studio-pixel-ratio.ts
@@ -1,5 +1,34 @@
-// Set this to a number temporarily to increase Studio canvas backing resolution.
-const OVERRIDE_PIXEL_RATIO: number | null = null;
+import {getNavigationWindow} from './url-state';
-export const getStudioPixelRatio = (): number =>
- OVERRIDE_PIXEL_RATIO ?? window.devicePixelRatio;
+let initialized = false;
+let overridePixelRatio: number | null = null;
+
+export const getStudioPixelRatio = (): number => {
+ if (!initialized) {
+ initialized = true;
+ const storageKey = 'remotion.studioPixelRatio';
+ const raw = new URLSearchParams(getNavigationWindow().location.search).get(
+ 'studioPixelRatio',
+ );
+ const fromUrl = raw === null ? Number.NaN : Number(raw);
+ if (Number.isFinite(fromUrl) && fromUrl > 0) {
+ overridePixelRatio = fromUrl;
+ try {
+ window.sessionStorage.setItem(storageKey, String(fromUrl));
+ } catch {
+ // Keep the override in memory if session storage is unavailable.
+ }
+ } else {
+ try {
+ const stored = Number(window.sessionStorage.getItem(storageKey));
+ if (Number.isFinite(stored) && stored > 0) {
+ overridePixelRatio = stored;
+ }
+ } catch {
+ // Use the device pixel ratio if session storage is unavailable.
+ }
+ }
+ }
+
+ return overridePixelRatio ?? window.devicePixelRatio;
+};
diff --git a/packages/studio/src/initialize-studio-preview.ts b/packages/studio/src/initialize-studio-preview.ts
index 4cf02bd25e..a92f9067af 100644
--- a/packages/studio/src/initialize-studio-preview.ts
+++ b/packages/studio/src/initialize-studio-preview.ts
@@ -5,6 +5,7 @@ import {addErrorToOverlay} from './error-overlay/runtime-error-store';
import {BACKGROUND_HEX} from './helpers/colors';
import {injectCSS} from './helpers/inject-css';
import {studioCssVariables} from './helpers/studio-css-variables';
+import {getStudioPixelRatio} from './helpers/studio-pixel-ratio';
import {enableHotMiddleware} from './hot-middleware-client/client';
declare global {
@@ -16,6 +17,9 @@ declare global {
// Initialize before the project entry point so failed imports cannot prevent
// runtime error reporting and hot reload from initializing.
export const initializeStudioPreview = () => {
+ // Consume the URL override before Studio navigation replaces the query string.
+ getStudioPixelRatio();
+
if (window.__remotionOverlayStarted) {
return;
}