Host · interface

DisplayInfo

A display the game could be shown on, as the platform reports it.

interface DisplayInfo

import type { DisplayInfo } from '@driftengine/core';

Properties

Name	Type	Description
`id`readonly	`string`	Stable for as long as the display is attached. Opaque: do not parse it.
`label`readonly	`string`	What to show in a list. A platform that has no name for it repeats the size.
`width`readonly	`number`	Logical pixels, which is what a window is sized in.
`height`readonly	`number`
`scale`readonly	`number`	Device pixels per logical pixel on this display.
`refreshHz`readonly	`number \| null`	Null where the platform will not say, which includes every browser.
`primary`readonly	`boolean`