Interface TextureParams

Parameters used to create a Texture

interface TextureParams {
    label?: string;
    name?: string;
    fixedSize?: TextureSize;
    qualityRatio?: number;
    type?: TextureBindingType;
    format?: GPUTextureFormat;
    access?: BindingMemoryAccessType;
    viewDimension?: GPUTextureViewDimension;
    sampleCount?: number;
    visibility?: MaterialShadersType[];
    usage?: TextureUsageKeys[];
    autoDestroy?: boolean;
    fromTexture?: DOMTexture | Texture;
    generateMips?: boolean;
    flipY?: boolean;
    premultipliedAlpha?: boolean;
}

Hierarchy (view full)

Properties

label? name? fixedSize? qualityRatio? type? format? access? viewDimension? sampleCount? visibility? usage? autoDestroy? fromTexture? generateMips? flipY? premultipliedAlpha?

Properties

Optional label

label?: string

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

Optional name

name?: string

Name of the Texture to use in the texture binding

Optional fixedSize

fixedSize?: TextureSize

Optional fixed size of the texture. If set, the Texture will never be resized and always keep that size.

Optional qualityRatio

qualityRatio?: number

Force the texture size to be set to the given ratio of the renderer canvas size or fixedSize. Used mainly to shrink render target texture definition.

Optional type

type?: TextureBindingType

Whether to use this Texture as a regular, storage or depth texture

Optional format

format?: GPUTextureFormat

Optional format of the texture, mainly used for storage textures

Optional access

access?: BindingMemoryAccessType

Optional texture binding memory access type, mainly used for storage textures

Optional viewDimension

viewDimension?: GPUTextureViewDimension

Optional texture view dimension to use

Optional sampleCount

sampleCount?: number

Sample count of the texture, used for multisampling

Optional visibility

visibility?: MaterialShadersType[]

The Texture shaders visibility sent to the texture binding

Optional usage

usage?: TextureUsageKeys[]

Allowed usages for the GPU texture as an array of texture usages names

Optional autoDestroy

autoDestroy?: boolean

Whether any Material using this Texture should automatically destroy it upon destruction. Default to true.

Optional fromTexture

fromTexture?: DOMTexture | Texture

Optional texture to use as a copy source input. Could be a Texture or DOMTexture

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.

Settings

Member Visibility

Theme

On This Page