Skip to content

BindGroup ​

Methods ​

extend ​

Method used to decorate a given object (publicAPI+model) with vtkWebGPUBindGroup characteristics.

ArgumentTypeRequiredDescription
publicAPIYesobject on which methods will be bounds (public)
modelYesobject on which data structure will be bounds (protected)
initialValuesIWebGPUBindGroupInitialValuesNo(default: {})

getBindGroup ​

Get the bind group, recreating it when the device or any bindable changed since the last call.

ArgumentTypeRequiredDescription
deviceYesThe device to create the bind group on.

getBindGroupLayout ​

Get the bind group layout of the current bindables from the device cache.

ArgumentTypeRequiredDescription
deviceYesThe device to create the layout on.

getBindGroupTime ​

Get the object whose modified time changes when the bind group is recreated.

getDevice ​

Get the device this bind group belongs to.

getLabel ​

Get the WGSL name of the bind group.

getShaderCode ​

Get the WGSL declarations of every bindable, using the group index this bind group has in the given pipeline.

ArgumentTypeRequiredDescription
pipelineYesThe vtkWebGPUPipeline the shader code is built for.

newInstance ​

Method used to create a new instance of vtkWebGPUBindGroup.

ArgumentTypeRequiredDescription
initialValuesIWebGPUBindGroupInitialValuesNofor pre-setting some of its content

releaseGraphicsResources ​

Drop the bind group so that it is recreated on the next getBindGroup.

setBindables ​

Set the objects bound by this group, in binding order. The object is only modified when the list actually changed.

ArgumentTypeRequiredDescription
bindablesYesThe objects to bind.

setDevice ​

Set the device this bind group belongs to.

setLabel ​

Set the WGSL name of the bind group.