Class ThinFilmFresnelMap

Credit: https://github.com/DerSchmale/threejs-thin-film-iridescence

Demo: https://kokomi-playground.vercel.app/entries/#liquidCrystal

Classdesc

ThinFilmFresnelMap is a lookup texture containing the reflection colour. The texture index value is dot(normal, view). The texture values are stored in approximated gamma space (power 2.0), so the sampled value needs to be multiplied with itself before use. The sampled value should replace the fresnel factor in a PBR material.

Param: filmThickness

The thickness of the thin film layer in nanometers. Defaults to 380.

Param: refractiveIndexFilm

The refractive index of the thin film. Defaults to 2.

Param: refractiveIndexBase

The refractive index of the material under the film. Defaults to 3.

Param: size

The width of the texture. Defaults to 64.

Author

David Lenaerts http://www.derschmale.com

Hierarchy

  • DataTexture
    • ThinFilmFresnelMap

Constructors

constructor

Properties

_data _filmThickness _refractiveIndexBase _refractiveIndexFilm _size anisotropy center channel colorSpace flipY format generateMipmaps id internalFormat isDataTexture isRenderTargetTexture isTexture magFilter mapping matrix matrixAutoUpdate minFilter mipmaps name offset onUpdate pmremVersion premultiplyAlpha repeat rotation source type unpackAlignment userData uuid version wrapS wrapT DEFAULT_ANISOTROPY DEFAULT_IMAGE DEFAULT_MAPPING

Accessors

filmThickness image needsPMREMUpdate needsUpdate refractiveIndexBase refractiveIndexFilm

Methods

addEventListener clone copy dispatchEvent dispose hasEventListener removeEventListener toJSON transformUv updateMatrix updateSettings

Constructors

constructor

Properties

_data

_data: Uint8Array

_filmThickness

_filmThickness: number

_refractiveIndexBase

_refractiveIndexBase: number

_refractiveIndexFilm

_refractiveIndexFilm: number

_size

_size: number

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

center

center: Vector2

The point around which rotation occurs.

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

Default Value

new THREE.Vector2( 0, 0 ), lower left.

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for uv3.

colorSpace

colorSpace: ColorSpace

The Textures | {@link Texture constants} page for details of other color spaces.

Remarks

Textures containing color data should be annotated with SRGBColorSpace THREE.SRGBColorSpace or LinearSRGBColorSpace THREE.LinearSRGBColorSpace.

See

Default Value

THREE.NoColorSpace

flipY

flipY: boolean

Default Value

false

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

See

Default Value

THREE.RGBAFormat.

generateMipmaps

generateMipmaps: boolean

Default Value

false

Readonlyid

id: number

Unique number for this Texture instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

See

Texture Constants

Default Value

The default value is obtained using a combination of .format and .type.

ReadonlyisDataTexture

isDataTexture: true

Read-only flag to check if a given object is of type DataTexture.

Remarks

This is a constant value

Default Value

true

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

Default Value

false

ReadonlyisTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

Remarks

This is a constant value

Default Value

true

magFilter

magFilter: MagnificationTextureFilter

Default Value

THREE.NearestFilter

mapping

mapping: AnyMapping

How the image is applied to the object.

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

See

Texture Constants

Default Value

value of THREE.Texture.DEFAULT_MAPPING

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

Remarks

When .matrixAutoUpdate property is true. Will be updated by the renderer from the properties:

See

.matrixAutoUpdate

Default Value

new THREE.Matrix3()

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

See

.matrix

Default Value

true

minFilter

minFilter: MinificationTextureFilter

Default Value

THREE.NearestFilter

mipmaps

mipmaps: any[]

Array of user-specified mipmaps

Default Value

[]

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

Remarks

Typical range is 0.0 to 1.0.

Default Value

new THREE.Vector2(0, 0)

onUpdate

onUpdate: (() => void)

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target textures)

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

Remarks

Note that this property has no effect for ImageBitmap. You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

Default Value

false

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

See

Default Value

new THREE.Vector2( 1, 1 )

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

Remarks

Positive values are counter-clockwise.

Default Value

0

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures. This is often useful in context of spritesheets where multiple textures render the same data but with different Texture transformations.

type

type: TextureDataType

This must correspond to the .format.

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

See

Default Value

THREE.UnsignedByteType

unpackAlignment

unpackAlignment: number

Default Value

1

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

Remarks

It should not hold references to functions as these will not be cloned.

Default Value

{}

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Remarks

Expects a Integer

Default Value

0

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two (2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels. Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js. WEBGL2 does not have this limitation.

See

Default Value

THREE.ClampToEdgeWrapping

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two (2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels. Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js. WEBGL2 does not have this limitation.

See

Default Value

THREE.ClampToEdgeWrapping

StaticDEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

Default Value

1.

StaticDEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for Texture.image | .image.

Default Value

null.

StaticDEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

Default Value

THREE.UVMapping

Accessors

filmThickness

image

  • get image(): TextureImageData

  • Overridden with a record type holding data, width and height and depth.

    Returns TextureImageData

  • set image(value): void

  • Parameters

    • value: TextureImageData

    Returns void

needsPMREMUpdate

  • set needsPMREMUpdate(value): void

  • Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

    Parameters

    • value: boolean

    Returns void

    Remarks

    Only relevant for render target textures.

    Default Value

    false

needsUpdate

  • set needsUpdate(value): void

  • Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.

    Parameters

    • value: boolean

    Returns void

refractiveIndexBase

refractiveIndexFilm

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Adds a listener to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<{
          dispose: {};
      }[T], T, ThinFilmFresnelMap>

      The function that gets called when the event is fired.

    Returns void

  • addEventListener<T>(type, listener): void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

clone

  • clone(): this

  • Make copy of the texture

    Returns this

    Remarks

    Note this is not a "deep copy", the image is shared

copy

  • copy(source): this

  • Parameters

    • source: Texture

    Returns this

dispatchEvent

  • dispatchEvent<T>(event): void

  • Fire an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & {
          dispose: {};
      }[T]

      The event that gets fired.

    Returns void

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

hasEventListener

  • hasEventListener<T>(type, listener): boolean

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<{
          dispose: {};
      }[T], T, ThinFilmFresnelMap>

      The function that gets called when the event is fired.

    Returns boolean

  • hasEventListener<T>(type, listener): boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Removes a listener from an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<{
          dispose: {};
      }[T], T, ThinFilmFresnelMap>

      The listener function that gets removed.

    Returns void

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

toJSON

  • toJSON(meta?): {}

  • Convert the texture to three.js JSON Object/Scene format.

    Parameters

    • Optionalmeta: string | {}

      Optional object containing metadata.

    Returns {}

    transformUv

    • transformUv(uv): Vector2

    • Transform the UV based on the value of this texture's .offset, .repeat, .wrapS, .wrapT and .flipY properties.

      Parameters

      • uv: Vector2

      Returns Vector2

    updateMatrix

    • updateMatrix(): void

    • Update the texture's UV-transform .matrix from the texture properties .offset, .repeat, .rotation and .center.

      Returns void

    updateSettings

    • updateSettings(filmThickness, refractiveIndexFilm, refractiveIndexBase): void

    • Regenerates the lookup texture given new data.

      Parameters

      • filmThickness: number

        The thickness of the thin film layer in nanometers. Defaults to 380.

      • refractiveIndexFilm: number

        The refractive index of the thin film. Defaults to 2.

      • refractiveIndexBase: number

        The refractive index of the material under the film. Defaults to 3.

      Returns void

    Settings

    Member Visibility

    On This Page

    constructor_data_filmThickness_refractiveIndexBase_refractiveIndexFilm_sizeanisotropycenterchannelcolorSpaceflipYformatgenerateMipmapsidinternalFormatisDataTextureisRenderTargetTextureisTexturemagFiltermappingmatrixmatrixAutoUpdateminFiltermipmapsnameoffsetonUpdatepmremVersionpremultiplyAlpharepeatrotationsourcetypeunpackAlignmentuserDatauuidversionwrapSwrapTDEFAULT_ANISOTROPYDEFAULT_IMAGEDEFAULT_MAPPINGfilmThicknessimageneedsPMREMUpdateneedsUpdaterefractiveIndexBaserefractiveIndexFilmaddEventListenerclonecopydispatchEventdisposehasEventListenerremoveEventListenertoJSONtransformUvupdateMatrixupdateSettings