dpi

Classes

LogicalPosition

A position represented in logical pixels.

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

Parameter	Type
`object`	`object`
`object.Logical`	`object`
`object.Logical.x`	`number`
`object.Logical.y`	`number`

Parameter	Type
`object`	`object`
`object.x`	`number`
`object.y`	`number`

Properties

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

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

Name	Type	Defined in
`x`	`number`
`y`	`number`

toJSON()

toJSON(): object

Returns

object

Name	Type	Defined in
`x`	`number`
`y`	`number`

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

Converts the logical position to a physical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Example

import { LogicalPosition } from '@crabnebula/taurify-api/dpi';
import { getCurrentWindow } from '@crabnebula/taurify-api/window';

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

LogicalSize

A size represented in logical pixels.

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

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

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

Properties

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

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

Name	Type	Defined in
`height`	`number`
`width`	`number`

toJSON()

toJSON(): object

Returns

object

Name	Type	Defined in
`height`	`number`
`width`	`number`

toPhysical()

toPhysical(scaleFactor): PhysicalSize

Converts the logical size to a physical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Example

import { LogicalSize } from '@crabnebula/taurify-api/dpi';
import { getCurrentWindow } from '@crabnebula/taurify-api/window';

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

PhysicalPosition

A position represented in physical pixels.

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

Parameter	Type
`object`	`object`
`object.Physical`	`object`
`object.Physical.x`	`number`
`object.Physical.y`	`number`

Parameter	Type
`object`	`object`
`object.x`	`number`
`object.y`	`number`

Properties

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

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

Name	Type	Defined in
`x`	`number`
`y`	`number`

toJSON()

toJSON(): object

Returns

object

Name	Type	Defined in
`x`	`number`
`y`	`number`

toLogical()

toLogical(scaleFactor): LogicalPosition

Converts the physical position to a logical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Example

import { PhysicalPosition } from '@crabnebula/taurify-api/dpi';
import { getCurrentWindow } from '@crabnebula/taurify-api/window';

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

PhysicalSize

A size represented in physical pixels.

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

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

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

Properties

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

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

Name	Type	Defined in
`height`	`number`
`width`	`number`

toJSON()

toJSON(): object

Returns

object

Name	Type	Defined in
`height`	`number`
`width`	`number`

toLogical()

toLogical(scaleFactor): LogicalSize

Converts the physical size to a logical one.

Parameters

Parameter	Type
`scaleFactor`	`number`

Example

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

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 '@crabnebula/taurify-api/core';
import { LogicalPosition, PhysicalPosition } from '@crabnebula/taurify-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 '@crabnebula/taurify-api/core';
import { LogicalPosition, PhysicalPosition, Position } from '@crabnebula/taurify-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 });

Constructors

new Position()

new Position(position): Position

Parameters

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

Returns

Position

Properties

Property	Type	Defined in
`position`	`LogicalPosition` \| `PhysicalPosition`

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

toJSON()

toJSON(): object

Returns

object

toLogical()

toLogical(scaleFactor): LogicalPosition

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

LogicalPosition

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

Parameters

Parameter	Type
`scaleFactor`	`number`

Returns

PhysicalPosition

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 '@crabnebula/taurify-api/core';
import { LogicalSize, PhysicalSize } from '@crabnebula/taurify-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 '@crabnebula/taurify-api/core';
import { LogicalSize, PhysicalSize, Size } from '@crabnebula/taurify-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 });