aboutsummaryrefslogtreecommitdiffstats
path: root/components/script/dom/webidls/HTMLCanvasElement.webidl
blob: 2e7be0389beacb156f40c350832f63753aa77d07 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

// https://html.spec.whatwg.org/multipage/#htmlcanvaselement
typedef (CanvasRenderingContext2D
  or WebGLRenderingContext
  or WebGL2RenderingContext
  or GPUCanvasContext) RenderingContext;

[Exposed=Window]
interface HTMLCanvasElement : HTMLElement {
  [HTMLConstructor] constructor();

  [CEReactions, Pure, SetterThrows] attribute unsigned long width;
  [CEReactions, Pure, SetterThrows] attribute unsigned long height;

  [Throws]
  RenderingContext? getContext(DOMString contextId, optional any options = null);

  [Throws]
  USVString toDataURL(optional DOMString type = "image/png", optional any quality);

  [Throws]
  undefined toBlob(BlobCallback callback, optional DOMString type = "image/png", optional any quality);

  [Throws]
  OffscreenCanvas transferControlToOffscreen();
};

partial interface HTMLCanvasElement {
    [Pref="dom_canvas_capture_enabled"]
    MediaStream captureStream (optional double frameRequestRate);
};

callback BlobCallback = undefined(Blob? blob);