korge/korlibs.korge.view.filter/Filter

Filter

interface Filter

Interface for View filters.

A filter is in charge of rendering a precomputed texture of a View.

Filter defines a computeBorder. The border is the amount of pixels, the generated texture should be grown from each side: left, top, right and bottom. For example, a Gauissan Blur effect would require a bigger texture to blur the edges.

Filter defines how to render the precomputed texture of the View inside the render method.

Filters are usually ComposedFilter or ShaderFilter

Inheritors

ComposedFilter

FilterWithFiltering

IdentityFilter

Types

Companion

object Companion

Properties

allFilters

open val allFilters: List<Filter>

recommendedFilterScale

open val recommendedFilterScale: Double

Functions

computeBorder

open 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

abstract 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