ImageBuffer
Image buffer
Helper class grabbing images into internal storage. Used by VideoSource to grab video streams and Engine to resize images for faster processing. Image can be accessed by canvas or read as pixels.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ImageBuffer(
name):ImageBuffer
Constructor
Parameters
Section titled “Parameters”string = "canvas"
Optional name of canvas
Returns
Section titled “Returns”ImageBuffer
Properties
Section titled “Properties”canvas
Section titled “canvas”canvas:
HTMLCanvasElement
Canvas to capture frames
protectedoptionalclip:ClipRect
Clipping region in normalized coordinates
clipPix?
Section titled “clipPix?”
protectedoptionalclipPix:ClipRect
Clipping region in pixels
context
Section titled “context”
protectedcontext:null|CanvasRenderingContext2D=null
Context to capture frames
size:
Size
Size of the frames
transpose
Section titled “transpose”
protectedtranspose:boolean=false
Transpose image
Methods
Section titled “Methods”capture()
Section titled “capture()”capture(
video):boolean
Grab frame
Grabs frame from video element or canvas into internal canvas. Automatically rescales an image if resolutions are different.
Parameters
Section titled “Parameters”Element to grab image from
ImageBitmap | HTMLCanvasElement | HTMLVideoElement
Returns
Section titled “Returns”boolean
True if image is grabbed, False otherwise
data()
Section titled “data()”data():
undefined|ImageData
Get image buffer
Returns data buffer of image currently grabbed into canvas.
Returns
Section titled “Returns”undefined | ImageData
Image data buffer on success, undefined otherwise
dispose()
Section titled “dispose()”dispose():
void
Dispose video context object
Returns
Section titled “Returns”void
fill()
Section titled “fill()”fill():
void
Fill canvas with color
Returns
Section titled “Returns”void
setClip()
Section titled “setClip()”setClip(
clip?):void
Set normalized clipping rectangle
Parameters
Section titled “Parameters”Clipping rectangle in [0..1] space
Returns
Section titled “Returns”void
setSize()
Section titled “setSize()”setSize(
size):void
Set input video size
Parameters
Section titled “Parameters”Video size
Returns
Section titled “Returns”void
setTranspose()
Section titled “setTranspose()”setTranspose(
transpose):void
Set image transposition
Parameters
Section titled “Parameters”transpose
Section titled “transpose”boolean
Transpose image flag
Returns
Section titled “Returns”void