dpi

Clases

LogicalPosition

Una posición representada en píxeles lógicos. Para una explicación de qué son los píxeles lógicos, consulta la descripción de LogicalSize.

Desde

2.0.0

Constructores

new LogicalPosition()

new LogicalPosition(x, y): LogicalPosition

Parámetros

Parámetro	Tipo
x	number
y	number

Devuelve

LogicalPosition

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

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

Parámetros

Parámetro	Tipo
object	object
object.Logical	object
object.Logical.x	number
object.Logical.y	number

Devuelve

LogicalPosition

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

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

Parámetros

Parámetro	Tipo
object	object
object.x	number
object.y	number

Devuelve

LogicalPosition

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

Propiedades

Propiedad	Modifier	Tipo	Valor por defecto	Definido en
type	readonly	"Logical"	'Logical'	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L215
x	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L216
y	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L217

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Devuelve

object

Nombre	Tipo	Definido en
x	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L263
y	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L264

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

toJSON()

toJSON(): object

Devuelve

object

Nombre	Tipo	Definido en
x	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L263
y	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L264

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

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

Convierte la posición lógica a una física.

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

PhysicalPosition

Ejemplo

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

Desde

2.0.0

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

---

LogicalSize

Un tamaño representado en píxeles lógicos. Los píxeles lógicos se escalan según la escala DPI de la ventana. La mayoría de las API del navegador (es decir, clientX de MouseEvent) devolverán píxeles lógicos.

Para una posición basada en píxeles lógicos, consulta LogicalPosition.

Desde

2.0.0

Constructores

new LogicalSize()

new LogicalSize(width, height): LogicalSize

Parámetros

Parámetro	Tipo
width	number
height	number

Devuelve

LogicalSize

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

new LogicalSize()

new LogicalSize(object): LogicalSize

Parámetros

Parámetro	Tipo
object	object
object.Logical	object
object.Logical.height	number
object.Logical.width	number

Devuelve

LogicalSize

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

new LogicalSize()

new LogicalSize(object): LogicalSize

Parámetros

Parámetro	Tipo
object	object
object.height	number
object.width	number

Devuelve

LogicalSize

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

Propiedades

Propiedad	Modifier	Tipo	Valor por defecto	Definido en
height	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L19
type	readonly	"Logical"	'Logical'	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L17
width	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L18

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Devuelve

object

Nombre	Tipo	Definido en
height	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L66
width	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L65

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

toJSON()

toJSON(): object

Devuelve

object

Nombre	Tipo	Definido en
height	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L66
width	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L65

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

toPhysical()

toPhysical(scaleFactor): PhysicalSize

Convierte el tamaño lógico a uno físico.

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

PhysicalSize

Ejemplo

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

Desde

2.0.0

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

---

PhysicalPosition

Una posición representada en píxeles físicos.

Para una explicación de qué son los píxeles físicos, consulta la descripción de PhysicalSize.

Desde

2.0.0

Constructores

new PhysicalPosition()

new PhysicalPosition(x, y): PhysicalPosition

Parámetros

Parámetro	Tipo
x	number
y	number

Devuelve

PhysicalPosition

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

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

Parámetros

Parámetro	Tipo
object	object
object.Physical	object
object.Physical.x	number
object.Physical.y	number

Devuelve

PhysicalPosition

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

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

Parámetros

Parámetro	Tipo
object	object
object.x	number
object.y	number

Devuelve

PhysicalPosition

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

Propiedades

Propiedad	Modifier	Tipo	Valor por defecto	Definido en
type	readonly	"Physical"	'Physical'	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L282
x	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L283
y	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L284

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Devuelve

object

Nombre	Tipo	Definido en
x	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L330
y	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L331

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

toJSON()

toJSON(): object

Devuelve

object

Nombre	Tipo	Definido en
x	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L330
y	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L331

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

toLogical()

toLogical(scaleFactor): LogicalPosition

Convierte la posición física a una lógica.

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

LogicalPosition

Ejemplo

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

Desde

2.0.0

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

---

PhysicalSize

Un tamaño representado en píxeles físicos.

Los píxeles físicos representan los píxeles reales de la pantalla y son independientes del DPI. Para ventanas de alto DPI, esto significa que cualquier punto de la ventana en la pantalla tendrá una posición diferente en píxeles lógicos LogicalSize.

Para una posición basada en píxeles físicos, consulta PhysicalPosition.

Desde

2.0.0

Constructores

new PhysicalSize()

new PhysicalSize(width, height): PhysicalSize

Parámetros

Parámetro	Tipo
width	number
height	number

Devuelve

PhysicalSize

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

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

Parámetros

Parámetro	Tipo
object	object
object.Physical	object
object.Physical.height	number
object.Physical.width	number

Devuelve

PhysicalSize

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

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

Parámetros

Parámetro	Tipo
object	object
object.height	number
object.width	number

Devuelve

PhysicalSize

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

Propiedades

Propiedad	Modifier	Tipo	Valor por defecto	Definido en
height	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L90
type	readonly	"Physical"	'Physical'	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L88
width	public	number	undefined	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L89

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Devuelve

object

Nombre	Tipo	Definido en
height	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L133
width	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L132

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

toJSON()

toJSON(): object

Devuelve

object

Nombre	Tipo	Definido en
height	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L133
width	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L132

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

toLogical()

toLogical(scaleFactor): LogicalSize

Convierte el tamaño físico a uno lógico.

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

LogicalSize

Ejemplo

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

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

---

Position

Una posición representada ya sea en píxeles físicos o lógicos.

Este tipo es básicamente un tipo de unión de LogicalSize y PhysicalSize pero resulta muy útil cuando usas tauri::Position en Rust como argumento para un comando, ya que esta clase se serializa automáticamente en un formato válido para que pueda deserializarse correctamente en tauri::Position

Así que en lugar de

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

Puedes usar simplemente 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 });

Desde

2.1.0

Constructores

new Position()

new Position(position): Position

Parámetros

Parámetro	Tipo
position	LogicalPosition | PhysicalPosition

Devuelve

Position

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

Propiedades

Propiedad	Tipo	Definido en
position	LogicalPosition | PhysicalPosition	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L373

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Devuelve

object

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

toJSON()

toJSON(): object

Devuelve

object

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

toLogical()

toLogical(scaleFactor): LogicalPosition

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

LogicalPosition

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

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

PhysicalPosition

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

---

Size

Un tamaño representado ya sea en píxeles físicos o lógicos.

Este tipo es básicamente un tipo de unión de LogicalSize y PhysicalSize pero resulta muy útil cuando usas tauri::Size en Rust como argumento para un comando, ya que esta clase se serializa automáticamente en un formato válido para que pueda deserializarse correctamente en tauri::Size

Así que en lugar de

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

Puedes usar simplemente 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 });

Desde

2.1.0

Constructores

new Size()

new Size(size): Size

Parámetros

Parámetro	Tipo
size	LogicalSize | PhysicalSize

Devuelve

Size

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

Propiedades

Propiedad	Tipo	Definido en
size	LogicalSize | PhysicalSize	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L175

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

Devuelve

object

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

toJSON()

toJSON(): object

Devuelve

object

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

toLogical()

toLogical(scaleFactor): LogicalSize

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

LogicalSize

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

toPhysical()

toPhysical(scaleFactor): PhysicalSize

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

PhysicalSize

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