filament-utils/io.github.erkko68.filament.utils/IBLPrefilterContext/IrradianceFilter

IrradianceFilter

class IrradianceFilter(context: IBLPrefilterContext, config: IBLPrefilterContext.IrradianceFilter.Config = Config()) : AutoCloseable

Generates an irradiance cubemap. An instance is needed per filter configuration.

Constructors

IrradianceFilter

constructor(context: IBLPrefilterContext, config: IBLPrefilterContext.IrradianceFilter.Config = Config())

Types

Config

class Config(var sampleCount: Int = 1024, var kernel: IBLPrefilterContext.Kernel = Kernel.D_GGX)

Filter configuration.

Options

class Options(var hdrLinear: Float = 1024.0f, var hdrMax: Float = 16384.0f, var lodOffset: Float = 2.0f, var generateMipmap: Boolean = true)

Filtering options for the current environment.

Functions

open override fun close()

Same as destroy; lets this be used with use { } and try-with-resources.

destroy

fun destroy()

Destroys all GPU resources created during initialization.

invoke

operator fun invoke(environmentCubemap: Texture, outIrradianceTexture: Texture? = null): Texture

invoke with the default Options.

operator fun invoke(options: IBLPrefilterContext.IrradianceFilter.Options, environmentCubemap: Texture, outIrradianceTexture: Texture? = null): Texture

Generates an irradiance cubemap. Mipmaps are used in the generation, so the environment cubemap must be SAMPLEABLE with all its levels allocated. If Options.generateMipmap is true, the mipmap levels are overwritten.