Class KtxTexture

Loads a KTX texture from the StreamingAssets folder, a URL, or a buffer.

Inheritance
object
TextureBase
KtxTexture
Inherited Members
Namespace: KtxUnity
Assembly: Ktx.dll
Syntax
public class KtxTexture : TextureBase

Properties

baseDepth

Depth of largest mipmap level in pixels

Declaration
public uint baseDepth { get; }
Property Value
Type Description
uint

baseHeight

Height of largest mipmap level in pixels

Declaration
public uint baseHeight { get; }
Property Value
Type Description
uint

baseWidth

Width of largest mipmap level in pixels

Declaration
public uint baseWidth { get; }
Property Value
Type Description
uint

hasAlpha

True if the texture has an alpha channel.

Declaration
public bool hasAlpha { get; }
Property Value
Type Description
bool

isArray

True if texture is of type array

Declaration
public bool isArray { get; }
Property Value
Type Description
bool

isCompressed

True if texture is compressed

Declaration
public bool isCompressed { get; }
Property Value
Type Description
bool

isCubemap

True if texture is of type cube map

Declaration
public bool isCubemap { get; }
Property Value
Type Description
bool

isMultipleOfFour

True if both pixel width and height are a multiple of four.

Declaration
public bool isMultipleOfFour { get; }
Property Value
Type Description
bool

isPowerOfTwo

True if both pixel width and height are a power of two.

Declaration
public bool isPowerOfTwo { get; }
Property Value
Type Description
bool

isSquare

True if texture is square (width equals height)

Declaration
public bool isSquare { get; }
Property Value
Type Description
bool

needsTranscoding

Query if the texture is in a transcodable format.

Declaration
public bool needsTranscoding { get; }
Property Value
Type Description
bool

numDimensions

Number of dimensions

Declaration
public uint numDimensions { get; }
Property Value
Type Description
uint

numFaces

Number of faces (e.g. six for cube maps)

Declaration
public uint numFaces { get; }
Property Value
Type Description
uint

numLayers

Number of layers

Declaration
public uint numLayers { get; }
Property Value
Type Description
uint

numLevels

Number of levels

Declaration
public uint numLevels { get; }
Property Value
Type Description
uint

orientation

Texture's orientation

Declaration
public TextureOrientation orientation { get; }
Property Value
Type Description
TextureOrientation

Methods

Dispose()

Releases all resources. Part of the low-level API that provides finer control over the loading process.

Declaration
public override void Dispose()
Overrides
See Also

LoadTexture2D(bool, uint, uint, uint, bool)

Creates a Texture2D from the previously opened texture. Transcodes or decodes the texture into a GPU compatible format (if required) and uploads it to GPU memory. Part of the low-level API that provides finer control over the loading process.

Declaration
public override Task<TextureResult> LoadTexture2D(bool linear = false, uint layer = 0, uint faceSlice = 0, uint mipLevel = 0, bool mipChain = true)
Parameters
Type Name Description
bool linear

Depicts if texture is sampled in linear or sRGB gamma color space.
uint layer

Texture array layer to import
uint faceSlice

Cubemap face or 3D/volume texture slice to import.
uint mipLevel

Lowest mipmap level to import (where 0 is the highest resolution). Lower mipmap levels (of higher resolution) are being discarded. Useful to limit texture resolution.
bool mipChain

If true, a mipmap chain (if present) is imported.
Returns
Type Description
Task<TextureResult>

A TextureResult that contains an ErrorCode, the resulting texture and its orientation.
Overrides
See Also

LoadTexture2D(GraphicsFormat, uint, uint, uint, bool)

Creates a Texture2D from the previously opened texture. Transcodes or decodes the texture into a desired GPU compatible format (if required) and uploads it to GPU memory. Part of the low-level API that provides finer control over the loading process.

Declaration
public override Task<TextureResult> LoadTexture2D(GraphicsFormat targetFormat, uint layer = 0, uint faceSlice = 0, uint mipLevel = 0, bool mipChain = true)
Parameters
Type Name Description
GraphicsFormat targetFormat

Desired texture format
uint layer

Texture array layer to import
uint faceSlice

Cubemap face or 3D/volume texture slice to import.
uint mipLevel

Lowest mipmap level to import (where 0 is the highest resolution). Lower mipmap levels (of higher resolution) are being discarded. Useful to limit texture resolution.
bool mipChain

If true, a mipmap chain (if present) is imported.
Returns
Type Description
Task<TextureResult>

A TextureResult that contains an ErrorCode, the resulting texture and its orientation.
Overrides
See Also

Open(NativeSlice<byte>)

Loads a texture from memory. Part of the low-level API that provides finer control over the loading process.

Declaration
public override ErrorCode Open(NativeSlice<byte> data)
Parameters
Type Name Description
NativeSlice<byte> data

Input texture data
Returns
Type Description
ErrorCode

Success if loading was successful or an error specific code otherwise.
Overrides
See Also