Logo

DOME

The comfortable framework for making games in Wren

View the Project on GitHub avivbeeri/dome

< Back

dome

The dome module allows you to control various aspects of how DOME as an application operates.

It contains the following classes:

Process

Static Methods

static exit(): Void

static exit(code: Number): Void

Allows you to programmatically close DOME. This command behaves a little differently based on whether an error code is provided (defaults to 0):

Version

This class provides information about the version of DOME which is currently running. You can use this to check that all the features you require are supported. DOME uses semantic versioning, split into a major.minor.patch breakdown.

Static Fields

static major: Number

The major component of the version number.

static minor: Number

The minor component of the version number.

static patch: Number

The patch component of the version number.

static toString: String

A string containing the complete semantic version of the DOME instance running.

static toList: List<Number>

A list of the version components, in [major, minor, patch] order.

Static Methods

static atLeast(version: String): boolean

This takes a version as a string of the form x.y.z, and returns true if the current version of DOME is at least that of the version specified.

Window

Static Fields

static fullscreen: Boolean

Set this to switch between Windowed and Fullscreen modes.

static height: Number

This is the height of the window/viewport, in pixels.

static lockstep: Boolean

Setting this to true will disable “catch up” game loop behaviour. This is useful for lighter games, or on systems where you experience a little stuttering at 60fps.

static title: String

This allows you to set and get the title of the DOME window.

static vsync: String

Setting this to true will make the renderer wait for VSync before presenting to the display. Changing this value is an expensive operation and so shouldn’t be done frequently.

static width: Number

This is the width of the window/viewport, in pixels.

Static Methods

static resize(width: Number, height: Number): Void

This allows you to control the size of DOME’s window. The viewport will scale accordingly, but the canvas will NOT resize.