Interface ComputePassParams

An object defining all possible ComputePass class instancing parameters

interface ComputePassParams {
    label?: string;
    renderOrder?: number;
    autoRender?: boolean;
    shaders?: MaterialShaders;
    useAsyncPipeline?: boolean;
    texturesOptions?: ExternalTextureParams;
    dispatchSize?: number | number[];
    uniforms?: ReadOnlyInputBindings;
    storages?: ReadWriteInputBindings;
    bindings?: BindGroupBindingElement[];
    bindGroups?: BindGroup[];
    samplers?: Sampler[];
    textures?: Texture[];
    domTextures?: DOMTexture[];
}

Hierarchy (view full)

Properties

label? renderOrder? autoRender? shaders? useAsyncPipeline? texturesOptions? dispatchSize? uniforms? storages? bindings? bindGroups? samplers? textures? domTextures?

Properties

Optional label

label?: string

The label of the ComputePass

Optional renderOrder

renderOrder?: number

Controls the order in which this ComputePass should be rendered by our Scene

Optional autoRender

autoRender?: boolean

Whether the ComputePass should be added to our Scene to let it handle the rendering process automatically

Optional shaders

shaders?: MaterialShaders

Compute shader passed to the ComputePass following the shader object notation

Optional useAsyncPipeline

useAsyncPipeline?: boolean

whether the compute pipeline should be compiled asynchronously

Optional texturesOptions

texturesOptions?: ExternalTextureParams

Parameters used by this ComputePass to create a DOMTexture

Optional dispatchSize

dispatchSize?: number | number[]

Default ComputeMaterial work group dispatch size to use with this ComputePass

Optional uniforms

uniforms?: ReadOnlyInputBindings

uniforms input to pass to a BindGroup

Optional storages

storages?: ReadWriteInputBindings

read only or read/write storages input to pass to a BindGroup

Optional bindings

bindings?: BindGroupBindingElement[]

array of already created bindings (buffers, texture, etc.) to pass to this BindGroup

Optional bindGroups

bindGroups?: BindGroup[]

Array of already created bind groups to be used by this Material

Optional samplers

samplers?: Sampler[]

Array of already created samplers to be used by this Material

Optional textures

textures?: Texture[]

Array of already created Texture to be used by this Material

Optional domTextures

domTextures?: DOMTexture[]

Array of already created DOMTexture to be used by this Material

Settings

Member Visibility

Theme

On This Page