Class TextureBindGroup

Used to regroup all bindings related to textures (texture, texture matrices buffers and samplers) into one single specific BindGroup.

Also responsible for uploading video textures if needed.

Example

// set our main GPUCurtains instance
const gpuCurtains = new GPUCurtains({
  container: '#canvas' // selector of our WebGPU canvas container
})

// set the GPU device
// note this is asynchronous
await gpuCurtains.setDevice()

// create a texture
const texture = new Texture(gpuCurtains, {
  label: 'Input texture',
  name: 'inputTexture',
})

// create a texture bind group using that texture
const textureBindGroup = new TextureBindGroup(gpuCurtains, {
  label: 'My texture bind group',
  textures: [texture],
  uniforms: {
    params: {
      struct: {
        opacity: {
          type: 'f32',
          value: 1,
        },
        mousePosition: {
          type: 'vec2f',
          value: new Vec2(),
        },
      },
    },
  },
})

// create the GPU buffer, bindGroupLayout and bindGroup
textureBindGroup.createBindGroup()

Hierarchy (View Summary)

BindGroup
- TextureBindGroup

Constructors

constructor

new TextureBindGroup(
renderer: Renderer | GPUCurtains,
parameters?: TextureBindGroupParams,
): TextureBindGroup
TextureBindGroup constructor
Parameters
- renderer: Renderer | GPUCurtains
  a Renderer class object or a GPUCurtains class object.
- parameters: TextureBindGroupParams = {}
  parameters used to create our TextureBindGroup.
Returns TextureBindGroup
Overrides BindGroup.constructor
- Defined in src/core/bindGroups/TextureBindGroup.ts:83

Properties

type

type: string

The type of the BindGroup.

uuid

uuid: string

The universal unique id of the BindGroup.

renderer

renderer: Renderer

The Renderer used.

options

options: TextureBindGroupParams

Options used to create this BindGroup.

index

index: number

Index of this BindGroup, used to link struct in the shaders.

bindings

bindings: BindGroupBindingElement[]

List of bindings (buffers, texture, etc.) handled by this BindGroup.

layoutCacheKey

layoutCacheKey: string

A cache key allowing to get / set GPUBindGroupLayout from the device manager map cache.

pipelineCacheKey

pipelineCacheKey: string

A cache key allowing the PipelineManager to compare RenderPipelineEntry bind groups content.

needsPipelineFlush

needsPipelineFlush: boolean

Flag indicating whether we need to flush and recreate the pipeline using this BindGroup.

consumers

consumers: Set<string>

A Set to store this BindGroup consumers (Material uuid).

texturesMatricesBinding

texturesMatricesBinding: BufferBinding

A BufferBinding with all the MediaTexture modelMatrix if any.

Accessors

bufferBindings

get bufferBindings(): BindGroupBufferBindingElement[]
Get all bind group bindings that handle a GPUBuffer

Returns BindGroupBufferBindingElement[]
Inherited from BindGroup.bufferBindings
- Defined in src/core/bindGroups/BindGroup.ts:448

textures

get textures(): MaterialTexture[]
Get the current textures array.

Returns MaterialTexture[]
- Defined in src/core/bindGroups/TextureBindGroup.ts:167

samplers

get samplers(): Sampler[]
Get the current samplers array.

Returns Sampler[]
- Defined in src/core/bindGroups/TextureBindGroup.ts:184

shouldCreateBindGroup

get shouldCreateBindGroup(): boolean
Get whether the GPU bind group is ready to be created. It can be created if it has BindGroup#bindings and has not been created yet and all GPUTexture and GPUSampler are created.

Returns boolean
Overrides BindGroup.shouldCreateBindGroup
- Defined in src/core/bindGroups/TextureBindGroup.ts:193

Methods

setIndex

setIndex(index: number): void
Sets our bind group index.
Parameters
- index: number
  bind group index to set.
Returns void
Inherited from BindGroup.setIndex
- Defined in src/core/bindGroups/BindGroup.ts:176

addBindings

addBindings(bindings?: BindGroupBindingElement[]): void
Adds an array of already created bindings (buffers, texture, etc.) to the bindings array.
Parameters
- bindings: BindGroupBindingElement[] = []
  bindings to add.
Returns void
Inherited from BindGroup.addBindings
- Defined in src/core/bindGroups/BindGroup.ts:184

addBinding

addBinding(binding: BindGroupBindingElement): void
Adds an already created bindings (buffers, texture, etc.) to the bindings array.
Parameters
- binding: BindGroupBindingElement
  binding to add.
Returns void
Inherited from BindGroup.addBinding
- Defined in src/core/bindGroups/BindGroup.ts:204

destroyBufferBinding

destroyBufferBinding(binding: BindGroupBufferBindingElement): void
Destroy a BufferBinding buffers.
Parameters
- binding: BindGroupBufferBindingElement
  BufferBinding from which to destroy the buffers.
Returns void
Inherited from BindGroup.destroyBufferBinding
- Defined in src/core/bindGroups/BindGroup.ts:212

createInputBindings

createInputBindings(
bindingType?: BufferBindingType,
inputs?: ReadOnlyInputBindings,
): BindGroupBindingElement[]
Creates Bindings based on a list of inputs.
Parameters
- bindingType: BufferBindingType = 'uniform'
  binding type.
- inputs: ReadOnlyInputBindings = {}
  inputs (uniform or storage) that will be used to create the binding.
Returns BindGroupBindingElement[]
- A bindings array.
Inherited from BindGroup.createInputBindings
- Defined in src/core/bindGroups/BindGroup.ts:247

setInputBindings

setInputBindings(): void
Create and adds bindings based on inputs provided upon creation.

Returns void
Inherited from BindGroup.setInputBindings
- Defined in src/core/bindGroups/BindGroup.ts:318

resetEntries

resetEntries(): void
Reset our BindGroup entries.

Returns void
Inherited from BindGroup.resetEntries
- Defined in src/core/bindGroups/BindGroup.ts:337

resetBindGroup

resetBindGroup(): void
Reset the .bindGroup | bindGroup entries, recreates them and then recreate the GPU bind group.

Returns void
Inherited from BindGroup.resetBindGroup
- Defined in src/core/bindGroups/BindGroup.ts:356

addBindGroupEntry

addBindGroupEntry(binding: BindGroupBindingElement): void
Add a .bindGroup | bindGroup entry
Parameters
- binding: BindGroupBindingElement
  binding to add
Returns void
Inherited from BindGroup.addBindGroupEntry
- Defined in src/core/bindGroups/BindGroup.ts:371

resetBindGroupLayout

resetBindGroupLayout(): void
Reset the .bindGroupLayout | bindGroupLayout entries, recreates them and then recreate the GPU bind group layout

Returns void
Inherited from BindGroup.resetBindGroupLayout
- Defined in src/core/bindGroups/BindGroup.ts:383

addBindGroupLayoutEntry

addBindGroupLayoutEntry(binding: BindGroupBindingElement): void
Add a .bindGroupLayout | bindGroupLayout entry
Parameters
- binding: BindGroupBindingElement
  binding to add
Returns void
Inherited from BindGroup.addBindGroupLayoutEntry
- Defined in src/core/bindGroups/BindGroup.ts:398

loseContext

loseContext(): void
Called when the device has been lost to prepare everything for restoration

Returns void
Inherited from BindGroup.loseContext
- Defined in src/core/bindGroups/BindGroup.ts:411

restoreContext

restoreContext(): void
Called when the device has been restored to update our bindings.

Returns void
Inherited from BindGroup.restoreContext
- Defined in src/core/bindGroups/BindGroup.ts:434

createBindingBuffer

createBindingBuffer(
binding: BindGroupBufferBindingElement,
optionalLabel?: any,
): void
Creates binding GPUBuffer with correct params.
Parameters
- binding: BindGroupBufferBindingElement
  The binding element.
- optionalLabel: any = null
  Optional label to use for the GPUBuffer.
Returns void
Inherited from BindGroup.createBindingBuffer
- Defined in src/core/bindGroups/BindGroup.ts:459

fillEntries

fillEntries(): void
Fill in our entries bindGroupLayout and bindGroup arrays with the correct binding resources. For buffer struct, create a GPUBuffer first if needed

Returns void
Inherited from BindGroup.fillEntries
- Defined in src/core/bindGroups/BindGroup.ts:482

getBindingByName

getBindingByName(bindingName?: string): BindGroupBindingElement
Get a bind group binding by name/key
Parameters
- bindingName: string = ''
  the binding name or key
Returns BindGroupBindingElement
- the found binding, or null if not found
Inherited from BindGroup.getBindingByName
- Defined in src/core/bindGroups/BindGroup.ts:510

setBindGroupLayout

setBindGroupLayout(): void
Create a GPUBindGroupLayout and set our bindGroupLayout

Returns void
Inherited from BindGroup.setBindGroupLayout
- Defined in src/core/bindGroups/BindGroup.ts:517

setBindGroup

setBindGroup(): void
Create a GPUBindGroup and set our bindGroup

Returns void
Inherited from BindGroup.setBindGroup
- Defined in src/core/bindGroups/BindGroup.ts:535

updateBufferBindings

updateBufferBindings(): void
Check whether we should update (write) our GPUBuffer or not.

Returns void
Inherited from BindGroup.updateBufferBindings
- Defined in src/core/bindGroups/BindGroup.ts:546

clone

clone(
    parameters?: {
        bindings?: BindGroupBindingElement[];
        keepLayout?: boolean;
    },
): AllowedBindGroups
Clones a BindGroup from a list of bindings. Useful to create a new bind group with already created buffers, but swapped.
Parameters
- parameters: { bindings?: BindGroupBindingElement[]; keepLayout?: boolean } = {}
  parameters to use for cloning.
  - Optionalbindings?: BindGroupBindingElement[]
    our input bindings.
  - OptionalkeepLayout?: boolean
    whether we should keep original bindGroupLayout or not.
Returns AllowedBindGroups
- the cloned BindGroup.
Inherited from BindGroup.clone
- Defined in src/core/bindGroups/BindGroup.ts:613

setRenderer

setRenderer(renderer: Renderer | GPUCurtains): void
Set or reset this TextureBindGroup renderer, and update the samplers and textures renderer as well.
Parameters
- renderer: Renderer | GPUCurtains
  New Renderer or GPUCurtains instance to use.
Returns void
Overrides BindGroup.setRenderer
- Defined in src/core/bindGroups/TextureBindGroup.ts:123

addTexture

addTexture(texture: MaterialTexture): void
Adds a texture to the textures array and bindings.
Parameters
- texture: MaterialTexture
  texture to add.
Returns void
- Defined in src/core/bindGroups/TextureBindGroup.ts:158

addSampler

addSampler(sampler: Sampler): void
Adds a sampler to the samplers array and bindings.
Parameters
- sampler: Sampler
Returns void
- Defined in src/core/bindGroups/TextureBindGroup.ts:175

setTexturesMatricesBinding

setTexturesMatricesBinding(): void
Set the texturesMatricesBinding if needed.

Returns void
- Defined in src/core/bindGroups/TextureBindGroup.ts:205

createBindGroup

createBindGroup(): void
Create the texturesMatricesBinding and bindGroup.

Returns void
Overrides BindGroup.createBindGroup
- Defined in src/core/bindGroups/TextureBindGroup.ts:251

updateTextures

updateTextures(): void
Update the bind group textures:
- Check if they need to copy their source texture.
- Upload video texture if needed.
Returns void
- Defined in src/core/bindGroups/TextureBindGroup.ts:261

update

update(): void
Update the TextureBindGroup, which means update its textures, then update its buffer bindings and finally reset it if needed.

Returns void
Overrides BindGroup.update
- Defined in src/core/bindGroups/TextureBindGroup.ts:307

destroy

destroy(): void
Destroy our TextureBindGroup.

Returns void
Overrides BindGroup.destroy
- Defined in src/core/bindGroups/TextureBindGroup.ts:315

Class TextureBindGroup

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TextureBindGroup

Properties

type

uuid

renderer

options

index

bindings

entries

bindGroupLayout

bindGroup

layoutCacheKey

pipelineCacheKey

needsPipelineFlush

consumers

texturesMatricesBinding

Accessors

bufferBindings

Returns BindGroupBufferBindingElement[]

textures

Returns MaterialTexture[]

samplers

Returns Sampler[]

shouldCreateBindGroup

Returns boolean

Methods

setIndex

Parameters

Returns void

addBindings

Parameters

Returns void

addBinding

Parameters

Returns void

destroyBufferBinding

Parameters

Returns void

createInputBindings

Parameters

Returns BindGroupBindingElement[]

setInputBindings

Returns void

resetEntries

Returns void

resetBindGroup

Returns void

addBindGroupEntry

Parameters

Returns void

resetBindGroupLayout

Returns void

addBindGroupLayoutEntry

Parameters

Returns void

loseContext

Returns void

restoreContext

Returns void

createBindingBuffer

Parameters

Returns void

fillEntries

Returns void

getBindingByName

Parameters

Returns BindGroupBindingElement

setBindGroupLayout

Returns void

`Optional`bindings?: BindGroupBindingElement[]

`Optional`keepLayout?: boolean