Interface GPUDevice

Hierarchy

Properties

adapterInfo: GPUAdapterInfo

Information about the physical adapter which created the device that this GPUDevice refers to. For a given GPUDevice, the GPUAdapterInfo values exposed are constant over time.

A set containing the GPUFeatureName values of the features supported by the device (i.e. the ones with which it was created).

label: string

Exposes the limits supported by the device (which are exactly the ones with which it was created).

lost: Promise<GPUDeviceLostInfo>

A slot-backed attribute holding a promise which is created with the device, remains pending for the lifetime of the device, then resolves when the device is lost. Upon initialization, it is set to a new promise.

onuncapturederror: null | ((this: GPUDevice, ev: GPUUncapturedErrorEvent) => any)

An event handler IDL attribute for the GPUDevice#uncapturederror event type.

queue: GPUQueue

The primary GPUQueue for this device.

Methods

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Destroys the device, preventing further operations on it. Outstanding asynchronous operations will fail. Note: It is valid to destroy a device multiple times. Note: Since no further operations can be enqueued on this device, implementations can abort outstanding asynchronous operations immediately and free resource allocations, including mapped memory that was just unmapped.

    Returns undefined

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

  • Pops a GPU error scope off the GPUDevice#errorScopeStack for this and resolves to any GPUError observed by the error scope, or null if none. There is no guarantee of the ordering of promise resolution.

    Returns Promise<null | GPUError>

  • Pushes a new GPU error scope onto the GPUDevice#errorScopeStack for this.

    Parameters

    • filter: GPUErrorFilter

      Which class of errors this error scope observes.

    Returns undefined

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

Generated using TypeDoc