dpi

Classes

LogicalPosition

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

Constructors

new LogicalPosition()

new LogicalPosition(x, y): LogicalPosition

Parameters

Parameter	Type
x	number
y	number

Returns

LogicalPosition

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

Parameters

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

Returns

LogicalPosition

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

Parameters

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

Returns

LogicalPosition

Properties

Property	Modifier	Type	Default value	Defined in
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

Returns

PhysicalPosition

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. 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.

Constructors

new LogicalSize()

new LogicalSize(width, height): LogicalSize

Parameters

Parameter	Type
width	number
height	number

Returns

LogicalSize

new LogicalSize()

new LogicalSize(object): LogicalSize

Parameters

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

Returns

LogicalSize

new LogicalSize()

new LogicalSize(object): LogicalSize

Parameters

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

Returns

LogicalSize

Properties

Property	Modifier	Type	Default value	Defined in
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

Returns

PhysicalSize

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.

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

Constructors

new PhysicalPosition()

new PhysicalPosition(x, y): PhysicalPosition

Parameters

Parameter	Type
x	number
y	number

Returns

PhysicalPosition

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

Parameters

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

Returns

PhysicalPosition

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

Parameters

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

Returns

PhysicalPosition

Properties

Property	Modifier	Type	Default value	Defined in
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

Returns

LogicalPosition

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.

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.

Constructors

new PhysicalSize()

new PhysicalSize(width, height): PhysicalSize

Parameters

Parameter	Type
width	number
height	number

Returns

PhysicalSize

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

Parameters

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

Returns

PhysicalSize

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

Parameters

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

Returns

PhysicalSize

Properties

Property	Modifier	Type	Default value	Defined in
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

Returns

LogicalSize

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

Constructors

new Size()

new Size(size): Size

Parameters

Parameter	Type
size	LogicalSize | PhysicalSize

Returns

Size

Properties

Property	Type	Defined in
size	LogicalSize | PhysicalSize

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Returns

object

toJSON()

toJSON(): object

Returns

object

toLogical()

toLogical(scaleFactor): LogicalSize

Parameters

Parameter	Type
scaleFactor	number

Returns

LogicalSize

toPhysical()

toPhysical(scaleFactor): PhysicalSize

Parameters

Parameter	Type
scaleFactor	number

Returns

PhysicalSize