korge/korlibs.korge.scene

Package-level declarations

Types

CompletableScene

abstract class CompletableScene<T> : Scene

EmptyScene

class EmptyScene : Scene

LogScene

abstract class LogScene : Scene

OldScaledScene

abstract class ~~OldScaledScene~~ : Scene

PixelatedScene

abstract class PixelatedScene(sceneWidth: Int, sceneHeight: Int, sceneScaleMode: ScaleMode = ScaleMode.SHOW_ALL, sceneAnchor: Anchor = Anchor.CENTER, sceneSmoothing: Boolean = false) : ScaledScene

ScaledScene

abstract class ScaledScene(sceneWidth: Int, sceneHeight: Int, sceneScaleMode: ScaleMode = ScaleMode.SHOW_ALL, sceneAnchor: Anchor = Anchor.CENTER, sceneSmoothing: Boolean = true) : Scene

A Scene where the effective container has a fixed size sceneWidth and sceneHeight, and scales and positions its SceneContainer based on sceneScaleMode and sceneAnchor. Performs a linear or nearest neighborhood interpolation based sceneSmoothing.

Scene

abstract class Scene : InjectorDependency, ViewsContainer, CoroutineScope, ResourcesContainer, Extra

Acts as a controller. Subclasses must override at least one of: sceneInit or sceneMain.

SceneContainer

class SceneContainer(val views: Views, val defaultTransition: Transition = AlphaTransition.withEasing(Easing.EASE_IN_OUT_QUAD), name: String = "sceneContainer", size: Size = views.stage.size) : UIView, CoroutineScope

A Container that can hold Scenes controllers and contains a history. It changes between scene objects by using the Injector and allow to use Transitions for the change. You can apply a easing to the Transition by calling Transition.withEasing.

Transition

interface Transition

TransitionProcess

interface TransitionProcess

TransitionView

class TransitionView : Container

A View that will render prev and next views using the specified transition. You can set the prev and next views by calling setViews.

Properties

AlphaTransition

val AlphaTransition: Transition

A Transition that will blend prev and next by adjusting its alphas

Functions

changeToResult

inline suspend fun <T : CompletableScene<R>, R> SceneContainer.changeToResult(vararg injects: Any, time: TimeSpan = 0.milliseconds, transition: Transition = AlphaTransition): R

delay

suspend fun Scene.delay(time: TimeSpan)

MaskTransition

fun MaskTransition(transition: TransitionFilter.Transition = TransitionFilter.Transition.CIRCULAR, reversed: Boolean = false, spread: Double = 1.0, filtering: Boolean = true): Transition

A Transition that will use a transition to show the new scene.

sceneContainer

inline suspend fun Container.sceneContainer(defaultTransition: Transition = AlphaTransition.withEasing(Easing.EASE_IN_OUT_QUAD), name: String = "sceneContainer", size: Size = Size.ZERO, callback: SceneContainer.() -> Unit = {}): SceneContainer

inline fun Container.sceneContainer(views: Views, defaultTransition: Transition = AlphaTransition.withEasing(Easing.EASE_IN_OUT_QUAD), name: String = "sceneContainer", size: Size = Size(0f, 0f), callback: SceneContainer.() -> Unit = {}): SceneContainer

Creates a new SceneContainer, allowing to configure with callback, and attaches the newly created container to the receiver this Container It requires to specify the Views singleton instance, and allows to specify a defaultTransition.

Transition

fun Transition(name: String = "Transition", render: (ctx: RenderContext, prev: View, next: View, ratio: Ratio) -> Unit): Transition

TransitionCreate

fun TransitionCreate(name: String = "Transition", block: () -> TransitionProcess): Transition

TransitionProcess

fun TransitionProcess(name: String = "Transition", render: (ctx: RenderContext, prev: View, next: View, ratio: Ratio) -> Unit): TransitionProcess

withEasing

fun Transition.withEasing(easing: Easing): Transition

Creates a new Transition with an Easing specified