Skip to content

Add more specific types for globalCompositeOperation #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 24, 2021
Merged

Add more specific types for globalCompositeOperation #1206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion baselines/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3245,7 +3245,7 @@ declare var CacheStorage: {

interface CanvasCompositing {
globalAlpha: number;
globalCompositeOperation: string;
globalCompositeOperation: GlobalCompositeOperation;
}

interface CanvasDrawImage {
Expand Down Expand Up @@ -17757,6 +17757,7 @@ type FontFaceSetLoadStatus = "loaded" | "loading";
type FullscreenNavigationUI = "auto" | "hide" | "show";
type GamepadHapticActuatorType = "vibration";
type GamepadMappingType = "" | "standard" | "xr-standard";
type GlobalCompositeOperation = "color" | "color-burn" | "color-dodge" | "copy" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "lighten" | "lighter" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "soft-light" | "source-atop" | "source-in" | "source-out" | "source-over" | "xor";
type HdrMetadataType = "smpteSt2086" | "smpteSt2094-10" | "smpteSt2094-40";
type IDBCursorDirection = "next" | "nextunique" | "prev" | "prevunique";
type IDBRequestReadyState = "done" | "pending";
Expand Down
31 changes: 31 additions & 0 deletions inputfiles/addedTypes.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,37 @@
"value": [
"inprogress"
]
},
"GlobalCompositeOperation": {
"name": "GlobalCompositeOperation",
"value": [
"source-over",
"source-in",
"source-out",
"source-atop",
"destination-over",
"destination-in",
"destination-out",
"destination-atop",
"lighter",
"copy",
"xor",
"multiply",
"screen",
"overlay",
"darken",
"lighten",
"color-dodge",
"color-burn",
"hard-light",
"soft-light",
"difference",
"exclusion",
"hue",
"saturation",
"color",
"luminosity"

This comment was marked as outdated.

Sign in to view

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry, the spec actually defines more items when including <blend-mode>. Checking implementations...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The spec is confusing for this property. The extra enum items come from <blend-mode> but that also includes normal which browsers don't seem to support and which MDN doesn't list. I didn't include normal even though the spec technically would, I think that's in line with TypeScript's philosophy? Either way, the supported value source-over is what most people would assume normal does.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gecko: https://searchfox.org/mozilla-central/rev/9a5f36b0ddb9cb8ae556fc5b45f8ccea0f0da6f8/dom/canvas/CanvasRenderingContext2D.cpp#4756-4782
WebKit: https://webkit-search.igalia.com/webkit/rev/13bfcede837af469200178969bd5c08bc0bc4518/Source/WebCore/platform/graphics/GraphicsTypes.cpp#38-74
Blink: https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/platform/graphics/graphics_types.cc;l=34-51;drc=de68be3f18ba99cc01d75903e167ca09bade253c

Seems all the values there are supported!

]
}
}
},
Expand Down
9 changes: 9 additions & 0 deletions inputfiles/overridingTypes.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,15 @@
}
}
},
"CanvasCompositing": {
"properties": {
"property": {
"globalCompositeOperation": {
"type": "GlobalCompositeOperation"
}
}
}
},
"Body": {
"properties": {
"property": {
Expand Down