foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-21 15:04:11 -05:00
Code Issues Packages 1 Wiki Activity

docs(ext/canvas): document public Canvas APIs (#24895)

Browse source
This commit is contained in:
Yoshiya Hinosawa 2024-08-06 07:45:16 +03:00 committed by GitHub
parent 30a97d1e51
commit 646de0f7e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 93 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
ext/canvas/lib.deno_canvas.d.ts vendored
View file

@ -5,37 +5,103 @@
/// <reference no-default-lib="true" />
/// <reference lib="esnext" />
/** @category Canvas */
/**
* Specifies whether the image should be decoded using color space conversion.
* Either none or default (default). The value default indicates that
* implementation-specific behavior is used.
*
* @category Canvas
*/
declare type ColorSpaceConversion = "default" | "none";
/** @category Canvas */
/**
* Specifies how the bitmap image should be oriented.
*
* @category Canvas
*/
declare type ImageOrientation = "flipY" | "from-image" | "none";
/** @category Canvas */
/**
* Specifies whether the bitmap's color channels should be premultiplied by
* the alpha channel.
*
* @category Canvas
*/
declare type PremultiplyAlpha = "default" | "none" | "premultiply";
/** @category Canvas */
/**
* Specifies the algorithm to be used for resizing the input to match the
* output dimensions. One of `pixelated`, `low` (default), `medium`, or `high`.
*
* @category Canvas
*/
declare type ResizeQuality = "high" | "low" | "medium" | "pixelated";
/** @category Canvas */
/**
* The `ImageBitmapSource` type represents an image data source that can be
* used to create an `ImageBitmap`.
*
* @category Canvas */
declare type ImageBitmapSource = Blob | ImageData;
/** @category Canvas */
/**
* The options of {@linkcode createImageBitmap}.
*
* @category Canvas */
declare interface ImageBitmapOptions {
/**
* Specifies whether the image should be decoded using color space
* conversion. Either none or default (default). The value default
* indicates that implementation-specific behavior is used.
*/
colorSpaceConversion?: ColorSpaceConversion;
/** Specifies how the bitmap image should be oriented. */
imageOrientation?: ImageOrientation;
/**
* Specifies whether the bitmap's color channels should be premultiplied
* by the alpha channel. One of none, premultiply, or default (default).
*/
premultiplyAlpha?: PremultiplyAlpha;
/** The output height. */
resizeHeight?: number;
/**
* Specifies the algorithm to be used for resizing the input to match the
* output dimensions. One of pixelated, low (default), medium, or high.
*/
resizeQuality?: ResizeQuality;
/** The output width. */
resizeWidth?: number;
}
/** @category Canvas */
/**
* Create a new {@linkcode ImageBitmap} object from a given source.
*
* @param image The image to create an {@linkcode ImageBitmap} from.
* @param options The options for creating the {@linkcode ImageBitmap}.
*
* @category Canvas
*/
declare function createImageBitmap(
image: ImageBitmapSource,
options?: ImageBitmapOptions,
): Promise<ImageBitmap>;
/** @category Canvas */
/**
* Create a new {@linkcode ImageBitmap} object from a given source, cropping
* to the specified rectangle.
*
* @param image The image to create an {@linkcode ImageBitmap} from.
* @param sx The x coordinate of the top-left corner of the sub-rectangle from
* which the {@linkcode ImageBitmap} will be cropped.
* @param sy The y coordinate of the top-left corner of the sub-rectangle from
* which the {@linkcode ImageBitmap} will be cropped.
* @param sw The width of the sub-rectangle from which the
* {@linkcode ImageBitmap} will be cropped.
* @param sh The height of the sub-rectangle from which the
* {@linkcode ImageBitmap} will be cropped.
* @param options The options for creating the {@linkcode ImageBitmap}.
*
* @category Canvas
*/
declare function createImageBitmap(
image: ImageBitmapSource,
sx: number,
@ -45,14 +111,31 @@ declare function createImageBitmap(
options?: ImageBitmapOptions,
): Promise<ImageBitmap>;
/** @category Canvas */
/**
* `ImageBitmap` interface represents a bitmap image which can be drawn to a canvas.
*
* @category Canvas
*/
declare interface ImageBitmap {
/**
* The height of the bitmap.
*/
readonly height: number;
/**
* The width of the bitmap.
*/
readonly width: number;
/**
* Releases imageBitmap's resources.
*/
close(): void;
}
/** @category Canvas */
/**
* `ImageBitmap` represents a bitmap image which can be drawn to a canvas.
*
* @category Canvas
*/
declare var ImageBitmap: {
prototype: ImageBitmap;
new (): ImageBitmap;