Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: ScaleModes
Phaser.Scale.ScaleModes

Members

<static, constant> ENVELOP: number
Focus
Focus

Description:

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
Focus
Focus
<static, constant> FIT: number
Focus
Focus

Description:

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
Focus
Focus
<static, constant> HEIGHT_CONTROLS_WIDTH: number
Focus
Focus

Description:

The width is automatically adjusted based on the height.

Type:
number
Since: 3.16.0
Focus
Focus
<static, constant> NONE: number
Focus
Focus

Description:

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
Focus
Focus
<static, constant> RESIZE: number
Focus
Focus

Description:

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

Type:
number
Since: 3.16.0
Focus
Focus
<static, constant> WIDTH_CONTROLS_HEIGHT: number
Focus
Focus

Description:

The height is automatically adjusted based on the width.

Type:
number
Since: 3.16.0
Focus
Focus