Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KhronosTextureContainer2

Class for loading KTX2 files

Hierarchy

  • KhronosTextureContainer2

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructor

    Parameters

    • engine: ThinEngine

      The engine to use

    • Optional numWorkers: number

      The number of workers for async operations. Specify 0 to disable web workers and run synchronously in the current context.

    Returns KhronosTextureContainer2

Properties

Static DefaultNumWorkersSearch playground for DefaultNumWorkers

DefaultNumWorkers: number

Default number of workers used to handle data decoding

Static URLConfigSearch playground for URLConfig

URLConfig: { jsDecoderModule: string; jsMSCTranscoder: null; wasmMSCTranscoder: null; wasmUASTCToASTC: null; wasmUASTCToBC7: null; wasmUASTCToRGBA_SRGB: null; wasmUASTCToRGBA_UNORM: null; wasmZSTDDecoder: null }

URLs to use when loading the KTX2 decoder module as well as its dependencies If a url is null, the default url is used (pointing to https://preview.babylonjs.com) Note that jsDecoderModule can't be null and that the other dependencies will only be loaded if necessary Urls you can change: URLConfig.jsDecoderModule URLConfig.wasmUASTCToASTC URLConfig.wasmUASTCToBC7 URLConfig.wasmUASTCToRGBA_UNORM URLConfig.wasmUASTCToRGBA_SRGB URLConfig.jsMSCTranscoder URLConfig.wasmMSCTranscoder URLConfig.wasmZSTDDecoder You can see their default values in this PG: https://playground.babylonjs.com/#EIJH8L#29

Type declaration

  • jsDecoderModule: string
  • jsMSCTranscoder: null
  • wasmMSCTranscoder: null
  • wasmUASTCToASTC: null
  • wasmUASTCToBC7: null
  • wasmUASTCToRGBA_SRGB: null
  • wasmUASTCToRGBA_UNORM: null
  • wasmZSTDDecoder: null

Methods

disposeSearch playground for dispose

  • dispose(): void
  • Stop all async operations and release resources.

    Returns void

Static IsValidSearch playground for IsValid

  • IsValid(data: ArrayBufferView): boolean
  • Checks if the given data starts with a KTX2 file identifier.

    Parameters

    • data: ArrayBufferView

      the data to check

    Returns boolean

    true if the data is a KTX2 file or false otherwise

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method