dpi

Constructor

new LogicalPosition(object): LogicalPosition;

Source: undefined

Parameters

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

Returns

Constructor

new LogicalPosition(object): LogicalPosition;

Source: undefined

Parameters

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

Returns

Properties

Property	Modifier	Type	Default value	Defined in
`type`	`readonly`	`"Logical"`	`'Logical'`	Source: undefined
`x`	`public`	`number`	`undefined`	Source: undefined
`y`	`public`	`number`	`undefined`	Source: undefined

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`x`	`number`	Source: undefined
`y`	`number`	Source: undefined

toJSON()

toJSON(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`x`	`number`	Source: undefined
`y`	`number`	Source: undefined

toPhysical()

toPhysical(scaleFactor): PhysicalPosition;

Source: undefined

Converts the logical position to a physical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

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: undefined

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: undefined

Parameters

Parameter	Type
`width`	`number`
`height`	`number`

Returns

Constructor

new LogicalSize(object): LogicalSize;

Source: undefined

Parameters

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

Returns

Constructor

new LogicalSize(object): LogicalSize;

Source: undefined

Parameters

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

Returns

Properties

Property	Modifier	Type	Default value	Defined in
`height`	`public`	`number`	`undefined`	Source: undefined
`type`	`readonly`	`"Logical"`	`'Logical'`	Source: undefined
`width`	`public`	`number`	`undefined`	Source: undefined

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`height`	`number`	Source: undefined
`width`	`number`	Source: undefined

toJSON()

toJSON(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`height`	`number`	Source: undefined
`width`	`number`	Source: undefined

toPhysical()

toPhysical(scaleFactor): PhysicalSize;

Source: undefined

Converts the logical size to a physical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

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: undefined

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: undefined

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

Constructor

new PhysicalPosition(object): PhysicalPosition;

Source: undefined

Parameters

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

Returns

Constructor

new PhysicalPosition(object): PhysicalPosition;

Source: undefined

Parameters

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

Returns

Properties

Property	Modifier	Type	Default value	Defined in
`type`	`readonly`	`"Physical"`	`'Physical'`	Source: undefined
`x`	`public`	`number`	`undefined`	Source: undefined
`y`	`public`	`number`	`undefined`	Source: undefined

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`x`	`number`	Source: undefined
`y`	`number`	Source: undefined

toJSON()

toJSON(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`x`	`number`	Source: undefined
`y`	`number`	Source: undefined

toLogical()

toLogical(scaleFactor): LogicalPosition;

Source: undefined

Converts the physical position to a logical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

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 physical = position.toLogical(factor);

Since

2.0.0

PhysicalSize

Source: undefined

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: undefined

Parameters

Parameter	Type
`width`	`number`
`height`	`number`

Returns

Constructor

new PhysicalSize(object): PhysicalSize;

Source: undefined

Parameters

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

Returns

Constructor

new PhysicalSize(object): PhysicalSize;

Source: undefined

Parameters

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

Returns

Properties

Property	Modifier	Type	Default value	Defined in
`height`	`public`	`number`	`undefined`	Source: undefined
`type`	`readonly`	`"Physical"`	`'Physical'`	Source: undefined
`width`	`public`	`number`	`undefined`	Source: undefined

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`height`	`number`	Source: undefined
`width`	`number`	Source: undefined

toJSON()

toJSON(): object;

Source: undefined

Returns

object

Name	Type	Defined in
`height`	`number`	Source: undefined
`width`	`number`	Source: undefined

toLogical()

toLogical(scaleFactor): LogicalSize;

Source: undefined

Converts the physical size to a logical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

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);

Position

Source: undefined

A position 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::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: undefined

Parameters

Parameter	Type
`position`	\| `PhysicalPosition` \| `LogicalPosition`

Returns

Position

Properties

Property	Type	Defined in
`position`	\| `PhysicalPosition` \| `LogicalPosition`	Source: undefined

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: undefined

Returns

object

toJSON()

toJSON(): object;

Source: undefined

Returns

object

toLogical()

toLogical(scaleFactor): LogicalPosition;

Source: undefined

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

toPhysical()

toPhysical(scaleFactor): PhysicalPosition;

Source: undefined

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

Size

Source: undefined

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: undefined

Parameters

Parameter	Type
`size`	\| `PhysicalSize` \| `LogicalSize`

Returns

Size

Properties

Property	Type	Defined in
`size`	\| `PhysicalSize` \| `LogicalSize`	Source: undefined

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object;

Source: undefined

Returns

object

toJSON()

toJSON(): object;

Source: undefined

Returns

object

toLogical()

toLogical(scaleFactor): LogicalSize;

Source: undefined

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

toPhysical()

toPhysical(scaleFactor): PhysicalSize;

Source: undefined

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns