Guide
API
CHANGELOG
About
Guide

Home > @lynx-js/react > DataProcessors > getScreenMetricsOverride

DataProcessors.getScreenMetricsOverride() method

Optional processor to override screen metrics used by the app

Signature:

getScreenMetricsOverride?(metrics: {
        width: number;
        height: number;
    }): {
        width: number;
        height: number;
    };

Parameters

ParameterTypeDescription
metrics{ width: number; height: number; }The physical screen dimensions in pixels

Returns:

{ width: number; height: number; }

New screen dimensions to be used by the app

Example

lynx.registerDataProcessors({
  dataProcessors: {
    getScreenMetricsOverride: (metrics) => {
      // Force a specific aspect ratio
      return {
        width: metrics.width,
        height: metrics.width * (16/9)
      };
    }
  }
});