kiteplayer-core/io.github.yuroyami.kiteplayer.spi/PlayerPixelFormat

PlayerPixelFormat

enum PlayerPixelFormat : Enum<PlayerPixelFormat>

A pixel layout the engine models.

Entries

Under ColorMatrix.Identity the three planes hold G, B and R. Video coded as RGB arrives so.

The decoder produced something the engine does not model. Only a matching renderer can draw it.

Properties

bitsPerComponent

val bitsPerComponent: Int

Significant bits in each sample.

val entries: EnumEntries<PlayerPixelFormat>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val isPlanarYuv: Boolean

True for luma and chroma formats, planar or semi-planar, and false for packed RGB.

val isTenBitOrMore: Boolean

True when a sample carries more than eight bits.

expect val name: String

expect val ordinal: Int

val planes: Int

Planes in memory.

Functions

fun valueOf(value: String): PlayerPixelFormat

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<PlayerPixelFormat>

Returns an array containing the constants of this enum type, in the order they're declared.