GPUCanvasContext.idl   [plain text]

/*
 * Copyright (C) 2018 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
// https://gpuweb.github.io/gpuweb

typedef unsigned long GPUTextureUsageFlags;

[
    Conditional=WEBGPU,
    EnabledAtRuntime=WebGPU,
    ImplementedAs=WebGPUSwapChainDescriptor
] dictionary WebGPUSwapChainDescriptor {
    required WebGPUDevice device;
    required GPUTextureFormat format;
    GPUTextureUsageFlags usage; // FIXME: default is GPUTextureUsage.OUTPUT_ATTACHMENT.
};

[
    Conditional=WEBGPU,
    EnabledAtRuntime=WebGPU
] interface GPUCanvasContext {
    // back-reference to the canvas
    readonly attribute HTMLCanvasElement canvas;

    // Calling configureSwapChain a second time invalidates the previous one,
    // and all of the textures it’s produced.
    WebGPUSwapChain configureSwapChain(WebGPUSwapChainDescriptor descriptor);

    // Not implemented yet.
    // Promise<GPUTextureFormat> getSwapChainPreferredFormat(GPUDevice device);
};