com.badlogic.gdx.utils.viewport

Class ScreenViewport

java.lang.Object

com.badlogic.gdx.utils.viewport.Viewport

com.badlogic.gdx.utils.viewport.ScreenViewport

public class ScreenViewport
extends Viewport

A viewport where the world size is based on the size of the screen. By default 1 world unit == 1 screen pixel, but this ratio can be changed.

Author:

Daniel Holderbaum, Nathan Sweet

Constructor Summary

Constructors

Constructor and Description
ScreenViewport() Creates a new viewport using a new OrthographicCamera.
ScreenViewport(Camera camera)

Method Summary

Modifier and Type	Method and Description
float	getUnitsPerPixel()
void	setUnitsPerPixel(float unitsPerPixel) Sets the number of pixels for each world unit.
void	update(int screenWidth, int screenHeight, boolean centerCamera) Configures this viewport's screen bounds using the specified screen size and calls Viewport.apply(boolean).

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

apply, apply, calculateScissors, getBottomGutterHeight, getCamera, getLeftGutterWidth, getPickRay, getRightGutterWidth, getRightGutterX, getScreenHeight, getScreenWidth, getScreenX, getScreenY, getTopGutterHeight, getTopGutterY, getWorldHeight, getWorldWidth, project, project, setCamera, setScreenBounds, setScreenHeight, setScreenPosition, setScreenSize, setScreenWidth, setScreenX, setScreenY, setWorldHeight, setWorldSize, setWorldWidth, toScreenCoordinates, unproject, unproject, update

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenViewport

public ScreenViewport()

Creates a new viewport using a new OrthographicCamera.

ScreenViewport

public ScreenViewport(Camera camera)

Method Detail

update

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

Description copied from class: Viewport

Configures this viewport's screen bounds using the specified screen size and calls Viewport.apply(boolean). Typically called from ApplicationListener.resize(int, int) or Screen.resize(int, int).

The default implementation only calls Viewport.apply(boolean).

Overrides:

update in class Viewport

getUnitsPerPixel

public float getUnitsPerPixel()

setUnitsPerPixel

public void setUnitsPerPixel(float unitsPerPixel)

Sets the number of pixels for each world unit. Eg, a scale of 2.5 means there are 2.5 world units for every 1 screen pixel. Default is 1.