Interface PlaneParams

Parameters used to create a Plane

interface PlaneParams {
    widthSegments?: number;
    heightSegments?: number;
    autoRender?: boolean;
    visible?: boolean;
    renderOrder?: number;
    outputTarget?: RenderTarget;
    additionalOutputTargets?: RenderTarget[];
    useCustomScenePassEntry?: RenderPassEntry;
    texturesOptions?: SceneObjectTextureOptions;
    targets?: Partial<GPUColorTargetState>[];
    renderBundle?: RenderBundle;
    autoloadSources?: boolean;
    watchScroll?: boolean;
    domTextures?: DOMTexture[];
    geometry?: PlaneGeometry;
    uniforms?: ReadOnlyInputBindings;
    storages?: ReadWriteInputBindings;
    bindings?: BindGroupBindingElement[];
    instancesCount?: number;
    topology?: GPUPrimitiveTopology;
    vertexBuffers?: VertexBufferParams[];
    mapBuffersAtCreation?: boolean;
    label?: string;
    shaders?: MaterialShaders;
    useAsyncPipeline?: boolean;
    bindGroups?: BindGroup[];
    samplers?: Sampler[];
    textures?: MaterialTexture[];
    useProjection?: boolean;
    transparent?: boolean;
    depth?: boolean;
    depthWriteEnabled?: boolean;
    depthCompare?: GPUCompareFunction;
    depthFormat?: GPUTextureFormat;
    depthBias?: number;
    depthBiasClamp?: number;
    depthBiasSlopeScale?: number;
    stencil?: {
        front: GPUStencilFaceState;
        back?: GPUStencilFaceState;
        stencilReference?: number;
        stencilReadMask?: number;
        stencilWriteMask?: number;
    };
    sampleCount?: number;
    alphaToCoverageEnabled?: boolean;
    mask?: number;
    cullMode?: GPUCullMode;
    unclippedDepth?: boolean;
}

Hierarchy (View Summary)

Properties

widthSegments? heightSegments? autoRender? visible? renderOrder? outputTarget? additionalOutputTargets? useCustomScenePassEntry? texturesOptions? targets? renderBundle? autoloadSources? watchScroll? domTextures? geometry? uniforms? storages? bindings? instancesCount? topology? vertexBuffers? mapBuffersAtCreation? label? shaders? useAsyncPipeline? bindGroups? samplers? textures? useProjection? transparent? depth? depthWriteEnabled? depthCompare? depthFormat? depthBias? depthBiasClamp? depthBiasSlopeScale? stencil? sampleCount? alphaToCoverageEnabled? mask? cullMode? unclippedDepth?

Properties

OptionalwidthSegments

widthSegments?: number

Number of segments along the X axis

OptionalheightSegments

heightSegments?: number

Number of segments along the Y axis

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.

OptionalautoloadSources

autoloadSources?: boolean

Whether to automatically create a DOMTexture for all HTMLImageElement, HTMLVideoElement and HTMLCanvasElement child of the specified DOMMesh HTMLElement

OptionalwatchScroll

watchScroll?: boolean

Whether to automatically update the DOMMesh position on scroll

OptionaldomTextures

domTextures?: DOMTexture[]

Array of already created DOMTexture to add to this DOMMesh.

Optionalgeometry

geometry?: PlaneGeometry

Optional PlaneGeometry 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.

OptionalinstancesCount

instancesCount?: number

Number of geometry instances to draw.

Optionaltopology

topology?: GPUPrimitiveTopology

Topology to use with this Geometry, sent to the render pipeline. Whether to draw triangles, lines or points (see https://www.w3.org/TR/webgpu/#enumdef-gpuprimitivetopology).

OptionalvertexBuffers

vertexBuffers?: VertexBufferParams[]

Array of VertexBufferParams used to create VertexBuffer on geometry creation.

OptionalmapBuffersAtCreation

mapBuffersAtCreation?: boolean

Whether to map the vertex buffers at creation.

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

OptionaldepthBias

depthBias?: number

A number representing a constant depth bias that is added to each fragment. Default to 0.

OptionaldepthBiasClamp

depthBiasClamp?: number

A number representing the maximum depth bias of a fragment. Default to 0.

OptionaldepthBiasSlopeScale

depthBiasSlopeScale?: number

A number representing a depth bias that scales with the fragment's slope. Default to 0.

Optionalstencil

stencil?: {
    front: GPUStencilFaceState;
    back?: GPUStencilFaceState;
    stencilReference?: number;
    stencilReadMask?: number;
    stencilWriteMask?: number;
}

Define the stencil operations to use if any.

Type declaration

  • front: GPUStencilFaceState

    Defines how stencil comparisons and operations are performed for front-facing primitives.

  • Optionalback?: GPUStencilFaceState

    Defines how stencil comparisons and operations are performed for back-facing primitives. If undefined, will fall back to front values.

  • OptionalstencilReference?: number

    Set the GPURenderPassEncoder stencil reference value used during stencil tests if any. Default to 0x000000 if a stencil is used.

  • OptionalstencilReadMask?: number

    A bitmask controlling which stencil value bits are read when performing stencil comparison tests. Default to 0xFFFFFF.

  • OptionalstencilWriteMask?: number

    A bitmask controlling which stencil value bits are written to when performing stencil comparison tests. Default to 0xFFFFFF.

OptionalsampleCount

sampleCount?: number

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

OptionalalphaToCoverageEnabled

alphaToCoverageEnabled?: boolean

When true indicates that a fragment's alpha channel should be used to generate a sample coverage mask. Default to false.

Optionalmask

mask?: number

Mask determining which samples are written to. Default to 0xFFFFFFFF.

OptionalcullMode

cullMode?: GPUCullMode

Cull mode to use with this RenderMaterial.

OptionalunclippedDepth

unclippedDepth?: boolean

If true, indicates that depth clipping is disabled. Requires the depth-clip-control feature to be enabled. Default to false.

Settings

Member Visibility

On This Page

Properties