Interface GPUImageCopyExternalImage
interface GPUImageCopyExternalImage {
flipY?: boolean;
origin?: GPUOrigin2DStrict;
source: GPUImageCopyExternalImageSource;
}
flipY?: boolean;
origin?: GPUOrigin2DStrict;
source: GPUImageCopyExternalImageSource;
}
Properties
OptionalflipY
flipY?: boolean
Optionalorigin
Defines the origin of the copy - the minimum (top-left) corner of the source sub-region to copy from.
Together with copySize, defines the full copy sub-region.
source
The source of the image copy. The copy source data is captured at the moment that GPUQueue#copyExternalImageToTexture is issued. Source size is defined by source type, given by this table:
| Source type | Dimensions |
|---|---|
| ImageBitmap | ImageBitmap.width, ImageBitmap.height |
| HTMLImageElement | HTMLImageElement.naturalWidth, HTMLImageElement.naturalHeight |
| HTMLVideoElement | video/intrinsic width|intrinsic width of the frame, video/intrinsic height|intrinsic height of the frame |
| VideoFrame | VideoFrame.codedWidth, VideoFrame.codedHeight |
| ImageData | ImageData.width, ImageData.height |
| HTMLCanvasElement or OffscreenCanvas with CanvasRenderingContext2D or GPUCanvasContext | HTMLCanvasElement.width, HTMLCanvasElement.height |
| HTMLCanvasElement or OffscreenCanvas with WebGLRenderingContextBase | WebGLRenderingContextBase.drawingBufferWidth, WebGLRenderingContextBase.drawingBufferHeight |
| HTMLCanvasElement or OffscreenCanvas with ImageBitmapRenderingContext | ImageBitmapRenderingContext's internal output bitmap ImageBitmap.width, ImageBitmap.height |
Describes whether the source image is vertically flipped, or not. If this option is set to
true, the copy is flipped vertically: the bottom row of the source region is copied into the first row of the destination region, and so on. The GPUImageCopyExternalImage#origin option is still relative to the top-left corner of the source image, increasing downward.