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

ScalingViewport

open class ScalingViewport(val scaler: Scaler, virtualWidth: Int, virtualHeight: Int, var camera: Camera = OrthographicCamera()) : Viewport

A base Viewport that handles scaling to a virtual width and height.

Author

Colton Daily

Constructors

ScalingViewport

fun ScalingViewport(scaler: Scaler, virtualWidth: Int, virtualHeight: 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.

scaler

val scaler: Scaler

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

FitViewport

StretchViewport

FillViewport