Interface ComputePassParams

An object defining all possible ComputePass class instancing parameters.

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

Hierarchy (View Summary)

Properties

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

Properties

Optionallabel

label?: string

The label of the ComputePass.

OptionalrenderOrder

renderOrder?: number

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

OptionalautoRender

autoRender?: boolean

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

Optionalactive

active?: boolean

Flag indicating whether this ComputePass should run or not, much like the Mesh visible flag. Default to true.

Optionalshaders

shaders?: MaterialShaders

Compute shader passed to the ComputePass following the shader object notation.

OptionaluseAsyncPipeline

useAsyncPipeline?: boolean

whether the compute pipeline should be compiled asynchronously.

OptionaltexturesOptions

texturesOptions?: SceneObjectTextureOptions

Parameters used by this ComputePass to create a MediaTexture.

OptionaldispatchSize

dispatchSize?: number | number[]

Default ComputeMaterial work group dispatch size to use with this ComputePass.

Optionaluniforms

uniforms?: ReadOnlyInputBindings

Uniforms input to pass to a BindGroup.

Optionalstorages

storages?: ReadWriteInputBindings

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

Optionalbindings

bindings?: BindGroupBindingElement[]

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

OptionalbindGroups

bindGroups?: BindGroup[]

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

Optionalsamplers

samplers?: Sampler[]

Array of already created samplers to be used by this Material.

Optionaltextures

textures?: MaterialTexture[]

Array of already created Texture or MediaTexture to be used by this Material.

Settings

Member Visibility

On This Page

Properties