Interface MeshBaseParams

Base parameters used to create a Mesh.

interface MeshBaseParams {
    autoRender?: boolean;
    visible?: boolean;
    renderOrder?: number;
    outputTarget?: RenderTarget;
    additionalOutputTargets?: RenderTarget[];
    useCustomScenePassEntry?: RenderPassEntry;
    texturesOptions?: SceneObjectTextureOptions;
    targets?: Partial<GPUColorTargetState>[];
    renderBundle?: RenderBundle;
    geometry?: AllowedGeometries;
    uniforms?: ReadOnlyInputBindings;
    storages?: ReadWriteInputBindings;
    bindings?: BindGroupBindingElement[];
    label?: string;
    shaders?: MaterialShaders;
    useAsyncPipeline?: boolean;
    bindGroups?: BindGroup[];
    samplers?: Sampler[];
    textures?: MaterialTexture[];
    useProjection?: boolean;
    transparent?: boolean;
    depth?: boolean;
    depthWriteEnabled?: boolean;
    depthCompare?: GPUCompareFunction;
    depthFormat?: GPUTextureFormat;
    cullMode?: GPUCullMode;
    sampleCount?: number;
}

Hierarchy (View Summary)

Properties

autoRender? visible? renderOrder? outputTarget? additionalOutputTargets? useCustomScenePassEntry? texturesOptions? targets? renderBundle? geometry? uniforms? storages? bindings? label? shaders? useAsyncPipeline? bindGroups? samplers? textures? useProjection? transparent? depth? depthWriteEnabled? depthCompare? depthFormat? cullMode? sampleCount?

Properties

OptionalautoRender

autoRender?: boolean

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

Optionalvisible

visible?: boolean

Flag indicating whether to draw this Mesh or not.

OptionalrenderOrder

renderOrder?: number

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

OptionaloutputTarget

outputTarget?: RenderTarget

Optional RenderTarget to render this Mesh to instead of the canvas context.

OptionaladditionalOutputTargets

additionalOutputTargets?: RenderTarget[]

Additional output RenderTarget onto which render this Mesh, besides the main outputTarget or screen. Useful for some effects that might need to render the same Mesh twice or more. Beware tho that the Mesh pipeline has to exactly fit the provided RenderTarget render passes descriptors as no checks will be performed here.

OptionaluseCustomScenePassEntry

useCustomScenePassEntry?: RenderPassEntry

Whether to render this Mesh into a custom Scene custom screen pass entry instead of the default one.

OptionaltexturesOptions

texturesOptions?: SceneObjectTextureOptions

Parameters used by this Mesh to create a MediaTexture.

Optionaltargets

targets?: Partial<GPUColorTargetState>[]

Optional ().targets | targets properties.

OptionalrenderBundle

renderBundle?: RenderBundle

Optional RenderBundle into which this Mesh should be added.

Optionalgeometry

geometry?: AllowedGeometries

Geometry to use

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.

Optionallabel

label?: string

The label of the Material, sent to various GPU objects for debugging purpose.

Optionalshaders

shaders?: MaterialShaders

Shaders to use with this Material.

OptionaluseAsyncPipeline

useAsyncPipeline?: boolean

Whether to compile the Material GPURenderPipeline or GPUComputePipeline asynchronously or not.

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.

OptionaluseProjection

useProjection?: boolean

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

Optionaltransparent

transparent?: boolean

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

Optionaldepth

depth?: boolean

Whether this RenderMaterial should write to the depth buffer.

OptionaldepthWriteEnabled

depthWriteEnabled?: boolean

Whether this RenderMaterial should enable depth write.

OptionaldepthCompare

depthCompare?: GPUCompareFunction

Depth function to use with this RenderMaterial.

OptionaldepthFormat

depthFormat?: GPUTextureFormat

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

OptionalcullMode

cullMode?: GPUCullMode

Cull mode to use with this RenderMaterial.

OptionalsampleCount

sampleCount?: number

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

Settings

Member Visibility

On This Page

Properties