dpi

类

LogicalPosition

以逻辑像素表示的位置。

自

2.0.0

构造函数

new LogicalPosition()

new LogicalPosition(x, y): LogicalPosition

参数

参数	类型
x	number
y	number

返回

LogicalPosition

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

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

参数

参数	类型
object	object
object.Logical	object
object.Logical.x	number
object.Logical.y	number

返回

LogicalPosition

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

new LogicalPosition()

new LogicalPosition(object): LogicalPosition

参数

参数	类型
object	object
object.x	number
object.y	number

返回

LogicalPosition

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

属性

属性	修饰符	类型	默认值	定义于
type	readonly	"Logical"	'Logical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L204
x	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L205
y	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L206

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

object

名称	类型	定义于
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L252
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L253

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

toJSON()

toJSON(): object

返回

object

名称	类型	定义于
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L252
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L253

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

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

将逻辑位置转换为物理位置。

参数

参数	类型
scaleFactor	number

返回

PhysicalPosition

示例

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

自

2.0.0

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

---

LogicalSize

以逻辑像素表示的大小。

自

2.0.0

构造函数

new LogicalSize()

new LogicalSize(width, height): LogicalSize

参数

参数	类型
width	number
height	number

返回

LogicalSize

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

new LogicalSize()

new LogicalSize(object): LogicalSize

参数

参数	类型
object	object
object.Logical	object
object.Logical.height	number
object.Logical.width	number

返回

LogicalSize

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

new LogicalSize()

new LogicalSize(object): LogicalSize

参数

参数	类型
object	object
object.height	number
object.width	number

返回

LogicalSize

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

属性

属性	修饰符	类型	默认值	定义于
height	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L15
type	readonly	"Logical"	'Logical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L13
width	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L14

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

object

名称	类型	定义于
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L62
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L61

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

toJSON()

toJSON(): object

返回

object

名称	类型	定义于
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L62
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L61

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

toPhysical()

toPhysical(scaleFactor): PhysicalSize

将逻辑大小转换为物理大小。

参数

参数	类型
scaleFactor	number

返回

PhysicalSize

示例

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

自

2.0.0

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

---

PhysicalPosition

以物理像素表示的位置。

自

2.0.0

构造函数

new PhysicalPosition()

new PhysicalPosition(x, y): PhysicalPosition

参数

参数	类型
x	number
y	number

返回

PhysicalPosition

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

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

参数

参数	类型
object	object
object.Physical	object
object.Physical.x	number
object.Physical.y	number

返回

PhysicalPosition

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

new PhysicalPosition()

new PhysicalPosition(object): PhysicalPosition

参数

参数	类型
object	object
object.x	number
object.y	number

返回

PhysicalPosition

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

属性

属性	修饰符	类型	默认值	定义于
type	readonly	"Physical"	'Physical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L269
x	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L270
y	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L271

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

object

名称	类型	定义于
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L317
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L318

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

toJSON()

toJSON(): object

返回

object

名称	类型	定义于
x	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L317
y	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L318

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

toLogical()

toLogical(scaleFactor): LogicalPosition

将物理位置转换为逻辑位置。

参数

参数	类型
scaleFactor	number

返回

LogicalPosition

示例

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

自

2.0.0

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

---

PhysicalSize

以物理像素表示的大小。

自

2.0.0

构造函数

new PhysicalSize()

new PhysicalSize(width, height): PhysicalSize

参数

参数	类型
width	number
height	number

返回

PhysicalSize

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

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

参数

参数	类型
object	object
object.Physical	object
object.Physical.height	number
object.Physical.width	number

返回

PhysicalSize

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

new PhysicalSize()

new PhysicalSize(object): PhysicalSize

参数

参数	类型
object	object
object.height	number
object.width	number

返回

PhysicalSize

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

属性

属性	修饰符	类型	默认值	定义于
height	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L80
type	readonly	"Physical"	'Physical'	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L78
width	public	number	undefined	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L79

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

object

名称	类型	定义于
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L123
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L122

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

toJSON()

toJSON(): object

返回

object

名称	类型	定义于
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L123
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L122

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

toLogical()

toLogical(scaleFactor): LogicalSize

将物理大小转换为逻辑大小。

参数

参数	类型
scaleFactor	number

返回

LogicalSize

示例

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: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L116

---

Position

以物理像素或逻辑像素表示的位置。

此类型基本上是 LogicalSize 和 PhysicalSize 的联合类型，但在 Rust 中使用 tauri::Position 作为命令的参数时非常方便，因为此类会自动序列化为有效格式，以便可以正确反序列化为 tauri::Position

所以，与其使用

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

你可以直接使用 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 });

自

2.1.0

构造函数

new Position()

new Position(position): Position

参数

参数	类型
position	LogicalPosition | PhysicalPosition

返回

Position

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

属性

属性	类型	定义于
position	LogicalPosition | PhysicalPosition	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L360

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

object

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

toJSON()

toJSON(): object

返回

object

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

toLogical()

toLogical(scaleFactor): LogicalPosition

参数

参数	类型
scaleFactor	number

返回

LogicalPosition

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

toPhysical()

toPhysical(scaleFactor): PhysicalPosition

参数

参数	类型
scaleFactor	number

返回

PhysicalPosition

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

---

Size

以物理像素或逻辑像素表示的大小。

此类型基本上是 LogicalSize 和 PhysicalSize 的联合类型，但在 Rust 中使用 tauri::Size 作为命令的参数时非常方便，因为此类会自动序列化为有效格式，以便可以正确反序列化为 tauri::Size

所以，与其使用

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

你可以直接使用 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 });

自

2.1.0

构造函数

new Size()

new Size(size): Size

参数

参数	类型
size	LogicalSize | PhysicalSize

返回

Size

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

属性

属性	类型	定义于
size	LogicalSize | PhysicalSize	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/dpi.ts#L165

方法

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): object

返回

object

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

toJSON()

toJSON(): object

返回

object

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

toLogical()

toLogical(scaleFactor): LogicalSize

参数

参数	类型
scaleFactor	number

返回

LogicalSize

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

toPhysical()

toPhysical(scaleFactor): PhysicalSize

参数

参数	类型
scaleFactor	number

返回

PhysicalSize

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