dpi

Classes

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

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

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

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

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

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

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

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

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 (@linkcode LogicalSize).

For physical-pixel-based position, see PhysicalPosition.

Since

2.0.0

Constructors

new PhysicalSize()

new PhysicalSize(width, height): PhysicalSize

Parameters

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

Returns

PhysicalSize

Source: undefined

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

Parameters

Parameter	Type
`object`	`object`
`object.Physical`	`object`
`object.Physical.height`	`number`
`object.Physical.width`	`number`

Returns

PhysicalSize

Source: undefined

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

Parameters

Parameter	Type
`object`	`object`
`object.height`	`number`
`object.width`	`number`

Returns

PhysicalSize

Source: undefined

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

Returns

object

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

Source: undefined

toJSON()

toJSON(): object

Returns

object

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

Source: undefined

toLogical()

toLogical(scaleFactor): LogicalSize

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

Source: undefined

Position

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

new Position()

new Position(position): Position

Parameters

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

Returns

Position

Source: undefined

Properties

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

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

Source: undefined

toJSON()

toJSON(): object

Returns

object

Source: undefined

toLogical()

toLogical(scaleFactor): LogicalPosition

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

LogicalPosition

Source: undefined

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

PhysicalPosition

Source: undefined

Size

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