Class HDRFiltering

Filters HDR maps to get correct renderings of PBR reflections

Hierarchy

HDRFiltering

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HDRFiltering(engine: ThinEngine, options?: IHDRFilteringOptions): HDRFiltering

- Defined in .temp/docdirectory/doc.d.ts:47814
Instantiates HDR filter for reflection maps

Parameters
- engine: ThinEngine
  
  Thin engine
- Optional options: IHDRFilteringOptions
  
  Options
Returns HDRFiltering

Properties

hdrScaleSearch playground for hdrScale

hdrScale: number

Scales pixel intensity for the input HDR map.

qualitySearch playground for quality

quality: number

Quality switch for prefiltering. Should be set to Constants.TEXTURE_FILTERING_QUALITY_OFFLINE unless you care about baking speed.

Methods

isReadySearch playground for isReady

isReady(texture: BaseTexture): boolean

- Defined in .temp/docdirectory/doc.d.ts:47830
Get a value indicating if the filter is ready to be used

Parameters
- texture: BaseTexture
  
  Texture to filter
Returns boolean

true if the filter is ready

prefilterSearch playground for prefilter

prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<void>

- Defined in .temp/docdirectory/doc.d.ts:47840
Prefilters a cube texture to have mipmap levels representing roughness values. Prefiltering will be invoked at the end of next rendering pass. This has to be done once the map is loaded, and has not been prefiltered by a third party software. See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information

Parameters
- texture: BaseTexture
  
  Texture to filter
- Optional onFinished: Nullable<() => void>
  
  Callback when filtering is done
Returns Promise<void>

Promise called when prefiltering is done