core/com.lehaine.littlekt

Package-level declarations

Types

class AndroidClipboard(val context: Context) : Clipboard

class AndroidConfiguration(val activity: Activity, val title: String, val backgroundColor: Color = Color.CLEAR, val showStatusBar: Boolean = true, val useImmersiveMode: Boolean = true, val useWakeLock: Boolean = true) : ContextConfiguration

AndroidContext

class AndroidContext(val configuration: AndroidConfiguration) : Context

AndroidGL

class AndroidGL(engineStats: EngineStats) : GL

AndroidGraphics

class AndroidGraphics(engineStats: EngineStats) : Graphics, GLSurfaceView.Renderer

AppStats

class AppStats

Application runtime statistics.

AssetProvider

open class AssetProvider(val context: Context)

Provides helper functions to load and prepare assets without having to use null or lateinit.

BitmapFontAssetParameter

class BitmapFontAssetParameter(val magFilter: TexMagFilter = TexMagFilter.NEAREST, val mipmaps: Boolean = true, val preloadedTextures: List<TextureSlice> = listOf()) : GameAssetParameters

Context

abstract class Context

The context of the application. This contains instances and references to the OpenGL context and utilities to assist in creating an OpenGL applicaiton.

ContextConfiguration

abstract class ContextConfiguration

ContextListener

abstract class ContextListener(val context: Context)

A ContextListener is the base of an Context when it is created, rendering, or destroyed.

Disposable

interface Disposable

EmptyGameAssetParameter

class EmptyGameAssetParameter : GameAssetParameters

EngineStats

class EngineStats

OpenGL related engine stats.

Experimental

annotation class Experimental

Signals that the annotated annotation class is a marker of an experimental LittleKt API. This means that the API marked is likely unstable and subject to changes without notice.

Game

open class Game<SceneType : Scene>(val context: Context, firstScene: SceneType? = null) : ContextListener

A ContextListener that handles commonly loading assets and preparing assets. Handles scene switching and caching.

GameAsset

class GameAsset<T>(val vfsFile: VfsFile)

GameAssetParameters

interface GameAssetParameters

Graphics

interface Graphics

Contains graphic related properties and methods.

JsClipboard

class JsClipboard : Clipboard

JsConfiguration

class JsConfiguration(val title: String = "LittleKt - JS", val canvasId: String = "canvas", val rootPath: String = "./", val backgroundColor: Color = Color.CLEAR) : ContextConfiguration

JvmClipboard

class JvmClipboard(window: Long) : Clipboard

JvmConfiguration

class JvmConfiguration(val title: String, val width: Int, val height: Int, val vSync: Boolean, val icons: List<String>, val backgroundColor: Color, val resizeable: Boolean, val maximized: Boolean, val windowPosX: Int?, val windowPosY: Int?) : ContextConfiguration

LDtkGameAssetParameter

class LDtkGameAssetParameter(val atlas: TextureAtlas? = null, val tilesetBorderThickness: Int = 2) : GameAssetParameters

LittleKtActivity

abstract class LittleKtActivity : Activity

LittleKtApp

class LittleKtApp(val context: Context)

The base app from starting and stopping a Context.

LittleKtProps

actual class LittleKtProps

expect class LittleKtProps

Properties related to creating a LittleKtApp

actual class LittleKtProps

LwjglContext

class LwjglContext(val configuration: JvmConfiguration) : Context

LwjglGL

class LwjglGL(engineStats: EngineStats, graphics: Graphics) : GL

LwjglGraphics

class LwjglGraphics(val context: LwjglContext, engineStats: EngineStats) : Graphics

PreparableGameAsset

class PreparableGameAsset<T>(val action: suspend () -> T)

RemoveContextCallback

typealias RemoveContextCallback = () -> Unit

Scene

abstract class Scene(val context: Context) : Disposable

A base scene. Does nothing on its own and will need to be managed by either a ContextListener or Game.

TextureGameAssetParameter

class TextureGameAssetParameter(val minFilter: TexMinFilter = TexMinFilter.NEAREST, val magFilter: TexMagFilter = TexMagFilter.NEAREST, val useMipmaps: Boolean = true) : GameAssetParameters

Touch

external class Touch

TouchEvent

external class TouchEvent : UIEvent

TouchList

external class TouchList

TtfFileAssetParameter

class TtfFileAssetParameter(val chars: String = CharacterSets.LATIN_ALL) : GameAssetParameters

WebGL

class WebGL(val gl: WebGL2RenderingContext, val platform: Context.Platform, engineStats: EngineStats) : GL

WebGL2RenderingContext

abstract external class WebGL2RenderingContext : WebGLRenderingContext

WebGLContext

class WebGLContext(val configuration: JsConfiguration) : Context

WebGLGraphics

class WebGLGraphics(val canvas: HTMLCanvasElement, engineStats: EngineStats) : Graphics

WebGLVertexArrayObject

abstract external class WebGLVertexArrayObject : WebGLObject

Functions

createLittleKtApp

actual fun createLittleKtApp(action: LittleKtProps.() -> Unit): LittleKtApp

expect fun createLittleKtApp(action: LittleKtProps.() -> Unit = {}): LittleKtApp

Creates a new LittleKtApp containing LittleKtProps as the ContextConfiguration for building a Context.

actual fun createLittleKtApp(action: LittleKtProps.() -> Unit): LittleKtApp

createShader

fun <T : ContextListener> T.createShader(vertexShader: VertexShader = DefaultVertexShader(), fragmentShader: FragmentShader = DefaultFragmentShader()): ShaderProgram<VertexShader, FragmentShader>

Creates a new ShaderProgram for the specified shaders.