Chartbreaker
    Preparing search index...

    Interface GPUBuffer

    The GPUBuffer interface of the WebGPU API represents a block of memory that can be used to store raw data to use in GPU operations. Available only in secure contexts.

    MDN Reference

    interface GPUBuffer {
        label: string;
        mapState: GPUBufferMapState;
        size: number;
        usage: number;
        destroy(): void;
        getMappedRange(offset?: number, size?: number): ArrayBuffer;
        mapAsync(mode: number, offset?: number, size?: number): Promise<void>;
        unmap(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    label mapState size usage

    Methods

    destroy getMappedRange mapAsync unmap

    Properties

    label: string

    MDN Reference

    mapState: GPUBufferMapState

    The mapState read-only property of the GPUBuffer interface represents the mapped state of the GPUBuffer.

    MDN Reference

    size: number

    The size read-only property of the GPUBuffer interface represents the length of the GPUBuffer's memory allocation, in bytes.

    MDN Reference

    usage: number

    The usage read-only property of the GPUBuffer interface contains the bitwise flags representing the allowed usages of the GPUBuffer.

    MDN Reference

    Methods

    • The destroy() method of the GPUBuffer interface destroys the GPUBuffer.

      MDN Reference

      Returns void

    • The getMappedRange() method of the GPUBuffer interface returns an ArrayBuffer containing the mapped contents of the GPUBuffer in the specified range.

      MDN Reference

      Parameters

      • Optionaloffset: number
      • Optionalsize: number

      Returns ArrayBuffer

    • The mapAsync() method of the GPUBuffer interface maps the specified range of the GPUBuffer. It returns a Promise that resolves when the GPUBuffer's content is ready to be accessed. While the GPUBuffer is mapped it cannot be used in any GPU commands.

      MDN Reference

      Parameters

      • mode: number
      • Optionaloffset: number
      • Optionalsize: number

      Returns Promise<void>

    • The unmap() method of the GPUBuffer interface unmaps the mapped range of the GPUBuffer, making its contents available for use by the GPU again after it has previously been mapped with GPUBuffer.mapAsync() (the GPU cannot access a mapped GPUBuffer).

      MDN Reference

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods