skiko/org.jetbrains.skia/AnimationFrameInfo

AnimationFrameInfo

class AnimationFrameInfo(var requiredFrame: Int, var duration: Int, var isFullyReceived: Boolean, var alphaType: ColorAlphaType, var isHasAlphaWithinBounds: Boolean, var disposalMethod: AnimationDisposalMode, var blendMode: BlendMode, frameRect: IRect)

Information about individual frames in a multi-framed image.

Constructors

AnimationFrameInfo

constructor(requiredFrame: Int, duration: Int, isFullyReceived: Boolean, alphaType: ColorAlphaType, isHasAlphaWithinBounds: Boolean, disposalMethod: AnimationDisposalMode, blendMode: BlendMode, frameRect: IRect)

Types

object Companion

Properties

var alphaType: ColorAlphaType

This is conservative; it will still return non-opaque if e.g. a color index-based frame has a color with alpha but does not use it.

var blendMode: BlendMode

How this frame should blend with the prior frame.

var disposalMethod: AnimationDisposalMode

How this frame should be modified before decoding the next one.

var duration: Int

Number of milliseconds to show this frame.

isFullyReceived

var isFullyReceived: Boolean

Whether the end marker for this frame is contained in the stream.

isHasAlphaWithinBounds

var isHasAlphaWithinBounds: Boolean

Whether the updated rectangle contains alpha.

var requiredFrame: Int

The frame that this frame needs to be blended with, or -1 if this frame is independent (so it can be drawn over an uninitialized buffer).

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String

fun withAlphaType(_alphaType: ColorAlphaType): AnimationFrameInfo

This is conservative; it will still return non-opaque if e.g. a color index-based frame has a color with alpha but does not use it.

fun withBlendMode(_blendMode: BlendMode): AnimationFrameInfo

How this frame should blend with the prior frame.

withDisposalMethod

fun withDisposalMethod(_disposalMethod: AnimationDisposalMode): AnimationFrameInfo

How this frame should be modified before decoding the next one.

fun withDuration(_duration: Int): AnimationFrameInfo

Number of milliseconds to show this frame.

fun withFrameRect(_frameRect: IRect): AnimationFrameInfo

The rectangle updated by this frame.

withFullyReceived

fun withFullyReceived(_fullyReceived: Boolean): AnimationFrameInfo

Whether the end marker for this frame is contained in the stream.

withHasAlphaWithinBounds

fun withHasAlphaWithinBounds(_hasAlphaWithinBounds: Boolean): AnimationFrameInfo

Whether the updated rectangle contains alpha.

withRequiredFrame

fun withRequiredFrame(_requiredFrame: Int): AnimationFrameInfo

The frame that this frame needs to be blended with, or -1 if this frame is independent (so it can be drawn over an uninitialized buffer).