Interface GPUDevice

    EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.

    MDN Reference

    interface GPUDevice {
        __brand: "GPUDevice";
        adapterInfo: GPUAdapterInfo;
        features: GPUSupportedFeatures;
        label: string;
        limits: GPUSupportedLimits;
        lost: Promise<GPUDeviceLostInfo>;
        onuncapturederror: (this: GPUDevice, ev: GPUUncapturedErrorEvent) => any;
        queue: GPUQueue;
        addEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        createBindGroup(descriptor: GPUBindGroupDescriptor): GPUBindGroup;
        createBindGroupLayout(
            descriptor: GPUBindGroupLayoutDescriptor,
        ): GPUBindGroupLayout;
        createBuffer(descriptor: GPUBufferDescriptor): GPUBuffer;
        createCommandEncoder(
            descriptor?: GPUObjectDescriptorBase,
        ): GPUCommandEncoder;
        createComputePipeline(
            descriptor: GPUComputePipelineDescriptor,
        ): GPUComputePipeline;
        createComputePipelineAsync(
            descriptor: GPUComputePipelineDescriptor,
        ): Promise<GPUComputePipeline>;
        createPipelineLayout(
            descriptor: GPUPipelineLayoutDescriptor,
        ): GPUPipelineLayout;
        createQuerySet(descriptor: GPUQuerySetDescriptor): GPUQuerySet;
        createRenderBundleEncoder(
            descriptor: GPURenderBundleEncoderDescriptor,
        ): GPURenderBundleEncoder;
        createRenderPipeline(
            descriptor: GPURenderPipelineDescriptor,
        ): GPURenderPipeline;
        createRenderPipelineAsync(
            descriptor: GPURenderPipelineDescriptor,
        ): Promise<GPURenderPipeline>;
        createSampler(descriptor?: GPUSamplerDescriptor): GPUSampler;
        createShaderModule(descriptor: GPUShaderModuleDescriptor): GPUShaderModule;
        createTexture(descriptor: GPUTextureDescriptor): GPUTexture;
        destroy(): undefined;
        dispatchEvent(event: Event): boolean;
        importExternalTexture(
            descriptor: GPUExternalTextureDescriptor,
        ): GPUExternalTexture;
        popErrorScope(): Promise<GPUError>;
        pushErrorScope(filter: GPUErrorFilter): undefined;
        removeEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
    }
    Hierarchy

    Properties

    __brand adapterInfo features label limits lost onuncapturederror queue

    Methods

    addEventListener createBindGroup createBindGroupLayout createBuffer createCommandEncoder createComputePipeline createComputePipelineAsync createPipelineLayout createQuerySet createRenderBundleEncoder createRenderPipeline createRenderPipelineAsync createSampler createShaderModule createTexture destroy dispatchEvent importExternalTexture popErrorScope pushErrorScope removeEventListener

    Properties

    Readonly Internal__brand

    __brand: "GPUDevice"

    Nominal type branding. https://github.com/microsoft/TypeScript/pull/33038

    ReadonlyadapterInfo

    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.

    Readonlyfeatures

    features: GPUSupportedFeatures

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

    label

    label: string

    Readonlylimits

    limits: GPUSupportedLimits

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

    Readonlylost

    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

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

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

    Readonlyqueue

    queue: GPUQueue

    The primary GPUQueue for this device.

    Methods

    addEventListener

    • addEventListener(
          type: string,
          callback: EventListenerOrEventListenerObject,
          options?: boolean | AddEventListenerOptions,
      ): void

    • 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.

      MDN Reference

      Parameters

      Returns void

    createBindGroup

    createBindGroupLayout

    createBuffer

    createCommandEncoder

    createComputePipeline

    createComputePipelineAsync

    createPipelineLayout

    createQuerySet

    createRenderBundleEncoder

    createRenderPipeline

    createRenderPipelineAsync

    createSampler

    createShaderModule

    createTexture

    destroy

    • destroy(): undefined

    • 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

    dispatchEvent

    • dispatchEvent(event: Event): boolean

    • 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.

      MDN Reference

      Parameters

      Returns boolean

    importExternalTexture

    popErrorScope

    • popErrorScope(): Promise<GPUError>

    • 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<GPUError>

    pushErrorScope

    • pushErrorScope(filter: GPUErrorFilter): undefined

    • 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

    removeEventListener

    Settings

    Member Visibility

    On This Page

    Properties
    Methods