Interface RenderMaterialBaseParams

Base parameters used to create a RenderMaterial

interface RenderMaterialBaseParams {
    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

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

Properties

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

useProjection

useProjection: boolean

Whether this RenderMaterial should implicitly use the renderer camera 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 RenderMaterial

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.

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.

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)

Settings

Member Visibility

Theme

On This Page