Interface ShaderPassOptions

Base options used to create this Mesh

interface ShaderPassOptions {
    label?: string;
    shaders?: MaterialShaders;
    texturesOptions?: ExternalTextureParams;
    outputTarget?: RenderTarget;
    autoRender?: boolean;
    useAsyncPipeline?: boolean;
    copyOutputToRenderTexture?: boolean;
    uniforms?: ReadOnlyInputBindings;
    storages?: ReadWriteInputBindings;
    bindings?: BindGroupBindingElement[];
    bindGroups?: BindGroup[];
    samplers?: Sampler[];
    textures?: Texture[];
    domTextures?: DOMTexture[];
    useProjection?: boolean;
    transparent?: boolean;
    depth?: boolean;
    depthWriteEnabled?: boolean;
    depthCompare?: GPUCompareFunction;
    depthFormat?: GPUTextureFormat;
    cullMode?: GPUCullMode;
    sampleCount?: number;
    targets?: GPUColorTargetState[];
    verticesOrder?: GPUFrontFace;
    topology?: GPUPrimitiveTopology;
}

Hierarchy (view full)

Properties

label? shaders? texturesOptions? outputTarget? autoRender? useAsyncPipeline? copyOutputToRenderTexture? uniforms? storages? bindings? bindGroups? samplers? textures? domTextures? useProjection? transparent? depth? depthWriteEnabled? depthCompare? depthFormat? cullMode? sampleCount? targets? verticesOrder? topology?

Properties

Optional label

label?: string

The label of this Mesh, sent to various GPU objects for debugging purpose

Optional shaders

shaders?: MaterialShaders

Shaders to use by this Mesh RenderMaterial

Optional texturesOptions

texturesOptions?: ExternalTextureParams

Parameters used by this Mesh to create a DOMTexture

Optional outputTarget

outputTarget?: RenderTarget

RenderTarget to render this Mesh to instead of the canvas context, if any.

Optional autoRender

autoRender?: boolean

Whether we should add this Mesh to our Scene to let it handle the rendering process automatically

Optional useAsyncPipeline

useAsyncPipeline?: boolean

Whether to compile this Mesh RenderMaterial render pipeline asynchronously or not

Optional copyOutputToRenderTexture

copyOutputToRenderTexture?: boolean

Whether the result of this ShaderPass should be copied to the renderTexture after each render. Default to false.

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

Optional useProjection

useProjection?: boolean

Whether this RenderMaterial should implicitly use the renderer camera bind group

Optional transparent

transparent?: boolean

Whether this RenderMaterial should be treated as transparent. Impacts the render pipeline blend property

Optional depth

depth?: boolean

Whether this RenderMaterial should write to the depth buffer

Optional depthWriteEnabled

depthWriteEnabled?: boolean

Whether this RenderMaterial should enable depth write

Optional depthCompare

depthCompare?: GPUCompareFunction

Depth function to use with this RenderMaterial

Optional depthFormat

depthFormat?: GPUTextureFormat

Format of the depth texture to use with this RenderMaterial

Optional cullMode

cullMode?: GPUCullMode

Cull mode to use with this RenderMaterial

Optional sampleCount

sampleCount?: number

The sampleCount of the RenderPass onto which we'll be drawing. Set internally.

Optional targets

targets?: GPUColorTargetState[]

Array of one or multiple targets properties.

Each target should be an object with the optional format, blend and writeMask properties.

The format property will be internally patched to match the output RenderPass target (default to the renderer preferred format).

If defined, the blend property can override the default transparent blending if set.

Optional verticesOrder

verticesOrder?: GPUFrontFace

Vertices order to be used by the render pipeline

Optional topology

topology?: GPUPrimitiveTopology

Topology to use with this RenderMaterial, i.e. whether to draw triangles or points (see https://www.w3.org/TR/webgpu/#enumdef-gpuprimitivetopology)

Settings

Member Visibility

Theme

On This Page