Header menu logo Nu

Texture Module

Types

Type Description

EagerTexture

A texture that's immediately loaded.

LazyTexture

A texture that can be loaded from another thread.

Texture

A 2d texture.

TextureClient

Memoizes and optionally threads texture loads.

TextureData

Describes data loaded from a texture.

TextureMetadata

An OpenGL texture's metadata.

TextureServer

Populated the texture ids and handles of lazy textures in a threaded manner. TODO: abstract this to interface that can represent either inline or threaded implementation.

Functions and values

Function or value Description

Texture.BlockCompressable filePath

Full Usage: Texture.BlockCompressable filePath

Parameters:
    filePath : string

Returns: bool

Check that an asset with the given file path can utilize block compression (IE, it's not a normal map, blend map, or specified as uncompressed).

filePath : string
Returns: bool

Texture.CreateTextureGlFromData (minFilter, magFilter, anisoFilter, mipmaps, blockCompress, textureData)

Full Usage: Texture.CreateTextureGlFromData (minFilter, magFilter, anisoFilter, mipmaps, blockCompress, textureData)

Parameters:
Returns: TextureMetadata * uint32

Create an opengl texture from existing texture data. NOTE: this function will dispose textureData.

minFilter : TextureMinFilter
magFilter : TextureMagFilter
anisoFilter : bool
mipmaps : bool
blockCompress : bool
textureData : TextureData
Returns: TextureMetadata * uint32

Texture.Filtered2d filePath

Full Usage: Texture.Filtered2d filePath

Parameters:
    filePath : string

Returns: bool

Check that an asset with the given file path should be filtered in a 2D rendering context.

filePath : string
Returns: bool

Texture.FormatCompressedPfdds (minimal, dds)

Full Usage: Texture.FormatCompressedPfdds (minimal, dds)

Parameters:
    minimal : bool
    dds : Dds

Returns: Vector2i * byte[] * (Vector2i * byte[]) array

Attempt to format compressed pfim image data. TODO: make this a Dds extension and move elsewhere?

minimal : bool
dds : Dds
Returns: Vector2i * byte[] * (Vector2i * byte[]) array

Texture.FormatUncompressedPfimageMipmap (format, mipmap, data)

Full Usage: Texture.FormatUncompressedPfimageMipmap (format, mipmap, data)

Parameters:
Returns: Vector2i * byte[]

Attempt to format an uncompressed pfim image mipmap. TODO: make this an IImage extension and move elsewhere?

format : ImageFormat
mipmap : MipMapOffset
data : byte array
Returns: Vector2i * byte[]

Texture.TryCreateTextureData (minimal, filePath)

Full Usage: Texture.TryCreateTextureData (minimal, filePath)

Parameters:
    minimal : bool
    filePath : string

Returns: TextureData option

Attempt to create uploadable texture data from the given file path. Don't forget to dispose the last field when finished with the texture data.

minimal : bool
filePath : string
Returns: TextureData option

Texture.TryCreateTextureGl (minimal, minFilter, magFilter, anisoFilter, mipmaps, blockCompress, filePath)

Full Usage: Texture.TryCreateTextureGl (minimal, minFilter, magFilter, anisoFilter, mipmaps, blockCompress, filePath)

Parameters:
Returns: Either<string, (TextureMetadata * uint32)>

Attempt to create an opengl texture from a file.

minimal : bool
minFilter : TextureMinFilter
magFilter : TextureMagFilter
anisoFilter : bool
mipmaps : bool
blockCompress : bool
filePath : string
Returns: Either<string, (TextureMetadata * uint32)>

Texture.TryFormatUncompressedPfimage (minimal, image)

Full Usage: Texture.TryFormatUncompressedPfimage (minimal, image)

Parameters:
    minimal : bool
    image : IImage

Returns: (Vector2i * byte[] * (Vector2i * byte[]) array) option

Attempt to format an uncompressed pfim image. TODO: make this an IImage extension and move elsewhere?

minimal : bool
image : IImage
Returns: (Vector2i * byte[] * (Vector2i * byte[]) array) option

Texture.TryFormatUncompressedPfimageTexture (format, height, stride, data)

Full Usage: Texture.TryFormatUncompressedPfimageTexture (format, height, stride, data)

Parameters:
    format : ImageFormat
    height : int
    stride : int
    data : byte array

Returns: byte[] option

Attempt to format an uncompressed pfim image texture (non-mipmap). TODO: make this an IImage extension and move elsewhere?

format : ImageFormat
height : int
stride : int
data : byte array
Returns: byte[] option

Type something to start searching.