Interface TextureParams

Parameters used to create a Texture.

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

Hierarchy (View Summary)

Properties

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

Properties

Optionallabel

label?: string

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

Optionalname

name?: string

Name of the Texture to use in the texture binding.

OptionalfixedSize

fixedSize?: TextureSize

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

Optionalusage

usage?: TextureUsageKeys[]

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

OptionalautoDestroy

autoDestroy?: boolean

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

OptionalfromTexture

fromTexture?: DOMTexture | MediaTexture | Texture

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

OptionalqualityRatio

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.

Optionaltype

type?: TextureBindingType

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

Optionalaccess

access?: BindingMemoryAccessType

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

OptionalsampleCount

sampleCount?: number

Sample count of the texture, used for multisampling.

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'.

Settings

Member Visibility

On This Page

Properties