glTF-Transform GitHub stars

ImageUtils

Common utilities for working with image data.

Static properties

impls: Record<string, ImageUtilsFormat>

Static methods

  • getMimeType(buffer: Uint8Array): string | null

  • Returns detected MIME type of the given image buffer. Note that for image formats with support provided by extensions, the extension must be registered with an I/O class before it can be detected by ImageUtils.

  • getSize(buffer: Uint8Array, mimeType: string): vec2 | null
  • getChannels(buffer: Uint8Array, mimeType: string): number | null

  • Returns a conservative estimate of the number of channels in the image. For some image formats, the method may return 4 indicating the possibility of an alpha channel, without the ability to guarantee that an alpha channel is present.

  • getVRAMByteLength(buffer: Uint8Array, mimeType: string): number | null
  • mimeTypeToExtension(mimeType: string): string
  • extensionToMimeType(extension: string): string

Properties

impls: Record<string, ImageUtilsFormat>

Methods

  • extensionToMimeType(extension: string): string
  • getChannels(buffer: Uint8Array, mimeType: string): number | null

  • Returns a conservative estimate of the number of channels in the image. For some image formats, the method may return 4 indicating the possibility of an alpha channel, without the ability to guarantee that an alpha channel is present.

  • getMimeType(buffer: Uint8Array): string | null

  • Returns detected MIME type of the given image buffer. Note that for image formats with support provided by extensions, the extension must be registered with an I/O class before it can be detected by ImageUtils.

  • getSize(buffer: Uint8Array, mimeType: string): vec2 | null
  • getVRAMByteLength(buffer: Uint8Array, mimeType: string): number | null
  • mimeTypeToExtension(mimeType: string): string
Function symbol, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy • Documented with greendoc • © 2023 MIT License