dpi

Size and position types for working with logical and physical pixels.

Window and webview APIs report sizes and positions in physical pixels (actual screen pixels), while most browser APIs and the window creation options use logical pixels (physical pixels divided by the monitor scale factor). The classes in this module make the unit explicit and convert between the two.

import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const size = await appWindow.innerSize(); // PhysicalSize
const logical = size.toLogical(await appWindow.scaleFactor());

They also serialize into the shape tauri::Size / tauri::Position expect, so they can be passed straight to your own commands, see Size and Position.

This package is also accessible with window.__TAURI__.dpi when app.withGlobalTauri in tauri.conf.json is set to true.

Classes

LogicalPosition

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L259

A position represented in logical pixels. For an explanation of what logical pixels are, see description of LogicalSize.

Since

2.0.0

Constructors

Constructor

new LogicalPosition(x, y): LogicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L264

Parameters

Parameter	Type
x	number
y	number

Returns

LogicalPosition

Constructor

new LogicalPosition(object): LogicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L265

Parameters

Parameter	Type
object	{ Logical: { x: number; y: number; }; }
object.Logical	{ x: number; y: number; }
object.Logical.x	number
object.Logical.y	number

Returns

LogicalPosition

Constructor

new LogicalPosition(object): LogicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L266

Parameters

Parameter	Type
object	{ x: number; y: number; }
object.x	number
object.y	number

Returns

LogicalPosition

Properties

Property	Modifier	Type	Default value	Defined in
type	readonly	"Logical"	'Logical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L260
x	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L261
y	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L262

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L306

Returns

object

Name	Type	Defined in
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L308
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L309

toJSON()

toJSON(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L313

Returns

object

Name	Type	Defined in
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L308
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L309

toPhysical()

toPhysical(scaleFactor): PhysicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L302

Converts the logical position to a physical one.

Parameters

Parameter	Type
scaleFactor	number

Returns

PhysicalPosition

Example

import { LogicalPosition } from '@tauri-apps/api/dpi';
import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const position = new LogicalPosition(400, 500);
const physical = position.toPhysical(factor);

Since

2.0.0

---

LogicalSize

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L41

A size represented in logical pixels. Logical pixels are scaled according to the window’s DPI scale. Most browser APIs (i.e. MouseEvent’s clientX) will return logical pixels.

For logical-pixel-based position, see LogicalPosition.

Since

2.0.0

Constructors

Constructor

new LogicalSize(width, height): LogicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L46

Parameters

Parameter	Type
width	number
height	number

Returns

LogicalSize

Constructor

new LogicalSize(object): LogicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L47

Parameters

Parameter	Type
object	{ Logical: { height: number; width: number; }; }
object.Logical	{ height: number; width: number; }
object.Logical.height	number
object.Logical.width	number

Returns

LogicalSize

Constructor

new LogicalSize(object): LogicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L48

Parameters

Parameter	Type
object	{ height: number; width: number; }
object.height	number
object.width	number

Returns

LogicalSize

Properties

Property	Modifier	Type	Default value	Defined in
height	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L44
type	readonly	"Logical"	'Logical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L42
width	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L43

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L88

Returns

object

Name	Type	Defined in
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L91
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L90

toJSON()

toJSON(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L95

Returns

object

Name	Type	Defined in
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L91
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L90

toPhysical()

toPhysical(scaleFactor): PhysicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L84

Converts the logical size to a physical one.

Parameters

Parameter	Type
scaleFactor	number

Returns

PhysicalSize

Example

import { LogicalSize } from '@tauri-apps/api/dpi';
import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const size = new LogicalSize(400, 500);
const physical = size.toPhysical(factor);

Since

2.0.0

---

PhysicalPosition

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L326

A position represented in physical pixels.

For an explanation of what physical pixels are, see description of PhysicalSize.

Since

2.0.0

Constructors

Constructor

new PhysicalPosition(x, y): PhysicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L331

Parameters

Parameter	Type
x	number
y	number

Returns

PhysicalPosition

Constructor

new PhysicalPosition(object): PhysicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L332

Parameters

Parameter	Type
object	{ Physical: { x: number; y: number; }; }
object.Physical	{ x: number; y: number; }
object.Physical.x	number
object.Physical.y	number

Returns

PhysicalPosition

Constructor

new PhysicalPosition(object): PhysicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L333

Parameters

Parameter	Type
object	{ x: number; y: number; }
object.x	number
object.y	number

Returns

PhysicalPosition

Properties

Property	Modifier	Type	Default value	Defined in
type	readonly	"Physical"	'Physical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L327
x	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L328
y	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L329

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L373

Returns

object

Name	Type	Defined in
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L375
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L376

toJSON()

toJSON(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L380

Returns

object

Name	Type	Defined in
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L375
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L376

toLogical()

toLogical(scaleFactor): LogicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L369

Converts the physical position to a logical one.

Parameters

Parameter	Type
scaleFactor	number

Returns

LogicalPosition

Example

import { PhysicalPosition } from '@tauri-apps/api/dpi';
import { getCurrentWindow } from '@tauri-apps/api/window';

const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const position = new PhysicalPosition(400, 500);
const logical = position.toLogical(factor);

Since

2.0.0

---

PhysicalSize

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L112

A size represented in physical pixels.

Physical pixels represent actual screen pixels, and are DPI-independent. For high-DPI windows, this means that any point in the window on the screen will have a different position in logical pixels LogicalSize.

For physical-pixel-based position, see PhysicalPosition.

Since

2.0.0

Constructors

Constructor

new PhysicalSize(width, height): PhysicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L117

Parameters

Parameter	Type
width	number
height	number

Returns

PhysicalSize

Constructor

new PhysicalSize(object): PhysicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L118

Parameters

Parameter	Type
object	{ Physical: { height: number; width: number; }; }
object.Physical	{ height: number; width: number; }
object.Physical.height	number
object.Physical.width	number

Returns

PhysicalSize

Constructor

new PhysicalSize(object): PhysicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L119

Parameters

Parameter	Type
object	{ height: number; width: number; }
object.height	number
object.width	number

Returns

PhysicalSize

Properties

Property	Modifier	Type	Default value	Defined in
height	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L115
type	readonly	"Physical"	'Physical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L113
width	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L114

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L157

Returns

object

Name	Type	Defined in
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L160
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L159

toJSON()

toJSON(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L164

Returns

object

Name	Type	Defined in
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L160
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L159

toLogical()

toLogical(scaleFactor): LogicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L153

Converts the physical size to a logical one.

Parameters

Parameter	Type
scaleFactor	number

Returns

LogicalSize

Example

import { getCurrentWindow } from '@tauri-apps/api/window';
const appWindow = getCurrentWindow();
const factor = await appWindow.scaleFactor();
const size = await appWindow.innerSize(); // PhysicalSize
const logical = size.toLogical(factor);

Since

2.0.0

---

Position

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L417

A position represented either in physical or in logical pixels.

This type is basically a union type of LogicalPosition and PhysicalPosition but comes in handy when using tauri::Position in Rust as an argument to a command, as this class automatically serializes into a valid format so it can be deserialized correctly into tauri::Position

So instead of

import { invoke } from '@tauri-apps/api/core';
import { LogicalPosition, PhysicalPosition } from '@tauri-apps/api/dpi';

const position: LogicalPosition | PhysicalPosition = someFunction(); // where someFunction returns either LogicalPosition or PhysicalPosition
const validPosition = position instanceof LogicalPosition
  ? { Logical: { x: position.x, y: position.y } }
  : { Physical: { x: position.x, y: position.y } }
await invoke("do_something_with_position", { position: validPosition });

You can just use Position

import { invoke } from '@tauri-apps/api/core';
import { LogicalPosition, PhysicalPosition, Position } from '@tauri-apps/api/dpi';

const position: LogicalPosition | PhysicalPosition = someFunction(); // where someFunction returns either LogicalPosition or PhysicalPosition
const validPosition = new Position(position);
await invoke("do_something_with_position", { position: validPosition });

Since

2.1.0

Constructors

Constructor

new Position(position): Position;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L420

Parameters

Parameter	Type
position	| PhysicalPosition | LogicalPosition

Returns

Position

Properties

Property	Type	Defined in
position	| PhysicalPosition | LogicalPosition	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L418

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L454

Returns

object

toJSON()

toJSON(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L463

Returns

object

toLogical()

toLogical(scaleFactor): LogicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L433

Converts the wrapped position to a logical one.

Returns the inner value untouched when it already is a LogicalPosition.

Parameters

Parameter	Type	Description
scaleFactor	number	The monitor scale factor, e.g. await appWindow.scaleFactor().

Returns

LogicalPosition

Since

2.1.0

toPhysical()

toPhysical(scaleFactor): PhysicalPosition;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L448

Converts the wrapped position to a physical one.

Returns the inner value untouched when it already is a PhysicalPosition.

Parameters

Parameter	Type	Description
scaleFactor	number	The monitor scale factor, e.g. await appWindow.scaleFactor().

Returns

PhysicalPosition

Since

2.1.0

---

Size

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L201

A size represented either in physical or in logical pixels.

This type is basically a union type of LogicalSize and PhysicalSize but comes in handy when using tauri::Size in Rust as an argument to a command, as this class automatically serializes into a valid format so it can be deserialized correctly into tauri::Size

So instead of

import { invoke } from '@tauri-apps/api/core';
import { LogicalSize, PhysicalSize } from '@tauri-apps/api/dpi';

const size: LogicalSize | PhysicalSize = someFunction(); // where someFunction returns either LogicalSize or PhysicalSize
const validSize = size instanceof LogicalSize
  ? { Logical: { width: size.width, height: size.height } }
  : { Physical: { width: size.width, height: size.height } }
await invoke("do_something_with_size", { size: validSize });

You can just use Size

import { invoke } from '@tauri-apps/api/core';
import { LogicalSize, PhysicalSize, Size } from '@tauri-apps/api/dpi';

const size: LogicalSize | PhysicalSize = someFunction(); // where someFunction returns either LogicalSize or PhysicalSize
const validSize = new Size(size);
await invoke("do_something_with_size", { size: validSize });

Since

2.1.0

Constructors

Constructor

new Size(size): Size;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L204

Parameters

Parameter	Type
size	| PhysicalSize | LogicalSize

Returns

Size

Properties

Property	Type	Defined in
size	| PhysicalSize | LogicalSize	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L202

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L238

Returns

object

toJSON()

toJSON(): object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L247

Returns

object

toLogical()

toLogical(scaleFactor): LogicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L217

Converts the wrapped size to a logical one.

Returns the inner value untouched when it already is a LogicalSize.

Parameters

Parameter	Type	Description
scaleFactor	number	The monitor scale factor, e.g. await appWindow.scaleFactor().

Returns

LogicalSize

Since

2.1.0

toPhysical()

toPhysical(scaleFactor): PhysicalSize;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L232

Converts the wrapped size to a physical one.

Returns the inner value untouched when it already is a PhysicalSize.

Parameters

Parameter	Type	Description
scaleFactor	number	The monitor scale factor, e.g. await appWindow.scaleFactor().

Returns

PhysicalSize

Since

2.1.0