skiko/org.jetbrains.skiko

Package-level declarations

Types

Arch

enum Arch : Enum<Arch>

ClipComponent

class ClipComponent(val component: Component) : ClipRectangle

ClipRectangle

interface ClipRectangle

Rectangle used for clipping.

DefaultConsoleLogger

class DefaultConsoleLogger(val isTraceEnabled: Boolean = false, val isDebugEnabled: Boolean = false, val isInfoEnabled: Boolean = true, val isWarnEnabled: Boolean = true, val isErrorEnabled: Boolean = true, logTimestamp: Boolean = false) : SkikoLoggerInterface

DelicateSkikoApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This is a delicate API and its use requires care. Make sure you fully read and understand documentation of the declaration that is marked as a delicate API.")

annotation class DelicateSkikoApi

Marks declarations that are delicate — they have limited use-case and shall be used with care in general code. Any use of a delicate declaration has to be carefully reviewed to make sure it is properly used and does not create problems like concurrency issues, memory and resource leaks. Carefully read documentation of any declaration marked as DelicateSkikoApi.

DependsOnJBR

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This functionality will only work correctly on the JetBrains Runtime.")

annotation class DependsOnJBR

Mark a feature that depends on running on the JetBrains Runtime.

ExperimentalSkikoApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This is an experimental API and can be changed in the near future. The behaviour isn't properly testedand can have bugs.")

annotation class ExperimentalSkikoApi

Marks declarations that are experimental and don't have stable API yet.

FPSCounter

class FPSCounter(periodSeconds: Double = 2.0, showLongFrames: Boolean = false, getLongFrameMillis: () -> Double = { 1.5 * 1000 / 60 }, logOnTick: Boolean = false)

FrameBuffering

enum FrameBuffering : Enum<FrameBuffering>

FrameDispatcher

class FrameDispatcher(scope: CoroutineScope, onFrame: suspend CoroutineScope.() -> Unit)

Dispatch frame after call of scheduleFrame.

FrameLimiter

class FrameLimiter(coroutineScope: CoroutineScope, frameMillis: () -> Long, impreciseDelay: suspend (Long) -> Unit = ::delay, currentTime: () -> ERROR CLASS: Symbol not found for Duration = { System.nanoTime().nanoseconds })

Limit the duration of the frames (to avoid high CPU usage) to frameMillis. The actual delay depends on the precision of the system timer (Windows has ~15ms precision by default, Linux/macOs ~2ms). FrameLimiter will try to delay frames as close as possible to frameMillis, but not greater

GpuPriority

enum GpuPriority : Enum<GpuPriority>

GraphicsApi

enum GraphicsApi : Enum<GraphicsApi>

InternalSkikoApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is internal API for Skiko modules that may change frequently and without warning.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.TYPEALIAS])

annotation class InternalSkikoApi

KotlinBackend

enum KotlinBackend : Enum<KotlinBackend>

Library

object Library

LibraryLoader

class LibraryLoader

LibraryLoadException

class LibraryLoadException(message: String, cause: Throwable? = null) : RuntimeException

enum OS : Enum<OS>

OSVersion

data class OSVersion(val major: Int, val minor: Int = 0, val patch: Int = 0) : Comparable<OSVersion>

SkiaLayer

actual open class SkiaLayer