ImageUtils

Common utilities for working with image data.

Hierarchy

ImageUtils

Constructors

new ImageUtils(): ImageUtils

Methods

extensionToMimeType(extension: string): string

Returns the MIME type for the given file extension.
- Defined in packages/core/src/utils/image-utils.ts:162

getChannels(buffer: Uint8Array, mimeType: string): number

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.
- Defined in packages/core/src/utils/image-utils.ts:128

getMimeType(buffer: Uint8Array): string

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.
- Defined in packages/core/src/utils/image-utils.ts:108

getSize(buffer: Uint8Array, mimeType: string): vec2

Returns the dimensions of the image.
- Defined in packages/core/src/utils/image-utils.ts:118

getVRAMByteLength(buffer: Uint8Array, mimeType: string): number

Returns a conservative estimate of the GPU memory required by this image.
- Defined in packages/core/src/utils/image-utils.ts:134

mimeTypeToExtension(mimeType: string): string

Returns the preferred file extension for the given MIME type.
- Defined in packages/core/src/utils/image-utils.ts:156

registerFormat(mimeType: string, impl: ImageUtilsFormat): void

Registers support for a new image format; useful for certain extensions.
- Defined in packages/core/src/utils/image-utils.ts:99

Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy • TypeDoc documentation • Copyright 2023, MIT license