Interface PlaneParams

Parameters used to create a Plane

interface PlaneParams {
    widthSegments?: number;
    heightSegments?: number;
    autoRender?: boolean;
    visible?: boolean;
    renderOrder?: number;
    outputTarget?: RenderTarget;
    texturesOptions?: ExternalTextureParams;
    targets?: Partial<GPUColorTargetState>[];
    renderBundle?: RenderBundle;
    autoloadSources?: boolean;
    watchScroll?: boolean;
    geometry?: PlaneGeometry;
    uniforms?: ReadOnlyInputBindings;
    storages?: ReadWriteInputBindings;
    bindings?: BindGroupBindingElement[];
    instancesCount?: number;
    vertexBuffers?: VertexBufferParams[];
    mapBuffersAtCreation?: boolean;
    label?: string;
    shaders?: MaterialShaders;
    useAsyncPipeline?: boolean;
    bindGroups?: BindGroup[];
    samplers?: Sampler[];
    textures?: Texture[];
    domTextures?: DOMTexture[];
    useProjection?: boolean;
    transparent?: boolean;
    depth?: boolean;
    depthWriteEnabled?: boolean;
    depthCompare?: GPUCompareFunction;
    depthFormat?: GPUTextureFormat;
    cullMode?: GPUCullMode;
    sampleCount?: number;
    verticesOrder?: GPUFrontFace;
    topology?: GPUPrimitiveTopology;
}

Hierarchy (view full)

Properties

widthSegments? heightSegments? autoRender? visible? renderOrder? outputTarget? texturesOptions? targets? renderBundle? autoloadSources? watchScroll? geometry? uniforms? storages? bindings? instancesCount? vertexBuffers? mapBuffersAtCreation? label? shaders? useAsyncPipeline? bindGroups? samplers? textures? domTextures? useProjection? transparent? depth? depthWriteEnabled? depthCompare? depthFormat? cullMode? sampleCount? verticesOrder? topology?

Properties

Optional widthSegments

widthSegments?: number

Number of segments along the X axis

Optional heightSegments

heightSegments?: number

Number of segments along the Y axis

Optional autoRender

autoRender?: boolean

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

Optional visible

visible?: boolean

Flag indicating whether to draw this Mesh or not.

Optional renderOrder

renderOrder?: number

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

Optional outputTarget

outputTarget?: RenderTarget

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

Optional texturesOptions

texturesOptions?: ExternalTextureParams

Parameters used by this Mesh to create a DOMTexture.

Optional targets

targets?: Partial<GPUColorTargetState>[]

Optional targets properties.

Optional renderBundle

renderBundle?: RenderBundle

Optional RenderBundle into which this Mesh should be added.

Optional autoloadSources

autoloadSources?: boolean

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

Optional watchScroll

watchScroll?: boolean

Whether to automatically update the DOMMesh position on scroll

Optional geometry

geometry?: PlaneGeometry

Optional PlaneGeometry to use

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 instancesCount

instancesCount?: number

Number of geometry instances to draw

Optional vertexBuffers

vertexBuffers?: VertexBufferParams[]

Array of VertexBufferParams used to create VertexBuffer on geometry creation

Optional mapBuffersAtCreation

mapBuffersAtCreation?: boolean

Whether to map the vertex buffers at creation.

Optional label

label?: string

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

Optional shaders

shaders?: MaterialShaders

Shaders to use with this Material

Optional useAsyncPipeline

useAsyncPipeline?: boolean

Whether to compile the Material GPUPipelineBase | pipeline asynchronously or not

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