You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Namespace: Scale

Phaser. Scale

Source: src/scale/index.js (Line 10)

Classes

ScaleManager

Namespaces

Center
Events
Orientation
ScaleModes
Zoom

Members

<static, constant> CENTER_BOTH :number

The game canvas is centered both horizontally and vertically within the parent. To do this, the parent has to have a bounds that can be calculated and not be empty.

Centering is achieved by setting the margin left and top properties of the game canvas, and does not factor in any other CSS styles you may have applied.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/CENTER_CONST.js (Line 38)

<static, constant> CENTER_HORIZONTALLY :number

The game canvas is centered horizontally within the parent. To do this, the parent has to have a bounds that can be calculated and not be empty.

Centering is achieved by setting the margin left and top properties of the game canvas, and does not factor in any other CSS styles you may have applied.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/CENTER_CONST.js (Line 52)

<static, constant> CENTER_VERTICALLY :number

The game canvas is centered both vertically within the parent. To do this, the parent has to have a bounds that can be calculated and not be empty.

Centering is achieved by setting the margin left and top properties of the game canvas, and does not factor in any other CSS styles you may have applied.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/CENTER_CONST.js (Line 66)

<static, constant> ENVELOP :number

The width and height are automatically adjusted to make the size cover the entire target area while keeping the aspect ratio. This may extend further out than the target size.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 71)

<static, constant> FIT :number

The width and height are automatically adjusted to fit inside the given target area, while keeping the aspect ratio. Depending on the aspect ratio there may be some space inside the area which is not covered.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 59)

<static, constant> HEIGHT_CONTROLS_WIDTH :number

The width is automatically adjusted based on the height.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 49)

<static, constant> LANDSCAPE :string

A landscape orientation.

Type:
  • string
Since: 3.16.0
Source: src/scale/const/ORIENTATION_CONST.js (Line 27)

<static, constant> MAX_ZOOM :number

Calculate the zoom value based on the maximum multiplied game size that will fit into the parent, or browser window if no parent is set.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/ZOOM_CONST.js (Line 57)

<static, constant> NO_CENTER :number

The game canvas is not centered within the parent by Phaser. You can still center it yourself via CSS.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/CENTER_CONST.js (Line 27)

<static, constant> NO_ZOOM :number

The game canvas will not be zoomed by Phaser.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/ZOOM_CONST.js (Line 27)

<static, constant> NONE :number

No scaling happens at all. The canvas is set to the size given in the game config and Phaser doesn't change it again from that point on. If you change the canvas size, either via CSS, or directly via code, then you need to call the Scale Managers resize method to give the new dimensions, or input events will stop working.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 27)

<static, constant> PORTRAIT :string

A portrait orientation.

Type:
  • string
Since: 3.16.0
Source: src/scale/const/ORIENTATION_CONST.js (Line 37)

<static, constant> RESIZE :number

The Canvas is resized to fit all available parent space, regardless of aspect ratio.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 82)

<static, constant> WIDTH_CONTROLS_HEIGHT :number

The height is automatically adjusted based on the width.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 39)

<static, constant> ZOOM_2X :number

The game canvas will be 2x zoomed by Phaser.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/ZOOM_CONST.js (Line 37)

<static, constant> ZOOM_4X :number

The game canvas will be 4x zoomed by Phaser.

Type:
  • number
Since: 3.16.0
Source: src/scale/const/ZOOM_CONST.js (Line 47)

Type Definitions

CenterType

Phaser Scale Manager constants for centering the game canvas.

To find out what each mode does please see Phaser.Scale.Center.

Type:
Since: 3.16.0
Source: src/scale/const/CENTER_CONST.js (Line 15)

OrientationType

Phaser Scale Manager constants for orientation.

To find out what each mode does please see Phaser.Scale.Orientation.

Type:
Since: 3.16.0
Source: src/scale/const/ORIENTATION_CONST.js (Line 15)

ScaleModeType

Phaser Scale Manager constants for the different scale modes available.

To find out what each mode does please see Phaser.Scale.ScaleModes.

Type:
Since: 3.16.0
Source: src/scale/const/SCALE_MODE_CONST.js (Line 15)

ZoomType

Phaser Scale Manager constants for zoom modes.

To find out what each mode does please see Phaser.Scale.Zoom.

Type:
Since: 3.16.0
Source: src/scale/const/ZOOM_CONST.js (Line 15)