Interface SceneObjectTextureOptions

Parameters used by the various scene objects (meshes and compute passes) for their textures options.

interface SceneObjectTextureOptions {
    format?: GPUTextureFormat;
    generateMips?: boolean;
    flipY?: boolean;
    premultipliedAlpha?: boolean;
    viewDimension?: GPUTextureViewDimension;
    aspect?: GPUTextureAspect;
    colorSpace?: PredefinedColorSpace;
    visibility?: MaterialShadersType[];
    placeholderColor?: [number, number, number, number];
    useExternalTextures?: boolean;
    cache?: boolean;
    useTransform?: boolean;
}

Hierarchy (View Summary)

Properties

format? generateMips? flipY? premultipliedAlpha? viewDimension? aspect? colorSpace? visibility? placeholderColor? useExternalTextures? cache? useTransform?

Properties

Optionalformat

format?: GPUTextureFormat

The GPUTexture format to use. Default to 'rgba8unorm'.

OptionalgenerateMips

generateMips?: boolean

Whether to generate mips. Default to false.

OptionalflipY

flipY?: boolean

Whether to flip the source along the Y axis. Default to false.

OptionalpremultipliedAlpha

premultipliedAlpha?: boolean

Whether this texture should be premultiplied or not. Default to false.

OptionalviewDimension

viewDimension?: GPUTextureViewDimension

The GPUTexture view dimension to use. Default to '2d'.

Optionalaspect

aspect?: GPUTextureAspect

Define which aspect of the texture to write the image to. Default to all.

OptionalcolorSpace

colorSpace?: PredefinedColorSpace

Define the colorSpace and encoding used to encode data into the destination texture. Default to srgb.

Optionalvisibility

visibility?: MaterialShadersType[]

The texture shaders visibility sent to the texture binding. Default to 'fragment'.

OptionalplaceholderColor

placeholderColor?: [number, number, number, number]

Solid color used by temporary texture to display while loading the source, as an array of RGBA integer values in the [0, 255] range. Default to [0, 0, 0, 255] (solid black).

OptionaluseExternalTextures

useExternalTextures?: boolean

Whether video textures should use GPUExternalTexture or not. Default to true.

Optionalcache

cache?: boolean

Whether to keep the texture in the renderer cache when a Material tries to destroy it. Default to true.

OptionaluseTransform

useTransform?: boolean

Whether to use a transformation Mat3 to use in the shaders for UV transformations. If set to true, will create a BufferBinding accessible in the shaders with the name ${texture.options.name}Matrix.

Settings

Member Visibility

On This Page

Properties