korge/korlibs.korge.view.filter/FlagFilter

FlagFilter

class FlagFilter(amplitude: Double = 80.0, crestCount: Double = 5.0, cyclesPerSecond: Double = 2.0, time: TimeSpan = 0.seconds) : ShaderFilter

A Flag Filter that distorts the texture using increasing waves to the right, keeping the left-most vertical static, as if connected to a flag pole.

amplitude is the maximum y amplitude of the waves. crestCount is the number of crests of waves on the x axis. cyclesPerSecond is the number of times the animation would repeat over a second time is the elapsed time of the animation

Constructors

FlagFilter

constructor(amplitude: Double = 80.0, crestCount: Double = 5.0, cyclesPerSecond: Double = 2.0, time: TimeSpan = 0.seconds)

Types

Companion

object Companion : ShaderFilter.BaseProgramProvider

FlagUB

object FlagUB : UniformBlock

Properties

allFilters

open val allFilters: List<Filter>

amplitude

var amplitude: Double

Maximum amplitude of the wave on the Y axis

crestCount

var crestCount: Double

Number of wave crests in the X axis

cyclesPerSecond

var cyclesPerSecond: Double

Number of repetitions of the animation per second

filtering

open override var filtering: Boolean

isIdentity

open val isIdentity: Boolean

programProvider

open override val programProvider: ShaderFilter.ProgramProvider

recommendedFilterScale

open val recommendedFilterScale: Double

time

var time: TimeSpan

The elapsed time for the animation

Functions

computeBorder

open override fun computeBorder(texWidth: Int, texHeight: Int): MarginInt

The number of pixels the passed texture should be bigger at each direction: left, right, top, left.

expandedBorderRectangle

fun Filter.expandedBorderRectangle(inp: Rectangle): Rectangle

getBorder

fun Filter.getBorder(texWidth: Int, texHeight: Int): MarginInt

render

open override fun render(ctx: RenderContext, matrix: Matrix, texture: Texture, texWidth: Int, texHeight: Int, renderColorMul: RGBA, blendMode: BlendMode, filterScale: Double)

The method in charge of rendering the texture transformed using ctx and matrix. The method receives a texture that should be the original image with computeBorder additional pixels on each side.

renderToTextureWithBorder

fun Filter.~~renderToTextureWithBorder~~(ctx: RenderContext, matrix: Matrix, texture: Texture, texWidth: Int, texHeight: Int, filterScale: Double, block: (Texture, matrix: Matrix) -> Unit)

renderToTextureWithBorderUnsafe

fun Filter.renderToTextureWithBorderUnsafe(ctx: RenderContext, matrix: Matrix, texture: Texture, texWidth: Int, texHeight: Int, filterScale: Double, result: RenderToTextureResult = RenderToTextureResult()): RenderToTextureResult