OpenLIME

Class: ShaderFilterBrightness

ShaderFilterBrightness

new ShaderFilterBrightness( [options])

Creates a brightness filter

Parameters:
Name Type Argument Description
options Object <optional>

Filter options

Properties
Name Type Argument Default Description
brightness number <optional>
 1.0

Brightness value (0.0-2.0, where 1.0 is normal brightness)
Source:

Extends

Methods

<abstract> fragDataSrc(gl)

Generates filter-specific GLSL function

Parameters:
Name Type Description
gl WebGLRenderingContext

WebGL context
Inherited From:
Overrides:
Source:
Returns:

GLSL function definition

Type
string | null

getSampler(name)

Finds a sampler by name

Parameters:
Name Type Description
name string

Base sampler name
Inherited From:
Overrides:
Source:
Returns:

Found sampler or undefined

Type
ShaderFilter~Sampler | undefined

setBrightness(value)

Sets the brightness level

Parameters:
Name Type Description
value number

Brightness value (0.0-2.0)
Source:

setBrightnessMethod(method)

Switches between brightness adjustment methods

Parameters:
Name Type Description
method string

Either 'linear' or 'preserve_saturation'
Source:

setMode(mode, id)

Sets the active mode for the filter

Parameters:
Name Type Description
mode string

Mode category to modify
id string

Specific mode ID to enable
Inherited From:
Overrides:
Source:
Throws:

If shader not registered or mode doesn't exist

Type
Error

setUniform(name, value)

Sets a uniform variable value

Parameters:
Name Type Description
name string

Base name of uniform variable
value number | boolean | Array

Value to set
Inherited From:
Overrides:
Source:
Throws:

If shader not registered

Type
Error