Header menu logo Nu

CubeMap Module

Cube map operations.

Functions and values

Function or value Description

CubeMap.VertexSize

Full Usage: CubeMap.VertexSize

Returns: int
Returns: int

CubeMap.createCubeMapGeometry renderable context

Full Usage: CubeMap.createCubeMapGeometry renderable context

Parameters:
Returns: CubeMapGeometry

Create cube map geometry.

renderable : bool
context : VulkanContext
Returns: CubeMapGeometry

CubeMap.createCubeMapGeometryFromMesh renderable vertexData indexData bounds context

Full Usage: CubeMap.createCubeMapGeometryFromMesh renderable vertexData indexData bounds context

Parameters:
Returns: CubeMapGeometry

Create cube map geometry from a mesh.

renderable : bool
vertexData : Memory<single>
indexData : Memory<int>
bounds : Box3
context : VulkanContext
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.createCubeMapPipeline shaderPath colorAttachmentFormat context

Full Usage: CubeMap.createCubeMapPipeline shaderPath colorAttachmentFormat context

Parameters:
Returns: CubeMapPipeline

Create a CubeMapPipeline.

shaderPath : string
colorAttachmentFormat : VkFormat
context : VulkanContext
Returns: CubeMapPipeline

CubeMap.destroyCubeMapGeometry geometry context

Full Usage: CubeMap.destroyCubeMapGeometry geometry context

Parameters:

Destroy cube map geometry.

geometry : CubeMapGeometry
context : VulkanContext

CubeMap.destroyCubeMapPipeline cubeMapPipeline context

Full Usage: CubeMap.destroyCubeMapPipeline cubeMapPipeline context

Parameters:

Destroy a CubeMapPipeline.

cubeMapPipeline : Pipeline
context : VulkanContext

CubeMap.drawCubeMap eyeCenter view projectionUnflipped flipped cubeMap sampler geometry resolution colorAttachment pipeline getCommandBuffer advanceCommandBufferWhenNeeded context

Full Usage: CubeMap.drawCubeMap eyeCenter view projectionUnflipped flipped cubeMap sampler geometry resolution colorAttachment pipeline getCommandBuffer advanceCommandBufferWhenNeeded context

Parameters:

Draw a cube map.

eyeCenter : Vector3
view : Matrix4x4
projectionUnflipped : Matrix4x4
flipped : bool
cubeMap : Texture
sampler : Sampler
geometry : CubeMapGeometry
resolution : int
colorAttachment : VkImageView
pipeline : CubeMapPipeline
getCommandBuffer : unit -> VkCommandBuffer
advanceCommandBufferWhenNeeded : unit -> unit
context : VulkanContext

CubeMap.tryCreateCubeMap faceRightFilePath faceLeftFilePath faceTopFilePath faceBottomFilePath faceBackFilePath faceFrontFilePath thread context

Full Usage: CubeMap.tryCreateCubeMap faceRightFilePath faceLeftFilePath faceTopFilePath faceBottomFilePath faceBackFilePath faceFrontFilePath thread context

Parameters:
    faceRightFilePath : string
    faceLeftFilePath : string
    faceTopFilePath : string
    faceBottomFilePath : string
    faceBackFilePath : string
    faceFrontFilePath : string
    thread : TextureLoadThread
    context : VulkanContext

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
thread : TextureLoadThread
context : VulkanContext
Returns: Either<string, Texture>

Type something to start searching.