Source/WebCore/html/OffscreenCanvas.idl

/*
* Copyright (C) 2017-2023 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.
*/

typedef (
#if defined(ENABLE_WEBGL) && ENABLE_WEBGL
    WebGLRenderingContext or
    WebGL2RenderingContext or
#endif
    GPUCanvasContext or
    ImageBitmapRenderingContext or
    OffscreenCanvasRenderingContext2D) OffscreenRenderingContext;

// https://html.spec.whatwg.org/multipage/canvas.html#imageencodeoptions
dictionary ImageEncodeOptions {
   DOMString type = "image/png";
   unrestricted double quality = 1.0;
};

// https://html.spec.whatwg.org/multipage/canvas.html#offscreenrenderingcontextid
// FIXME: This should be named `OffscreenRenderingContextId`.
enum OffscreenRenderingContextType {
   "2d",
   "webgl",
   "webgl2",
   "bitmaprenderer",
   "webgpu"
};

// https://html.spec.whatwg.org/multipage/canvas.html#offscreencanvas
[
    ActiveDOMObject,
    GenerateIsReachable=Impl,
    EnabledBySetting=OffscreenCanvasEnabled,
    Conditional=OFFSCREEN_CANVAS,
    ConditionalForWorker=OFFSCREEN_CANVAS_IN_WORKERS,
    EnabledForContext,
    ReportExtraMemoryCost,
    ReportExternalMemoryCost,
    Exposed=(Window,Worker)
] interface OffscreenCanvas : EventTarget {
    [CallWith=CurrentScriptExecutionContext] constructor([EnforceRange] unsigned long width, [EnforceRange] unsigned long height);

    [CallTracer=InspectorCanvasCallTracer] attribute [EnforceRange] unsigned long width;
    [CallTracer=InspectorCanvasCallTracer] attribute [EnforceRange] unsigned long height;

    [CallWith=CurrentGlobalObject] OffscreenRenderingContext? getContext(OffscreenRenderingContextType contextType, any... arguments);
    // FIXME: `transferToImageBitmap` should not return a nullable type.
    ImageBitmap? transferToImageBitmap();
    Promise<Blob> convertToBlob(optional ImageEncodeOptions options = {});

    // FIXME: Add support for `oncontextlost`.
    // attribute EventHandler oncontextlost;
    // FIXME: Add support for `oncontextrestored`.
    // attribute EventHandler oncontextrestored;
};