Abstract Class: ComputePass
Defined in: modules/core/src/adapter/resources/compute-pass.ts:20
Base class for GPU (WebGPU/WebGL) Resources
Extends
Constructors
Constructor
new ComputePass(
device,props):ComputePass
Defined in: modules/core/src/adapter/resources/compute-pass.ts:21
Parameters
device
props
Returns
ComputePass
Overrides
Properties
destroyed
destroyed:
boolean=false
Defined in: modules/core/src/adapter/resources/resource.ts:131
Whether this resource has been destroyed
Inherited from
device
abstractreadonlydevice:Device
Defined in: modules/core/src/adapter/resources/resource.ts:124
The device that this resource is associated with
Inherited from
handle
abstractreadonlyhandle:unknown
Defined in: modules/core/src/adapter/resources/resource.ts:126
The handle for the underlying resource, e.g. WebGL object or WebGPU handle
Inherited from
id
id:
string
Defined in: modules/core/src/adapter/resources/resource.ts:118
props.id, for debugging.
Inherited from
props
readonlyprops:Required<Props>
Defined in: modules/core/src/adapter/resources/resource.ts:120
The props that this resource was created with
Inherited from
userData
readonlyuserData:Record<string,unknown> ={}
Defined in: modules/core/src/adapter/resources/resource.ts:122
User data object, reserved for the application
Inherited from
defaultProps
staticdefaultProps:Required<ComputePassProps>
Defined in: modules/core/src/adapter/resources/compute-pass.ts:56
Default properties for resource
Overrides
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: modules/core/src/adapter/resources/compute-pass.ts:63
Returns
string
Overrides
isHandleBorrowed
Get Signature
get isHandleBorrowed():
boolean
Defined in: modules/core/src/adapter/resources/resource.ts:147
Whether luma.gl may only reference the opaque externally owned resource handle.
Returns
boolean
Inherited from
ownsHandle
Get Signature
get ownsHandle():
boolean
Defined in: modules/core/src/adapter/resources/resource.ts:140
Whether luma.gl created and owns the underlying resource handle.
Returns
boolean
Inherited from
Methods
attachResource()
attachResource(
resource):void
Defined in: modules/core/src/adapter/resources/resource.ts:200
Attaches a resource. Attached resources are auto destroyed when this resource is destroyed Called automatically when sub resources are auto created but can be called by application
Parameters
resource
Returns
void
Inherited from
delete()
delete():
this
Defined in: modules/core/src/adapter/resources/resource.ts:181
Returns
this
Deprecated
Use destroy()
Inherited from
destroy()
abstractdestroy():void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:25
destroy can be called on any resource to release it before it is garbage collected.
Returns
void
Overrides
destroyAttachedResource()
destroyAttachedResource(
resource):void
Defined in: modules/core/src/adapter/resources/resource.ts:214
Destroys a resource (only if owned), and removes from the owned (auto-destroy) list for this resource.
Parameters
resource
Returns
void
Inherited from
Resource.destroyAttachedResource
destroyAttachedResources()
destroyAttachedResources():
void
Defined in: modules/core/src/adapter/resources/resource.ts:221
Destroy all owned resources. Make sure the resources are no longer needed before calling.
Returns
void
Inherited from
Resource.destroyAttachedResources
detachResource()
detachResource(
resource):void
Defined in: modules/core/src/adapter/resources/resource.ts:207
Detach an attached resource. The resource will no longer be auto-destroyed when this resource is destroyed.
Parameters
resource
Returns
void
Inherited from
dispatch()
abstractdispatch(x,y?,z?):void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:40
Dispatch work to be performed with the current ComputePipeline.
Parameters
x
number
X dimension of the grid of workgroups to dispatch.
y?
number
Y dimension of the grid of workgroups to dispatch.
z?
number
Z dimension of the grid of workgroups to dispatch.
Returns
void
dispatchIndirect()
abstractdispatchIndirect(indirectBuffer,indirectOffset?):void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:47
Dispatch work to be performed with the current ComputePipeline.
Parameters
indirectBuffer
buffer must be a tightly packed block of three 32-bit unsigned integer values (12 bytes total), given in the same order as the arguments for dispatch()
indirectOffset?
number
Returns
void
end()
abstractend():void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:27
Returns
void
getProps()
getProps():
object
Defined in: modules/core/src/adapter/resources/resource.ts:190
Combines a map of user props and default props, only including props from defaultProps
Returns
object
returns a map of overridden default props
Inherited from
insertDebugMarker()
abstractinsertDebugMarker(markerLabel):void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:54
Marks a point in a stream of commands with a label
Parameters
markerLabel
string
Returns
void
popDebugGroup()
abstractpopDebugGroup():void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:52
Ends the labeled debug group most recently started by pushDebugGroup()
Returns
void
pushDebugGroup()
abstractpushDebugGroup(groupLabel):void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:50
Begins a labeled debug group containing subsequent commands
Parameters
groupLabel
string
Returns
void
setPipeline()
abstractsetPipeline(pipeline):void
Defined in: modules/core/src/adapter/resources/compute-pass.ts:29
Parameters
pipeline
Returns
void
toJSON()
toJSON():
string
Defined in: modules/core/src/adapter/resources/resource.ts:113
Compact serialization for assertion diffs and structured debug logs.
Returns
string
Inherited from
toString()
toString():
string
Defined in: modules/core/src/adapter/resources/resource.ts:108
Returns
string