ITextureCreationOptions | Babylon.js API documentation

Interface ITextureCreationOptions

Defines the available options when creating a texture

interface ITextureCreationOptions {
    buffer?: Nullable<
        | string
        | ArrayBufferView
        | ArrayBuffer
        | Blob
        | ImageBitmap
        | HTMLImageElement,
    >;
    creationFlags?: number;
    deleteBuffer?: boolean;
    forcedExtension?: string;
    format?: number;
    gammaSpace?: boolean;
    internalTexture?: InternalTexture;
    invertY?: boolean;
    loaderOptions?: any;
    mimeType?: string;
    noMipmap?: boolean;
    onError?: Nullable<(message?: string, exception?: any) => void>;
    onLoad?: Nullable<() => void>;
    samplingMode?: number;
    useSRGBBuffer?: boolean;
}

Hierarchy (View Summary)

ITextureCreationOptions
- IDynamicTextureOptions

Index

Properties

buffer? creationFlags? deleteBuffer? forcedExtension? format? gammaSpace? internalTexture? invertY? loaderOptions? mimeType? noMipmap? onError? onLoad? samplingMode? useSRGBBuffer?

Properties

`Optional`buffer

Defines the buffer to load the texture from in case the texture is loaded from a buffer representation (default: null)

`Optional`creationFlags

creationFlags?: number

Specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg) (default: undefined)

`Optional`deleteBuffer

deleteBuffer?: boolean

Defines if the buffer we are loading the texture from should be deleted after load (default: false)

`Optional`forcedExtension

forcedExtension?: string

Defines the extension to use to pick the right loader

`Optional`format

format?: number

Defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...) (default: )

`Optional`gammaSpace

gammaSpace?: boolean

Defines the underlying texture texture space

`Optional`internalTexture

internalTexture?: InternalTexture

Defines the underlying texture from an already existing one

`Optional`invertY

invertY?: boolean

Defines if the texture needs to be inverted on the y axis during loading (default: true)

`Optional`loaderOptions

loaderOptions?: any

Options to be passed to the loader (default: undefined)

`Optional`mimeType

mimeType?: string

Defines an optional mime type information (default: undefined)

`Optional`noMipmap

noMipmap?: boolean

Defines if the texture will require mip maps or not (default: false)

`Optional`onError

onError?: Nullable<(message?: string, exception?: any) => void>

Defines a callback triggered when an error occurred during the loading session (default: null)

`Optional`onLoad

onLoad?: Nullable<() => void>

Defines a callback triggered when the texture has been loaded (default: null)

`Optional`samplingMode

samplingMode?: number

Defines the sampling mode we want for the texture while fetching from it (Texture.NEAREST_SAMPLINGMODE...) (default: Texture.TRILINEAR_SAMPLINGMODE)

`Optional`useSRGBBuffer

useSRGBBuffer?: boolean

Defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU) (default: false)

Interface ITextureCreationOptions

Hierarchy (View Summary)

Index

Properties

Properties

`Optional`buffer

`Optional`creationFlags

`Optional`deleteBuffer

`Optional`forcedExtension

`Optional`format

`Optional`gammaSpace

`Optional`internalTexture

`Optional`invertY

`Optional`loaderOptions

`Optional`mimeType

`Optional`noMipmap

`Optional`onError

`Optional`onLoad

`Optional`samplingMode

`Optional`useSRGBBuffer

Settings

On This Page

Interface ITextureCreationOptions

Hierarchy (View Summary)

Index

Properties

Properties

Optionalbuffer

OptionalcreationFlags

OptionaldeleteBuffer

OptionalforcedExtension

Optionalformat

OptionalgammaSpace

OptionalinternalTexture

OptionalinvertY

OptionalloaderOptions

OptionalmimeType

OptionalnoMipmap

OptionalonError

OptionalonLoad

OptionalsamplingMode

OptionaluseSRGBBuffer

Settings

On This Page

`Optional`buffer

`Optional`creationFlags

`Optional`deleteBuffer

`Optional`forcedExtension

`Optional`format

`Optional`gammaSpace

`Optional`internalTexture

`Optional`invertY

`Optional`loaderOptions

`Optional`mimeType

`Optional`noMipmap

`Optional`onError

`Optional`onLoad

`Optional`samplingMode

`Optional`useSRGBBuffer