style/ktx.style

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.FUNCTION, AnnotationTarget.TYPE, AnnotationTarget.TYPEALIAS])

annotation class SkinDsl

Should annotate builder methods of Scene2D Skin.

Properties

defaultStyle

const val defaultStyle: String

Name of default resources in Skin. Often used as default Scene2D actor style names.

Functions

add

inline fun <Resource : Any> Skin.add(resource: Resource, name: String = defaultStyle)

Utility function that makes it easier to add Skin assets.

addStyle

inline fun <Style> Skin.addStyle(name: String, style: Style, init: Style.() -> Unit = {}): Style

Utility function for adding existing styles to the skin. Mostly for internal use.

button

inline fun Skin.button(name: String = defaultStyle, extend: String? = null, init: Button.ButtonStyle.() -> Unit = {}): Button.ButtonStyle

checkBox

inline fun Skin.checkBox(name: String = defaultStyle, extend: String? = null, init: CheckBox.CheckBoxStyle.() -> Unit = {}): CheckBox.CheckBoxStyle

color

fun Skin.color(name: String, red: Float, green: Float, blue: Float, alpha: Float = 1.0f): Color

Adds a new Color instance to the skin.

get

inline operator fun <Resource : Any, E : Enum<E>> Skin.get(name: E): Resource

inline operator fun <Resource : Any> Skin.get(name: String = defaultStyle): Resource

Utility function that makes it easier to access Skin assets.

getAll

inline fun <Resource : Any> Skin.getAll(): ObjectMap<String, Resource>?

Utility function that makes it easier to access all Skin assets of a certain type.

has

inline fun <Resource : Any> Skin.has(name: String = defaultStyle): Boolean

Utility function that makes it easier to check if Skin contains assets.

imageButton

inline fun Skin.imageButton(name: String = defaultStyle, extend: String? = null, init: ImageButton.ImageButtonStyle.() -> Unit = {}): ImageButton.ImageButtonStyle

imageTextButton

inline fun Skin.imageTextButton(name: String = defaultStyle, extend: String? = null, init: ImageTextButton.ImageTextButtonStyle.() -> Unit = {}): ImageTextButton.ImageTextButtonStyle

label

inline fun Skin.label(name: String = defaultStyle, extend: String? = null, init: Label.LabelStyle.() -> Unit = {}): Label.LabelStyle

list

inline fun Skin.list(name: String = defaultStyle, extend: String? = null, init: List.ListStyle.() -> Unit = {}): List.ListStyle

optional

inline fun <Resource : Any> Skin.optional(name: String = defaultStyle): Resource?

Utility function that makes it easier to access Skin assets or return null if they don't exist.

plusAssign

inline operator fun <Resource : Any> Skin.plusAssign(resource: Resource)

Utility function that makes it easier to add Skin assets under the defaultStyle name.

progressBar

inline fun Skin.progressBar(name: String = defaultStyle, extend: String? = null, init: ProgressBar.ProgressBarStyle.() -> Unit = {}): ProgressBar.ProgressBarStyle

inline fun Skin.register(styles: Skin.(Skin) -> Unit)

Allows to create new UI component styles with the KTX DSL. This method is very similar to the apply extension method from the standard library, but supports the DSL annotation.

remove

inline fun <Resource : Any> Skin.remove(name: String = defaultStyle)

Utility function that makes it easier to remove Skin assets.

scrollPane

inline fun Skin.scrollPane(name: String = defaultStyle, extend: String? = null, init: ScrollPane.ScrollPaneStyle.() -> Unit = {}): ScrollPane.ScrollPaneStyle

selectBox

inline fun Skin.selectBox(name: String = defaultStyle, extend: String? = null, init: SelectBox.SelectBoxStyle.() -> Unit = {}): SelectBox.SelectBoxStyle

set

inline operator fun <Resource : Any, E : Enum<E>> Skin.set(name: E, resource: Resource)

inline operator fun <Resource : Any> Skin.set(name: String, resource: Resource)

Utility function that makes it easier to add Skin assets.

skin

inline fun skin(init: Skin.(Skin) -> Unit = {}): Skin

inline fun skin(atlas: TextureAtlas, init: Skin.(Skin) -> Unit = {}): Skin

slider

inline fun Skin.slider(name: String = defaultStyle, extend: String? = null, init: Slider.SliderStyle.() -> Unit = {}): Slider.SliderStyle

splitPane

inline fun Skin.splitPane(name: String = defaultStyle, extend: String? = null, init: SplitPane.SplitPaneStyle.() -> Unit = {}): SplitPane.SplitPaneStyle

textButton

inline fun Skin.textButton(name: String = defaultStyle, extend: String? = null, init: TextButton.TextButtonStyle.() -> Unit = {}): TextButton.TextButtonStyle

textField

inline fun Skin.textField(name: String = defaultStyle, extend: String? = null, init: TextField.TextFieldStyle.() -> Unit = {}): TextField.TextFieldStyle

textTooltip

inline fun Skin.textTooltip(name: String = defaultStyle, extend: String? = null, init: TextTooltip.TextTooltipStyle.() -> Unit = {}): TextTooltip.TextTooltipStyle

touchpad

inline fun Skin.touchpad(name: String = defaultStyle, extend: String? = null, init: Touchpad.TouchpadStyle.() -> Unit = {}): Touchpad.TouchpadStyle

tree

inline fun Skin.tree(name: String = defaultStyle, extend: String? = null, init: Tree.TreeStyle.() -> Unit = {}): Tree.TreeStyle

window

inline fun Skin.window(name: String = defaultStyle, extend: String? = null, init: Window.WindowStyle.() -> Unit = {}): Window.WindowStyle