core/com.lehaine.littlekt.util.viewport/ScreenViewport

ScreenViewport

class ScreenViewport(var x: Int, var y: Int, var width: Int, var height: Int, var camera: Camera = OrthographicCamera()) : Viewport

A viewport that uses a virtual size that will always match the window size. No scaling happens along with no black bars appearing.

Author

Colton Daily

Constructors

ScreenViewport

fun ScreenViewport(width: Int, height: Int, camera: Camera = OrthographicCamera())

ScreenViewport

fun ScreenViewport(x: Int, y: Int, width: Int, height: Int, camera: Camera = OrthographicCamera())

Functions

apply

fun apply(context: Context, centerCamera: Boolean = false)

Sets the OpenGL viewport based on viewport and virtual sizes by calling GL.viewport.

isInViewport

fun isInViewport(x: Float, y: Float): Boolean

set

fun set(x: Int, y: Int, width: Int, height: Int)

Set the viewport position and size.

toString

open override fun toString(): String

update

open override fun update(width: Int, height: Int, context: Context, centerCamera: Boolean)

Resize the viewport based new size. If using the base Viewport this function must be overridden for it to do anything other than apply the current viewport size.

Properties

aspectRatio

val aspectRatio: Float

camera

var camera: Camera

height

var height: Int = 0

The height of the viewport.

unitsPerPixel

var unitsPerPixel: Float = 1.0f

The number of pixels for each world unit. Eg: a scale of 2.5f means there are 2.5f world units for every 1 screen pixel.

virtualHeight

var virtualHeight: Float

The virtual/world height.

virtualWidth

var virtualWidth: Float

The virtual/world width.

width

var width: Int = 0

The width of the viewport.

var x: Int = 0

var y: Int = 0