docs.unity3d.com
    Show / Hide Table of Contents

    Class BasisUniversalTexture

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

    Inheritance
    Object
    TextureBase
    BasisUniversalTexture
    Inherited Members
    TextureBase.LoadFromStreamingAssets(String, Boolean, UInt32, UInt32, UInt32, Boolean)
    TextureBase.LoadFromStreamingAssets(String, GraphicsFormat, UInt32, UInt32, UInt32, Boolean)
    TextureBase.LoadFromUrl(String, Boolean, UInt32, UInt32, UInt32, Boolean)
    TextureBase.LoadFromUrl(String, GraphicsFormat, UInt32, UInt32, UInt32, Boolean)
    TextureBase.LoadFromBytes(NativeSlice<Byte>, Boolean, UInt32, UInt32, UInt32, Boolean)
    TextureBase.LoadFromBytes(NativeSlice<Byte>, GraphicsFormat, UInt32, UInt32, UInt32, Boolean)
    TextureBase.GetStreamingAssetsUrl(String)
    Namespace: KtxUnity
    Syntax
    public class BasisUniversalTexture : TextureBase

    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
    TextureBase.Dispose()
    See Also
    Open(Unity.Collections.NativeSlice<Byte>)
    LoadTexture2D(Boolean, UInt32, UInt32, UInt32, Boolean)
    LoadTexture2D(UnityEngine.Experimental.Rendering.GraphicsFormat, UInt32, UInt32, UInt32, Boolean)
    Dispose()

    LoadTexture2D(Boolean, UInt32, UInt32, UInt32, Boolean)

    Creates a UnityEngine.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 async Task<TextureResult> LoadTexture2D(bool linear = false, uint layer = 0U, uint faceSlice = 0U, uint mipLevel = 0U, bool mipChain = true)
    Parameters
    Type Name Description
    Boolean linear

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

    UInt32 layer

    Texture array layer to import

    UInt32 faceSlice

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

    UInt32 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.

    Boolean 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
    TextureBase.LoadTexture2D(Boolean, UInt32, UInt32, UInt32, Boolean)
    See Also
    Open(Unity.Collections.NativeSlice<Byte>)
    Dispose()

    LoadTexture2D(GraphicsFormat, UInt32, UInt32, UInt32, Boolean)

    Creates a UnityEngine.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 async Task<TextureResult> LoadTexture2D(GraphicsFormat targetFormat, uint layer = 0U, uint faceSlice = 0U, uint mipLevel = 0U, bool mipChain = true)
    Parameters
    Type Name Description
    UnityEngine.Experimental.Rendering.GraphicsFormat targetFormat

    Desired texture format

    UInt32 layer

    Texture array layer to import

    UInt32 faceSlice

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

    UInt32 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.

    Boolean 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
    TextureBase.LoadTexture2D(GraphicsFormat, UInt32, UInt32, UInt32, Boolean)
    See Also
    Open(Unity.Collections.NativeSlice<Byte>)
    Dispose()

    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
    Unity.Collections.NativeSlice<Byte> data

    Input texture data

    Returns
    Type Description
    ErrorCode

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

    Overrides
    TextureBase.Open(NativeSlice<Byte>)
    See Also
    LoadTexture2D(Boolean, UInt32, UInt32, UInt32, Boolean)
    LoadTexture2D(UnityEngine.Experimental.Rendering.GraphicsFormat, UInt32, UInt32, UInt32, Boolean)
    Dispose()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023