Header menu logo Nu

CubeMap Module

Types

Type Description

CubeMapClient

Memoizes cube map loads (and may at some point potentially thread them).

CubeMapGeometry

Describes some cube map geometry that's loaded into VRAM.

CubeMapKey

The key identifying a cube map.

CubeMapShader

Describes a cube map shader that's loaded into GPU.

CubeMapSurface

Describes a renderable cube map surface.

Functions and values

Function or value Description

CubeMap.CreateCubeMapGeometry renderable

Full Usage: CubeMap.CreateCubeMapGeometry renderable

Parameters:
    renderable : bool

Returns: CubeMapGeometry

Create cube map geometry.

renderable : bool
Returns: CubeMapGeometry

CubeMap.CreateCubeMapGeometryFromMesh (renderable, vertexData, indexData, bounds)

Full Usage: CubeMap.CreateCubeMapGeometryFromMesh (renderable, vertexData, indexData, bounds)

Parameters:
    renderable : bool
    vertexData : Memory<single>
    indexData : Memory<int>
    bounds : Box3

Returns: CubeMapGeometry

Create cube map geometry from a mesh.

renderable : bool
vertexData : Memory<single>
indexData : Memory<int>
bounds : Box3
Returns: CubeMapGeometry

CubeMap.CreateCubeMapMesh ()

Full Usage: CubeMap.CreateCubeMapMesh ()

Parameters:
    () : unit

Returns: float32[] * int array * Box3

Create a mesh for a cube map.

() : unit
Returns: float32[] * int array * Box3

CubeMap.CreateCubeMapShader shaderFilePath

Full Usage: CubeMap.CreateCubeMapShader shaderFilePath

Parameters:
    shaderFilePath : string

Returns: CubeMapShader

Create a cube map shader.

shaderFilePath : string
Returns: CubeMapShader

CubeMap.CreateCubeMapVao ()

Full Usage: CubeMap.CreateCubeMapVao ()

Parameters:
    () : unit

Returns: uint32
() : unit
Returns: uint32

CubeMap.DestroyCubeMapGeometry geometry

Full Usage: CubeMap.DestroyCubeMapGeometry geometry

Parameters:

Destroy cube map geometry.

geometry : CubeMapGeometry

CubeMap.DrawCubeMap (view, projection, viewProjection, cubeMap, geometry, shader, vao)

Full Usage: CubeMap.DrawCubeMap (view, projection, viewProjection, cubeMap, geometry, shader, vao)

Parameters:

Draw a cube map.

view : single array
projection : single array
viewProjection : single array
cubeMap : Texture
geometry : CubeMapGeometry
shader : CubeMapShader
vao : uint

CubeMap.TryCreateCubeMap (faceRightFilePath, faceLeftFilePath, faceTopFilePath, faceBottomFilePath, faceBackFilePath, faceFrontFilePath)

Full Usage: CubeMap.TryCreateCubeMap (faceRightFilePath, faceLeftFilePath, faceTopFilePath, faceBottomFilePath, faceBackFilePath, faceFrontFilePath)

Parameters:
    faceRightFilePath : string
    faceLeftFilePath : string
    faceTopFilePath : string
    faceBottomFilePath : string
    faceBackFilePath : string
    faceFrontFilePath : string

Returns: Either<string, Texture>

Attempt to create a cube map from 6 files. Uses file name-based inferences to look for texture files in case the ones that were hard-coded in the included files can't be located.

faceRightFilePath : string
faceLeftFilePath : string
faceTopFilePath : string
faceBottomFilePath : string
faceBackFilePath : string
faceFrontFilePath : string
Returns: Either<string, Texture>

CubeMap.VertexSize

Full Usage: CubeMap.VertexSize

Returns: int
Returns: int

Type something to start searching.