Interface RenderMaterialBaseParams

Base parameters used to create a RenderMaterial.

interface RenderMaterialBaseParams {
    uniforms?: ReadOnlyInputBindings;
    storages?: ReadWriteInputBindings;
    bindings?: BindGroupBindingElement[];
    bindGroups?: BindGroup[];
    samplers?: Sampler[];
    textures?: MaterialTexture[];
    useProjection: boolean;
    transparent: boolean;
    depth: boolean;
    depthWriteEnabled: boolean;
    depthCompare: GPUCompareFunction;
    depthFormat: GPUTextureFormat;
    cullMode: GPUCullMode;
    sampleCount: number;
    verticesOrder: GPUFrontFace;
    topology: GPUPrimitiveTopology;
    targets?: Partial<GPUColorTargetState>[];
}

Hierarchy (View Summary)

Properties

uniforms? storages? bindings? bindGroups? samplers? textures? useProjection transparent depth depthWriteEnabled depthCompare depthFormat cullMode sampleCount verticesOrder topology targets?

Properties

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.

useProjection

useProjection: boolean

Whether this RenderMaterial should implicitly use the renderer camera and lights bind group.

transparent

transparent: boolean

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

depth

depth: boolean

Whether this RenderMaterial should write to the depth buffer.

depthWriteEnabled

depthWriteEnabled: boolean

Whether this RenderMaterial should enable depth write.

depthCompare

depthCompare: GPUCompareFunction

Depth function to use with this RenderMaterial.

depthFormat

depthFormat: GPUTextureFormat

Format of the depth texture to use with this RenderMateria.l

cullMode

cullMode: GPUCullMode

Cull mode to use with this RenderMaterial.

sampleCount

sampleCount: number

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

verticesOrder

verticesOrder: GPUFrontFace

Vertices order to be used by the render pipeline.

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

Optionaltargets

targets?: Partial<GPUColorTargetState>[]

Optional array of one or multiple targets properties. Format property will be patched internally.

Settings

Member Visibility

On This Page

Properties