libGDX 1.14.2 · com.badlogic.gdx.utils.viewport.ExtendViewport

A viewport that keeps the world aspect ratio by both scaling and extending the world. By default, the world is first scaled to fit within the viewport using Scaling#fit, then the shorter dimension is lengthened to fill the viewport. Other scaling, such as Scaling#contain, may lengthen the world in both directions. A maximum size can be specified to limit how much the world is extended and black bars (letterboxing) are used for any remaining space.

Field Summary

Modifier and Type	Field and Description
private float	maxWorldHeight
private float	maxWorldWidth
private float	minWorldHeight
private float	minWorldWidth
private Scaling	scaling

Constructor Summary

Access	Constructor and Description
public	ExtendViewport(float minWorldWidth, float minWorldHeight) Creates a new viewport using a new `OrthographicCamera` with no maximum world size.
public	ExtendViewport(float minWorldWidth, float minWorldHeight, Camera camera) Creates a new viewport with no maximum world size.
public	ExtendViewport(float minWorldWidth, float minWorldHeight, float maxWorldWidth, float maxWorldHeight) Creates a new viewport using a new `OrthographicCamera` and a maximum world size.
public	ExtendViewport(float minWorldWidth, float minWorldHeight, float User 0 for no maximum width. maxWorldWidth, float User 0 for no maximum height. maxWorldHeight, Camera camera) Creates a new viewport with a maximum world size.

Method Summary

Modifier and Type	Method and Description
public float	getMaxWorldHeight()
public float	getMaxWorldWidth()
public float	getMinWorldHeight()
public float	getMinWorldWidth()
public void	setMaxWorldHeight(float maxWorldHeight)
public void	setMaxWorldWidth(float maxWorldWidth)
public void	setMinWorldHeight(float minWorldHeight)
public void	setMinWorldWidth(float minWorldWidth)
public void	setScaling(Scaling scaling)
public void	update(int screenWidth, int screenHeight, boolean centerCamera) Overrides com.badlogic.gdx.utils.viewport.Viewport.update. Configures this viewport's screen bounds using the specified screen size and calls `apply(boolean)`.

Field Detail

maxWorldHeight	back to summary
private float maxWorldHeight

maxWorldWidth	back to summary
private float maxWorldWidth

minWorldHeight	back to summary
private float minWorldHeight

minWorldWidth	back to summary
private float minWorldWidth

scaling	back to summary
private Scaling scaling

Constructor Detail

ExtendViewport	back to summary
public ExtendViewport(float minWorldWidth, float minWorldHeight) Creates a new viewport using a new `OrthographicCamera` with no maximum world size.

ExtendViewport	back to summary
public ExtendViewport(float minWorldWidth, float minWorldHeight, Camera camera) Creates a new viewport with no maximum world size.

ExtendViewport back to summary

ExtendViewport	back to summary
public ExtendViewport(float minWorldWidth, float minWorldHeight, float maxWorldWidth, float maxWorldHeight) Creates a new viewport using a new `OrthographicCamera` and a maximum world size. See Also `ExtendViewport#ExtendViewport(float, float, float, float, Camera)`

public ExtendViewport(float minWorldWidth, float minWorldHeight, float maxWorldWidth, float maxWorldHeight)

Creates a new viewport using a new OrthographicCamera and a maximum world size.

See Also: ExtendViewport#ExtendViewport(float, float, float, float, Camera)

ExtendViewport	back to summary
public ExtendViewport(float minWorldWidth, float minWorldHeight, float maxWorldWidth, float maxWorldHeight, Camera camera) Creates a new viewport with a maximum world size. Parameters maxWorldWidth:float User 0 for no maximum width. maxWorldHeight:float User 0 for no maximum height.

ExtendViewport

back to summary

public ExtendViewport(float minWorldWidth, float minWorldHeight, float maxWorldWidth, float maxWorldHeight, Camera camera)

Creates a new viewport with a maximum world size.

Parameters

maxWorldWidth:float: User 0 for no maximum width.
maxWorldHeight:float: User 0 for no maximum height.

Method Detail

getMaxWorldHeight	back to summary
public float getMaxWorldHeight()

getMaxWorldWidth	back to summary
public float getMaxWorldWidth()

getMinWorldHeight	back to summary
public float getMinWorldHeight()

getMinWorldWidth	back to summary
public float getMinWorldWidth()

setMaxWorldHeight	back to summary
public void setMaxWorldHeight(float maxWorldHeight)

setMaxWorldWidth	back to summary
public void setMaxWorldWidth(float maxWorldWidth)

setMinWorldHeight	back to summary
public void setMinWorldHeight(float minWorldHeight)

setMinWorldWidth	back to summary
public void setMinWorldWidth(float minWorldWidth)

setScaling	back to summary
public void setScaling(Scaling scaling)

update back to summary

update	back to summary
public void update(int screenWidth, int screenHeight, boolean centerCamera) Overrides com.badlogic.gdx.utils.viewport.Viewport.update. Doc from com.badlogic.gdx.utils.viewport.Viewport.update. Configures this viewport's screen bounds using the specified screen size and calls `apply(boolean)`. Typically called from `ApplicationListener#resize(int, int)` or `Screen#resize(int, int)`. The default implementation only calls `apply(boolean)`.

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

Overrides com.badlogic.gdx.utils.viewport.Viewport.update.

Doc from com.badlogic.gdx.utils.viewport.Viewport.update.

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