Header menu logo Nu

LightMap Module

Types

Type Description

EnvironmentFilterShader

Describes an environment filter shader that's loaded into GPU.

LightMap

A collection of maps consisting a light map.

Functions and values

Function or value Description

LightMap.CreateEnvironmentFilterMap (resolution, environmentFilterSurface, environmentFilterShader, cubeMapVao, renderbuffer, framebuffer)

Full Usage: LightMap.CreateEnvironmentFilterMap (resolution, environmentFilterSurface, environmentFilterShader, cubeMapVao, renderbuffer, framebuffer)

Parameters:
Returns: Texture

Create an environment filter map.

resolution : int
environmentFilterSurface : CubeMapSurface
environmentFilterShader : EnvironmentFilterShader
cubeMapVao : uint
renderbuffer : uint32
framebuffer : uint32
Returns: Texture

LightMap.CreateEnvironmentFilterShader shaderFilePath

Full Usage: LightMap.CreateEnvironmentFilterShader shaderFilePath

Parameters:
    shaderFilePath : string

Returns: EnvironmentFilterShader

Create an environment filter shader.

shaderFilePath : string
Returns: EnvironmentFilterShader

LightMap.CreateIrradianceMap (resolution, cubeMapSurface, irradianceShader, cubeMapVao, renderbuffer, framebuffer)

Full Usage: LightMap.CreateIrradianceMap (resolution, cubeMapSurface, irradianceShader, cubeMapVao, renderbuffer, framebuffer)

Parameters:
    resolution : int
    cubeMapSurface : CubeMapSurface
    irradianceShader : CubeMapShader
    cubeMapVao : uint
    renderbuffer : uint32
    framebuffer : uint32

Returns: Texture
resolution : int
cubeMapSurface : CubeMapSurface
irradianceShader : CubeMapShader
cubeMapVao : uint
renderbuffer : uint32
framebuffer : uint32
Returns: Texture

LightMap.CreateLightMap enabled origin ambientColor ambientBrightness bounds irradianceMap environmentFilterMap

Full Usage: LightMap.CreateLightMap enabled origin ambientColor ambientBrightness bounds irradianceMap environmentFilterMap

Parameters:
    enabled : bool
    origin : Vector3
    ambientColor : Color
    ambientBrightness : single
    bounds : Box3
    irradianceMap : Texture
    environmentFilterMap : Texture

Returns: LightMap

Create a light map with existing irradiance and environment filter maps.

enabled : bool
origin : Vector3
ambientColor : Color
ambientBrightness : single
bounds : Box3
irradianceMap : Texture
environmentFilterMap : Texture
Returns: LightMap

LightMap.CreateReflectionMap (render, resolution, origin, ambientColor, ambientBrightness, renderbuffer, framebuffer)

Full Usage: LightMap.CreateReflectionMap (render, resolution, origin, ambientColor, ambientBrightness, renderbuffer, framebuffer)

Parameters:
Returns: Texture

Create a reflection map.

render : bool -> ('a * 'b) option -> Vector3 -> Matrix4x4 -> Matrix4x4 -> Frustum -> Matrix4x4 -> Matrix4x4 -> Box2i -> Matrix4x4 -> uint32 -> uint32 -> unit
resolution : int
origin : Vector3
ambientColor : 'a
ambientBrightness : 'b
renderbuffer : uint32
framebuffer : uint32
Returns: Texture

LightMap.DestroyLightMap lightMap

Full Usage: LightMap.DestroyLightMap lightMap

Parameters:

Destroy a light map, including its irradiance environment filter maps.

lightMap : LightMap

LightMap.DrawEnvironmentFilter (view, projection, viewProjection, roughness, resolution, cubeMap, geometry, shader, vao)

Full Usage: LightMap.DrawEnvironmentFilter (view, projection, viewProjection, roughness, resolution, cubeMap, geometry, shader, vao)

Parameters:

Draw an environment filter.

view : single array
projection : single array
viewProjection : single array
roughness : single
resolution : single
cubeMap : Texture
geometry : CubeMapGeometry
shader : EnvironmentFilterShader
vao : uint

Type something to start searching.