@zturnlibs/ztron-api

---

dpi#

Classes#

LogicalPosition#

Defined in: dpi.ts:44

A position represented in logical pixels.

Constructors#

Constructor#

new LogicalPosition(x, y): LogicalPosition

Defined in: dpi.ts:46

Parameters#

x#

number

y#

number

Returns#

LogicalPosition

Properties#

type#

readonly type: "Logical"

Defined in: dpi.ts:45

x#

x: number

Defined in: dpi.ts:47

y#

y: number

Defined in: dpi.ts:48

Methods#

toJSON()#

toJSON(): object

Defined in: dpi.ts:55

Returns#

object

x#

x: number

y#

y: number

toPhysical()#

toPhysical(scaleFactor): PhysicalPosition

Defined in: dpi.ts:51

Parameters#

scaleFactor#

number

Returns#

PhysicalPosition

---

LogicalSize#

Defined in: dpi.ts:10

A size represented in logical pixels.

Constructors#

Constructor#

new LogicalSize(width, height): LogicalSize

Defined in: dpi.ts:12

Parameters#

width#

number

height#

number

Returns#

LogicalSize

Properties#

height#

height: number

Defined in: dpi.ts:14

type#

readonly type: "Logical"

Defined in: dpi.ts:11

width#

width: number

Defined in: dpi.ts:13

Methods#

toJSON()#

toJSON(): object

Defined in: dpi.ts:21

Returns#

object

height#

height: number

width#

width: number

toPhysical()#

toPhysical(scaleFactor): PhysicalSize

Defined in: dpi.ts:17

Parameters#

scaleFactor#

number

Returns#

PhysicalSize

---

PhysicalPosition#

Defined in: dpi.ts:61

A position represented in physical pixels.

Constructors#

Constructor#

new PhysicalPosition(x, y): PhysicalPosition

Defined in: dpi.ts:63

Parameters#

x#

number

y#

number

Returns#

PhysicalPosition

Properties#

type#

readonly type: "Physical"

Defined in: dpi.ts:62

x#

x: number

Defined in: dpi.ts:64

y#

y: number

Defined in: dpi.ts:65

Methods#

toJSON()#

toJSON(): object

Defined in: dpi.ts:72

Returns#

object

x#

x: number

y#

y: number

toLogical()#

toLogical(scaleFactor): LogicalPosition

Defined in: dpi.ts:68

Parameters#

scaleFactor#

number

Returns#

LogicalPosition

---

PhysicalSize#

Defined in: dpi.ts:27

A size represented in physical pixels.

Constructors#

Constructor#

new PhysicalSize(width, height): PhysicalSize

Defined in: dpi.ts:29

Parameters#

width#

number

height#

number

Returns#

PhysicalSize

Properties#

height#

height: number

Defined in: dpi.ts:31

type#

readonly type: "Physical"

Defined in: dpi.ts:28

width#

width: number

Defined in: dpi.ts:30

Methods#

toJSON()#

toJSON(): object

Defined in: dpi.ts:38

Returns#

object

height#

height: number

width#

width: number

toLogical()#

toLogical(scaleFactor): LogicalSize

Defined in: dpi.ts:34

Parameters#

scaleFactor#

number

Returns#

LogicalSize

---

Position#

Defined in: dpi.ts:142

Upstream dpi.Position wrapper — logical OR physical resolution.

Constructors#

Constructor#

new Position(source): Position

Defined in: dpi.ts:146

Parameters#

source#

LogicalPosition | PhysicalPosition | { type?: string; x: number; y: number; }

Returns#

Position

Properties#

type#

readonly type: "Logical" | "Physical"

Defined in: dpi.ts:143

x#

x: number

Defined in: dpi.ts:144

y#

y: number

Defined in: dpi.ts:145

Methods#

toJSON()#

toJSON(): object

Defined in: dpi.ts:166

Returns#

object

type#

type: string

x#

x: number

y#

y: number

toLogical()#

toLogical(scaleFactor): LogicalPosition

Defined in: dpi.ts:156

Parameters#

scaleFactor#

number

Returns#

LogicalPosition

toPhysical()#

toPhysical(scaleFactor): PhysicalPosition

Defined in: dpi.ts:161

Parameters#

scaleFactor#

number

Returns#

PhysicalPosition

---

Size#

Defined in: dpi.ts:106

Upstream dpi.Size wrapper — logical OR physical resolution.

Constructors#

Constructor#

new Size(source): Size

Defined in: dpi.ts:108

Parameters#

source#

LogicalSize | PhysicalSize | { height: number; type?: string; width: number; }

Returns#

Size

Properties#

height#

height: number

Defined in: dpi.ts:125

type#

readonly type: "Logical" | "Physical"

Defined in: dpi.ts:107

width#

width: number

Defined in: dpi.ts:124

Methods#

toJSON()#

toJSON(): object

Defined in: dpi.ts:136

Returns#

object

height#

height: number

type#

type: string

width#

width: number

toLogical()#

toLogical(scaleFactor): LogicalSize

Defined in: dpi.ts:126

Parameters#

scaleFactor#

number

Returns#

LogicalSize

toPhysical()#

toPhysical(scaleFactor): PhysicalSize

Defined in: dpi.ts:131

Parameters#

scaleFactor#

number

Returns#

PhysicalSize

Type Aliases#

PositionLike#

PositionLike = number | LogicalPosition | PhysicalPosition | { x: number; y: number; }

Defined in: dpi.ts:79

---

SizeLike#

SizeLike = number | LogicalSize | PhysicalSize | { height: number; width: number; }

Defined in: dpi.ts:78

Anything the window geometry methods accept as a size/position value.

Functions#

normalizePosition()#

normalizePosition(a, b?): object

Defined in: dpi.ts:94

Normalizes a position-like pair of arguments to plain { x, y }.

Parameters#

a#

PositionLike

b?#

number

Returns#

object

x#

x: number

y#

y: number

---

normalizeSize()#

normalizeSize(a, b?): object

Defined in: dpi.ts:82

Normalizes a size-like pair of arguments to plain { width, height }.

Parameters#

a#

SizeLike

b?#

number

Returns#

object

height#

height: number

width#

width: number