Interface DOMTextureOptions

Options used to create this DOMTexture

interface DOMTextureOptions {
    generateMips?: boolean;
    flipY?: boolean;
    premultipliedAlpha?: boolean;
    format?: GPUTextureFormat;
    placeholderColor?: [number, number, number, number];
    useExternalTextures?: boolean;
    viewDimension?: GPUTextureViewDimension;
    visibility?: MaterialShadersType[];
    cache?: boolean;
    label?: string;
    name?: string;
    fromTexture?: DOMTexture;
    source: string | OffscreenCanvas | ImageBitmap | VideoFrame | HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | ImageData;
    sourceType: TextureSourceType;
}

Hierarchy (view full)

Properties

generateMips? flipY? premultipliedAlpha? format? placeholderColor? useExternalTextures? viewDimension? visibility? cache? label? name? fromTexture? source sourceType

Properties

Optional generateMips

generateMips?: boolean

Whether to generate mips. Default to false.

Optional flipY

flipY?: boolean

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

Optional premultipliedAlpha

premultipliedAlpha?: boolean

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

Optional format

format?: GPUTextureFormat

The GPUTextureFormat | texture format to use. Default to 'rgba8unorm'.

Optional placeholderColor

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

Solid color used by temporary texture to display while loading the source. Default to [0, 0, 0, 255] (solid black).

Optional useExternalTextures

useExternalTextures?: boolean

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

Optional viewDimension

viewDimension?: GPUTextureViewDimension

The GPUTextureViewDimension | texture view dimension to use. Default to '2d'.

Optional visibility

visibility?: MaterialShadersType[]

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

Optional cache

cache?: boolean

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

Optional label

label?: string

The label of the DOMTexture, used to create various GPU objects for debugging purpose

Optional name

name?: string

Name of the DOMTexture to use in the binding

Optional fromTexture

fromTexture?: DOMTexture

Optional DOMTexture to use as a copy source input

source

source: string | OffscreenCanvas | ImageBitmap | VideoFrame | HTMLCanvasElement | HTMLImageElement | HTMLVideoElement | ImageData

DOMTexture source

sourceType

sourceType: TextureSourceType

DOMTexture source type

Settings

Member Visibility

Theme

On This Page