Texture (Nu) | Nu

Texture Module

Namespace: OpenGL
Assembly: Nu.dll

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.
TextureCompression	The compression to use for a texture, if any.
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.CreateTextureGlFromData (minFilter, magFilter, anisoFilter, mipmaps, compression, textureData)` Full Usage: `Texture.CreateTextureGlFromData (minFilter, magFilter, anisoFilter, mipmaps, compression, textureData)` Parameters: minFilter : `TextureMinFilter` magFilter : `TextureMagFilter` anisoFilter : `bool` mipmaps : `bool` compression : `TextureCompression` textureData : `TextureData` 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` compression : `TextureCompression` textureData : `TextureData` Returns: `TextureMetadata * uint32`
`Texture.DetectCompressionDds dds` Full Usage: `Texture.DetectCompressionDds dds` Parameters: dds : `DdsFile` Returns: `bool`	Detect that a dds file uses a compressed representation. dds : `DdsFile` Returns: `bool`
`Texture.DetectCompressionKtx ktx` Full Usage: `Texture.DetectCompressionKtx ktx` Parameters: ktx : `KtxFile` Returns: `bool`	Detect that a ktx file uses a compressed representation. ktx : `KtxFile` 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. minimal : `bool` dds : `Dds` Returns: `Vector2i * byte[] * (Vector2i * byte[]) array`
`Texture.FormatUncompressedPfimageMipmap (format, mipmap, data)` Full Usage: `Texture.FormatUncompressedPfimageMipmap (format, mipmap, data)` Parameters: format : `ImageFormat` mipmap : `MipMapOffset` data : `byte array` Returns: `Vector2i * byte[]`	Attempt to format an uncompressed pfim image mipmap. format : `ImageFormat` mipmap : `MipMapOffset` data : `byte array` Returns: `Vector2i * byte[]`
`Texture.InferCompression filePath` Full Usage: `Texture.InferCompression filePath` Parameters: filePath : `string` Returns: `TextureCompression`	Infer the type of block compression that an asset with the given file path should utilize. filePath : `string` Returns: `TextureCompression`
`Texture.InferFiltered2d filePath` Full Usage: `Texture.InferFiltered2d filePath` Parameters: filePath : `string` Returns: `bool`	Infer that an asset with the given file path should be filtered in a 2D rendering context. filePath : `string` Returns: `bool`
`Texture.TryCompressImage image` Full Usage: `Texture.TryCompressImage image` Parameters: image : `MagickImage` Returns: `(Vector2i * byte array) option`	Attempt to compress a MagickImage to astc bytes. image : `MagickImage` Returns: `(Vector2i * byte array) option`
`Texture.TryCompressMipmaps image` Full Usage: `Texture.TryCompressMipmaps image` Parameters: image : `MagickImage` Returns: `(Vector2i * byte array) list option`	Attempt to compress astc mipmap bytes from a MagickImage. image : `MagickImage` Returns: `(Vector2i * byte array) list option`
`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, compression, filePath)` Full Usage: `Texture.TryCreateTextureGl (minimal, minFilter, magFilter, anisoFilter, mipmaps, compression, filePath)` Parameters: minimal : `bool` minFilter : `TextureMinFilter` magFilter : `TextureMagFilter` anisoFilter : `bool` mipmaps : `bool` compression : `TextureCompression` filePath : `string` Returns: `Either<string, (TextureMetadata * uint32)>`	Attempt to create an opengl texture from a file. minimal : `bool` minFilter : `TextureMinFilter` magFilter : `TextureMagFilter` anisoFilter : `bool` mipmaps : `bool` compression : `TextureCompression` 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. 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). format : `ImageFormat` height : `int` stride : `int` data : `byte array` Returns: `byte[] option`
`Texture.TryGenerateUncompressedImage image` Full Usage: `Texture.TryGenerateUncompressedImage image` Parameters: image : `MagickImage` Returns: `(Vector2i * byte[]) option`	Attempt to generate uncompressed astc bytes an MagickImage to astc bytes. image : `MagickImage` Returns: `(Vector2i * byte[]) option`
`Texture.TryGenerateUncompressedMipmaps image` Full Usage: `Texture.TryGenerateUncompressedMipmaps image` Parameters: image : `MagickImage` Returns: `(Vector2i * byte[]) list option`	Attempt to generate uncompressed astc mipmap bytes from a MagickImage. image : `MagickImage` Returns: `(Vector2i * byte[]) list option`
`Texture.WriteKtxHeader (resolution, mipmapLevels, compressed, writer)` Full Usage: `Texture.WriteKtxHeader (resolution, mipmapLevels, compressed, writer)` Parameters: resolution : `Vector2i` mipmapLevels : `int` compressed : `bool` writer : `BinaryWriter`	Write the binary header of a ktx file. Implementation based on https://registry.khronos.org/KTX/specs/1.0/ktxspec.v1.html resolution : `Vector2i` mipmapLevels : `int` compressed : `bool` writer : `BinaryWriter`