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: Events
Phaser.Scale.Events
Source: src/scale/events/index.js (Line 7)

Events

ENTER_FULLSCREEN
Focus
Focus

Description:

The Scale Manager has successfully entered fullscreen mode.

Since: 3.16.1
Focus
Focus
FULLSCREEN_FAILED
Focus
Focus

Description:

The Scale Manager tried to enter fullscreen mode but failed.

Since: 3.17.0
Focus
Focus
FULLSCREEN_UNSUPPORTED
Focus
Focus

Description:

The Scale Manager tried to enter fullscreen mode, but it is unsupported by the browser.

Focus
Focus
LEAVE_FULLSCREEN
Focus
Focus

Description:

The Scale Manager was in fullscreen mode, but has since left, either directly via game code, or via a user gestured, such as pressing the ESC key.

Since: 3.16.1
Focus
Focus
ORIENTATION_CHANGE
Focus
Focus

Description:

The Scale Manager Orientation Change Event.

This event is dispatched whenever the Scale Manager detects an orientation change event from the browser.

Parameters:

name type description
orientation string

The new orientation value. Either Phaser.Scale.Orientation.LANDSCAPE or Phaser.Scale.Orientation.PORTRAIT.

Since: 3.16.1
Focus
Focus
RESIZE
Focus
Focus

Description:

The Scale Manager Resize Event.

This event is dispatched whenever the Scale Manager detects a resize event from the browser. It sends three parameters to the callback, each of them being Size components. You can read the width, height, aspectRatio and other properties of these components to help with scaling your own game content.

Parameters:

name type description
gameSize Phaser.Structs.Size

A reference to the Game Size component. This is the un-scaled size of your game canvas.

baseSize Phaser.Structs.Size

A reference to the Base Size component. This is the game size.

displaySize Phaser.Structs.Size

A reference to the Display Size component. This is the scaled canvas size, after applying zoom and scale mode.

previousWidth number

If the gameSize has changed, this value contains its previous width, otherwise it contains the current width.

previousHeight number

If the gameSize has changed, this value contains its previous height, otherwise it contains the current height.

Since: 3.16.1
Focus
Focus