core/com.lehaine.littlekt.file.vfs

Package-level declarations

Types

class MimeType(val mime: String, val exts: List<String>)

interface Path

value class PathInfo(val fullPath: String)

data class VfsFile(val vfs: Vfs, val path: String) : VfsNamed

A virtual file or directory on a file system.

open class VfsNamed(val pathInfo: PathInfo) : Path

Functions

baseNameWithCompoundExtension

fun Path.baseNameWithCompoundExtension(ext: String): String

fun PathInfo.baseNameWithCompoundExtension(ext: String): String

/path\to/file.1.ext -> file.newext

baseNameWithExtension

fun Path.baseNameWithExtension(ext: String): String

fun PathInfo.baseNameWithExtension(ext: String): String

/path\to/file.1.ext -> file.1.newext

fun PathInfo.combine(access: PathInfo): PathInfo

fullPathWithExtension

fun Path.fullPathWithExtension(ext: String): String

fun PathInfo.fullPathWithExtension(ext: String): String

/path\to/file.ext -> /path\to/file.newext

getPathComponents

fun Path.getPathComponents(): List<String>

fun PathInfo.getPathComponents(): List<String>

/path\to/file.1.ext -> listOf("", "path", "to", "file.1.ext")

getPathFullComponents

fun Path.getPathFullComponents(): List<String>

fun PathInfo.getPathFullComponents(): List<String>

/path\to/file.1.ext -> listOf("/path", "/path/to", "/path/to/file.1.ext")

fun PathInfo.isAbsolute(): Boolean

fun PathInfo.lightCombine(access: PathInfo): PathInfo

fun PathInfo.normalize(): String

fun PathInfo.parts(): List<String>

suspend fun VfsFile.readAtlas(): TextureAtlas

Loads a TextureAtlas from the given path. Currently, supports only JSON atlas files.

actual suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

expect suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

actual suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

actual suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

readAudioStream

actual suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

expect suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

actual suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

actual suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

suspend fun VfsFile.readBitmapFont(filter: TexMagFilter = TexMagFilter.NEAREST, mipmaps: Boolean = true, preloadedTextures: List<TextureSlice> = listOf()): BitmapFont

Reads a bitmap font.

suspend fun VfsFile.readGltfModel(loadTexturesAsynchronously: Boolean = false): Model

Loads a glTF / glb model from the path and converts it to a Model.

readLDtkMapLoader

suspend fun VfsFile.readLDtkMapLoader(atlas: TextureAtlas? = null, tilesetBorder: Int = 2): LDtkMapLoader

Reads the VfsFile as a LDtkMapLoader. This will read the LDtk file and create a loader to allow flexible loading of LDtkWorld or LDtkLevel. This loader should be cached and reused when loading separate levels.

actual suspend fun VfsFile.readPixmap(): Pixmap

expect suspend fun VfsFile.readPixmap(): Pixmap

Loads an image from the path as a Pixmap.

actual suspend fun VfsFile.readPixmap(): Pixmap

Loads an image from the path as a Pixmap.

actual suspend fun VfsFile.readPixmap(): Pixmap

actual suspend fun VfsFile.readTexture(minFilter: TexMinFilter, magFilter: TexMagFilter, mipmaps: Boolean): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

expect suspend fun VfsFile.readTexture(minFilter: TexMinFilter = TexMinFilter.NEAREST, magFilter: TexMagFilter = TexMagFilter.NEAREST, mipmaps: Boolean = true): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

actual suspend fun VfsFile.readTexture(minFilter: TexMinFilter, magFilter: TexMagFilter, mipmaps: Boolean): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

actual suspend fun VfsFile.readTexture(minFilter: TexMinFilter, magFilter: TexMagFilter, mipmaps: Boolean): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

suspend fun VfsFile.readTiledMap(atlas: TextureAtlas? = null, tilesetBorder: Int = 2, mipmaps: Boolean = true): TiledMap

Reads the VfsFile as a TiledMap. Any loaders and assets will be cached for reuse/reloading.

suspend fun VfsFile.readTtfFont(chars: String = CharacterSets.LATIN_ALL): TtfFont

fun PathInfo.relativePathTo(relative: PathInfo): String?

actual suspend fun VfsFile.writePixmap(pixmap: Pixmap)

expect suspend fun VfsFile.writePixmap(pixmap: Pixmap)

Write pixmap to disk.

actual suspend fun VfsFile.writePixmap(pixmap: Pixmap)

actual suspend fun VfsFile.writePixmap(pixmap: Pixmap)

Properties

val PathInfo.baseName: String

/path\to/file.ext -> file.ext

val Path.baseName: String

baseNameWithoutCompoundExtension

val PathInfo.baseNameWithoutCompoundExtension: String

/path\to/file.1.ext -> file

val Path.baseNameWithoutCompoundExtension: String

baseNameWithoutExtension

val PathInfo.baseNameWithoutExtension: String

/path\to/file.1.ext -> file.1

val Path.baseNameWithoutExtension: String

compoundExtension

val PathInfo.compoundExtension: String

/path\to/file.1.EXT -> 1.EXT

val Path.compoundExtension: String

compoundExtensionLC

val PathInfo.compoundExtensionLC: String

/path\to/file.1.EXT -> 1.ext

val Path.compoundExtensionLC: String

val PathInfo.extension: String

/path\to/file.1.EXT -> EXT

val Path.extension: String

val PathInfo.extensionLC: String

/path\to/file.1.EXT -> ext

val Path.extensionLC: String

val PathInfo.folder: String

/path\to/file.ext -> /path\to

val Path.folder: String

folderWithSlash

val PathInfo.folderWithSlash: String

/path\to/file.ext -> /path/to/

val Path.folderWithSlash: String

val PathInfo.fullName: String

/path\to/file.1.ext -> /path\to/file.1.ext

val Path.fullName: String

fullNameWithoutCompoundExtension

val PathInfo.fullNameWithoutCompoundExtension: String

/path\to/file.1.ext -> file

val Path.fullNameWithoutCompoundExtension: String

fullNameWithoutExtension

val PathInfo.fullNameWithoutExtension: String

/path\to/file.1.ext -> /path\to/file.1

val Path.fullNameWithoutExtension: String

fullPathNormalized

val PathInfo.fullPathNormalized: String

/path\to/file.ext -> /path/to/file.ext

val Path.fullPathNormalized: String

fullPathWithoutExtension

val PathInfo.fullPathWithoutExtension: String

/path\to/file.ext -> /path\to/file

val Path.fullPathWithoutExtension: String

mimeTypeByExtension

val PathInfo.mimeTypeByExtension: MimeType

/path\to/file.1.jpg -> MimeType("image/jpeg", listOf("jpg", "jpeg"))

val Path.mimeTypeByExtension: MimeType

val PathInfo.parent: PathInfo

/path\to/file.ext -> /path\to

val String.pathInfo: PathInfo