MaskUploadPlugin
Segmentation mask upload plugin
Uploads segmentation mask to an image texture that can
be reused by plugins next in the rendering pipeline.
Uploading texture ones and reusing it speeds up rendering.
Most plugins that post-process or utilize mask depend on
MaskUploadPlugin and require it to be attached to renderer.
Mask texture will be loaded and added to the corresponding
Pose,
Face, or
Mask of the tracking
results as maskTex field of BodyMaskTexture type.
Evaluation of body segmentation mask must be enabled in
@geenee/bodyprocessors!PoseProcessor#init setting
@geenee/bodyprocessors!PoseParams#mask to true or
@geenee/bodyprocessors!FaceProcessor#init setting
@geenee/bodyprocessors!FaceParams#mask to true.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MaskUploadPlugin(
size):MaskUploadPlugin
Constructor
Parameters
Section titled “Parameters”Size = ...
Size of segmentation mask
Returns
Section titled “Returns”MaskUploadPlugin
Overrides
Section titled “Overrides”Properties
Section titled “Properties”loaded
Section titled “loaded”loaded:
boolean
Loaded state
Inherited from
Section titled “Inherited from”ordinal
Section titled “ordinal”ordinal:
number
Ordinal number
Inherited from
Section titled “Inherited from”renderer?
Section titled “renderer?”
protectedoptionalrenderer:Renderer<SegmentationResult>
Renderer loaded the plugin
Inherited from
Section titled “Inherited from”
protectedsize:Size
Size of segmentation mask
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Dispose video plugin
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”load()
Section titled “load()”load(
renderer):Promise<void>
Initialize plugin
Initializes texture to upload segmentation mask.
Parameters
Section titled “Parameters”renderer
Section titled “renderer”Renderer this plugin is attached to
Returns
Section titled “Returns”Promise<void>
Promise resolving when initialization is finished
Overrides
Section titled “Overrides”setupCamera()
Section titled “setupCamera()”setupCamera(
ratio,angle):void
Set camera parameters
Could be overridden to adjust plugin’s pipeline.
Parameters
Section titled “Parameters”number
Aspect ration of input video
number
Vertical field of view in radians
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setupVideo()
Section titled “setupVideo()”setupVideo(
size):void
Set video size
Could be overridden to adjust plugin’s pipeline.
Parameters
Section titled “Parameters”Resolution of input video
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unload()
Section titled “unload()”unload():
void
Reset plugin
Releases all resources and instances created in load().
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”update()
Section titled “update()”update(
result,stream):Promise<void>
Upload segmentation masks
Uploads segmentation mask to texture and adds corresponding field to results of tracking to be used by plugins next in the pipeline.
Parameters
Section titled “Parameters”result
Section titled “result”Results of video processing
stream
Section titled “stream”HTMLCanvasElement
Captured video frame
Returns
Section titled “Returns”Promise<void>