new StageScaleMode(game, width, height)
The StageScaleMode object is responsible for helping you manage the scaling, resizing and alignment of your game within the browser.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | A reference to the currently running game. |
width |
number | The native width of the game. |
height |
number | The native height of the game. |
- Source:
Members
-
<static, constant> EXACT_FIT :number
-
Type:
- number
- Source:
-
<static, constant> NO_SCALE :number
-
Type:
- number
- Source:
-
<static, constant> SHOW_ALL :number
-
Type:
- number
- Source:
-
<readonly> aspectRatio
-
- Source:
Properties:
Name Type Description aspectRationumber The aspect ratio of the scaled game.
-
enterIncorrectOrientation
-
- Source:
Properties:
Name Type Description enterIncorrectOrientationPhaser.Signal The event that is dispatched when the browser enters an incorrect orientation, as defined by forceOrientation.
-
enterLandscape
-
- Source:
Properties:
Name Type Description enterLandscapePhaser.Signal The event that is dispatched when the browser enters landscape orientation.
-
enterPortrait
-
- Source:
Properties:
Name Type Description enterPortraitPhaser.Signal The event that is dispatched when the browser enters horizontal orientation.
-
event
-
- Source:
Properties:
Name Type Description event-any The native browser events from full screen API changes.
-
forceLandscape
-
- Default Value:
- false
- Source:
Properties:
Name Type Description forceLandscapeboolean If the game should be forced to use Landscape mode, this is set to true by Game.Stage
-
forcePortrait
-
- Default Value:
- false
- Source:
Properties:
Name Type Description forcePortraitboolean If the game should be forced to use Portrait mode, this is set to true by Game.Stage
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
hasResized
-
- Source:
Properties:
Name Type Description hasResizedPhaser.Signal The event that is dispatched when the game scale changes.
-
height
-
- Source:
Properties:
Name Type Description heightnumber Height of the stage after calculation.
-
incorrectOrientation
-
- Default Value:
- false
- Source:
Properties:
Name Type Description incorrectOrientationboolean If the game should be forced to use a specific orientation and the device currently isn't in that orientation this is set to true.
-
<readonly> isFullScreen
-
- Source:
Properties:
Name Type Description isFullScreenboolean Returns true if the browser is in full screen mode, otherwise false.
-
<readonly> isLandscape
-
- Source:
Properties:
Name Type Description isLandscapeboolean Returns true if the browser dimensions match a landscape display.
-
<readonly> isPortrait
-
- Source:
Properties:
Name Type Description isPortraitboolean Returns true if the browser dimensions match a portrait display.
-
leaveIncorrectOrientation
-
- Source:
Properties:
Name Type Description leaveIncorrectOrientationPhaser.Signal The event that is dispatched when the browser leaves an incorrect orientation, as defined by forceOrientation.
-
<readonly> margin
-
- Source:
Properties:
Name Type Description marginPhaser.Point If the game canvas is seto to align by adjusting the margin, the margin calculation values are stored in this Point.
-
maxHeight
-
- Source:
Properties:
Name Type Description maxHeightnumber Maximum height the canvas should be scaled to (in pixels). If null it will scale to whatever height the browser can handle.
-
maxIterations
-
- Default Value:
- 5
- Source:
Properties:
Name Type Description maxIterationsnumber The maximum number of times it will try to resize the canvas to fill the browser.
-
maxWidth
-
- Source:
Properties:
Name Type Description maxWidthnumber Maximum width the canvas should be scaled to (in pixels). If null it will scale to whatever width the browser can handle.
-
minHeight
-
- Source:
Properties:
Name Type Description minHeightnumber Minimum height the canvas should be scaled to (in pixels).
-
minWidth
-
- Source:
Properties:
Name Type Description minWidthnumber Minimum width the canvas should be scaled to (in pixels).
-
orientation
-
- Source:
Properties:
Name Type Description orientationnumber The orientation value of the game (as defined by window.orientation if set). 90 = landscape. 0 = portrait.
-
orientationSprite
-
- Source:
Properties:
Name Type Description orientationSpritePIXI.Sprite The Sprite that is optionally displayed if the browser enters an unsupported orientation.
-
pageAlignHorizontally
-
- Default Value:
- false
- Source:
Properties:
Name Type Description pageAlignHorizontallyboolean If you wish to align your game in the middle of the page then you can set this value to true. It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation/resizing. It doesn't care about any other DOM element that may be on the page, it literally just sets the margin.
-
pageAlignVertically
-
- Default Value:
- false
- Source:
Properties:
Name Type Description pageAlignVerticallyboolean If you wish to align your game in the middle of the page then you can set this value to true. It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation/resizing. It doesn't care about any other DOM element that may be on the page, it literally just sets the margin.
-
<readonly> scaleFactor
-
- Source:
Properties:
Name Type Description scaleFactorPhaser.Point The scale factor based on the game dimensions vs. the scaled dimensions.
-
<readonly> scaleFactorInversed
-
- Source:
Properties:
Name Type Description scaleFactorInversedPhaser.Point The inversed scale factor. The displayed dimensions divided by the game dimensions.
-
scaleMode
-
- Source:
Properties:
Name Type Description scaleModenumber The current scaleMode.
-
<readonly> sourceAspectRatio
-
- Source:
Properties:
Name Type Description sourceAspectRationumber The aspect ratio (width / height) of the original game dimensions.
-
width
-
- Source:
Properties:
Name Type Description widthnumber Width of the stage after calculation.
Methods
-
checkOrientation(event)
-
Handle window.orientationchange events
Parameters:
Name Type Description eventEvent The orientationchange event data.
- Source:
-
checkOrientationState()
-
Checks if the browser is in the correct orientation for your game (if forceLandscape or forcePortrait have been set)
- Source:
-
checkResize(event)
-
Handle window.resize events
Parameters:
Name Type Description eventEvent The resize event data.
- Source:
-
forceOrientation(forceLandscape, forcePortrait, orientationImage)
-
If you need your game to run in only one orientation you can force that to happen. The optional orientationImage is displayed when the game is in the incorrect orientation.
Parameters:
Name Type Argument Default Description forceLandscapeboolean true if the game should run in landscape mode only.
forcePortraitboolean <optional>
false true if the game should run in portrait mode only.
orientationImagestring <optional>
'' The string of an image in the Phaser.Cache to display when this game is in the incorrect orientation.
- Source:
-
<protected> fullScreenChange(event)
-
Called automatically when the browser enters of leaves full screen mode.
Parameters:
Name Type Description eventEvent The fullscreenchange event
- Source:
-
refresh()
-
Re-calculate scale mode and update screen size.
- Source:
-
setExactFit()
-
Sets the width and height values of the canvas, no larger than the maxWidth/Height.
- Source:
-
setMaximum()
-
Sets this.width equal to window.innerWidth and this.height equal to window.innerHeight
- Source:
-
setScreenSize(force)
-
Set screen size automatically based on the scaleMode.
Parameters:
Name Type Description forceboolean If force is true it will try to resize the game regardless of the document dimensions.
- Source:
-
setShowAll()
-
Calculates the multiplier needed to scale the game proportionally.
- Source:
-
setSize()
-
Sets the canvas style width and height values based on minWidth/Height and maxWidth/Height.
- Source:
-
startFullScreen(antialias)
-
Tries to enter the browser into full screen mode. Please note that this needs to be supported by the web browser and isn't the same thing as setting your game to fill the browser.
Parameters:
Name Type Description antialiasboolean You can toggle the anti-alias feature of the canvas before jumping in to full screen (false = retain pixel art, true = smooth art)
- Source:
-
stopFullScreen()
-
Stops full screen mode if the browser is in it.
- Source: