api/dev.s7a.strata.render/SampledImageOrientation

SampledImageOrientation

enum SampledImageOrientation : Enum<SampledImageOrientation> (source)

Immutable source-axis directions for nearest sampling through normalized source and destination rectangles. Reversal swaps the corresponding source endpoints before interpolation and does not rearrange image pixels. This preserves the selected source texel at exact nearest-neighbor boundaries and is safe to share between threads.

Entries

Normal

Source coordinates increase along both destination axes.

FlipHorizontal

Source x coordinates decrease while source y coordinates increase.

FlipVertical

Source y coordinates decrease while source x coordinates increase.

FlipBoth

Source coordinates decrease along both destination axes.

Properties

entries

val entries: EnumEntries<SampledImageOrientation>

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

flipX

val flipX: Boolean

whether the source right edge maps to the destination left edge.

flipY

val flipY: Boolean

whether the source bottom edge maps to the destination top edge.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): SampledImageOrientation

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.)

values

fun values(): Array<SampledImageOrientation>

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