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

SpecularFilter

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

Generates a prefiltered (specular) cubemap. An instance is needed per filter configuration.

Constructors

SpecularFilter

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

Types

Config

class Config(var sampleCount: Int = 1024, var levelCount: Int = 5, 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 = 1.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, outReflectionsTexture: Texture? = null): Texture

invoke with the default Options: all mipmap levels are overwritten.

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

Generates a prefiltered cubemap. The environment cubemap must be SAMPLEABLE with all its levels allocated. If Options.generateMipmap is true, the mipmap levels are overwritten.