com.badlogic.gdx.utils.viewport

Class ScalingViewport

java.lang.Object

com.badlogic.gdx.utils.viewport.Viewport

com.badlogic.gdx.utils.viewport.ScalingViewport

Direct Known Subclasses:

FillViewport, FitViewport, StretchViewport

public class ScalingViewport
extends Viewport

A viewport that scales the world using Scaling.

Scaling.fit keeps the aspect ratio by scaling the world up to fit the screen, adding black bars (letterboxing) for the remaining space.

Scaling.fill keeps the aspect ratio by scaling the world up to take the whole screen (some of the world may be off screen).

Scaling.stretch does not keep the aspect ratio, the world is scaled to take the whole screen.

Scaling.none keeps the aspect ratio by using a fixed size world (the world may not fill the screen or some of the world may be off screen).

Author:

Daniel Holderbaum, Nathan Sweet

Constructor Summary

Constructors

Constructor and Description
ScalingViewport(Scaling scaling, float worldWidth, float worldHeight) Creates a new viewport using a new OrthographicCamera.
ScalingViewport(Scaling scaling, float worldWidth, float worldHeight, Camera camera)

Method Summary

Methods

Modifier and Type	Method and Description
Scaling	getScaling()
void	setScaling(Scaling scaling)
void	update(int screenWidth, int screenHeight, boolean centerCamera) Updates the viewport's camera.

Methods inherited from class com.badlogic.gdx.utils.viewport.Viewport

calculateScissors, getBottomGutterHeight, getCamera, getLeftGutterWidth, getPickRay, getRightGutterWidth, getRightGutterX, getTopGutterHeight, getTopGutterY, getViewportHeight, getViewportWidth, getViewportX, getViewportY, getWorldHeight, getWorldWidth, project, project, setCamera, setWorldHeight, setWorldSize, setWorldWidth, toScreenCoordinates, unproject, unproject, update, update

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalingViewport

public ScalingViewport(Scaling scaling,
               float worldWidth,
               float worldHeight)

Creates a new viewport using a new OrthographicCamera.

ScalingViewport

public ScalingViewport(Scaling scaling,
               float worldWidth,
               float worldHeight,
               Camera camera)

Method Detail

update

public void update(int screenWidth,
          int screenHeight,
          boolean centerCamera)

Description copied from class: Viewport

Updates the viewport's camera. Typically called from ApplicationListener#resize(int, int) or Screen#resize(int, int).

The default implementation calls GL20.glViewport(int, int, int, int) and configures the camera viewport size.

Overrides:

update in class Viewport

centerCamera - If true, the camera position is set to the center of the world.

getScaling

public Scaling getScaling()

setScaling

public void setScaling(Scaling scaling)