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

Viewport

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

A base viewport where the virtual size is the same as the viewport/screen size.

Author

Colton Daily

Constructors

Viewport

fun Viewport(x: Int = 0, y: Int = 0, width: Int = 0, height: Int = 0, 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 fun update(width: Int, height: Int, context: Context, centerCamera: Boolean = false)

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.

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

Inheritors

ExtendViewport

ScalingViewport

ScreenViewport