Abstract Class: QuerySet

Defined in: modules/core/src/adapter/resources/query-set.ts:28

Immutable QuerySet object

Extends

• Resource<QuerySetProps>

Constructors

Constructor

new QuerySet(device, props): QuerySet

Defined in: modules/core/src/adapter/resources/query-set.ts:33

Parameters

device

Device

props

QuerySetProps

Returns

QuerySet

Overrides

Resource.constructor

Properties

destroyed

destroyed: boolean = false

Defined in: modules/core/src/adapter/resources/resource.ts:131

Whether this resource has been destroyed

Inherited from

Resource.destroyed

---

device

abstract readonly device: Device

Defined in: modules/core/src/adapter/resources/resource.ts:124

The device that this resource is associated with

Inherited from

Resource.device

---

handle

abstract readonly handle: 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

Resource.handle

---

id

id: string

Defined in: modules/core/src/adapter/resources/resource.ts:118

props.id, for debugging.

Inherited from

Resource.id

---

props

readonly props: Required<Props>

Defined in: modules/core/src/adapter/resources/resource.ts:120

The props that this resource was created with

Inherited from

Resource.props

---

userData

readonly userData: Record<string, unknown> = {}

Defined in: modules/core/src/adapter/resources/resource.ts:122

User data object, reserved for the application

Inherited from

Resource.userData

---

defaultProps

static defaultProps: Required<QuerySetProps>

Defined in: modules/core/src/adapter/resources/query-set.ts:37

Default properties for resource

Overrides

Resource.defaultProps

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: modules/core/src/adapter/resources/query-set.ts:29

Returns

string

Overrides

Resource.[toStringTag]

---

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

Resource.isHandleBorrowed

---

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

Resource.ownsHandle

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

Resource<ResourceProps>

Returns

void

Inherited from

Resource.attachResource

---

delete()

delete(): this

Defined in: modules/core/src/adapter/resources/resource.ts:181

Returns

this

Deprecated

Use destroy()

Inherited from

Resource.delete

---

destroy()

destroy(): void

Defined in: modules/core/src/adapter/resources/resource.ts:173

destroy can be called on any resource to release it before it is garbage collected.

Returns

void

Inherited from

Resource.destroy

---

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

Resource<ResourceProps>

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

Resource<ResourceProps>

Returns

void

Inherited from

Resource.detachResource

---

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

Resource.getProps

---

isResultAvailable()

abstract isResultAvailable(queryIndex?): boolean

Defined in: modules/core/src/adapter/resources/query-set.ts:47

Returns true if the requested result has been captured and can be read without blocking. Backends may implement this conservatively.

Parameters

queryIndex?

number

Returns

boolean

---

readResults()

abstract readResults(options?): Promise<bigint[]>

Defined in: modules/core/src/adapter/resources/query-set.ts:50

Reads query results as 64-bit values.

Parameters

options?

firstQuery?

number

queryCount?

number

Returns

Promise<bigint[]>

---

readTimestampDuration()

abstract readTimestampDuration(beginIndex, endIndex): Promise<number>

Defined in: modules/core/src/adapter/resources/query-set.ts:56

Reads a timestamp duration in milliseconds between a begin and end query index. Portable duration profiling requires adjacent indices that identify one logical pair.

Parameters

beginIndex

number

endIndex

number

Returns

Promise<number>

---

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

Resource.toJSON

---

toString()

toString(): string

Defined in: modules/core/src/adapter/resources/resource.ts:108

Returns

string

Inherited from

Resource.toString