Class: BodyPatchHDPlugin
@geenee/bodyrenderers-common.BodyPatchHDPlugin
Hight resolution body patch plugin
Advanced version of BodyPatchPlugin that uses high resolution segmentation mask evaluated by BodyMaskHDPlugin. High resolution segmentation significantly increases accuracy of patching and reduces patch region. BodyMaskHDPlugin must be added to ShaderRenderer pipeline.
Hierarchy
-
↳
BodyPatchHDPlugin
Constructors
constructor
• new BodyPatchHDPlugin(dilationR?)
Constructor
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
dilationR | number | 2 | Radius of mask dilation |
Inherited from
Properties
dilationR
• Protected dilationR: number = 2
Radius of mask dilation
Inherited from
dilationShader
• Protected Optional dilationShader: DilationShader
Image dilation shader
Inherited from
BodyPatchPlugin.dilationShader
fragSrc
• Protected Optional fragSrc: string
Code of fragment shader (copy shader by default)
Inherited from
inputs
• Protected Optional inputs: string[]
Shader texture inputs (names of sampler uniforms)
Inherited from
loaded
• loaded: boolean
Loaded state
Inherited from
ordinal
• ordinal: number
Ordinal number
Inherited from
renderer
• Protected Optional renderer: Renderer<PoseResult>
Renderer loaded the plugin
Inherited from
shader
• Protected Optional shader: ShaderProgram
Rendering shader
Inherited from
size
• Protected size: Size
Image size
Inherited from
uniforms
• Protected Optional uniforms: Object
Shader uniforms as name-type map object
Index signature
▪ [key: string]: UniformType
Inherited from
vertSrc
• Protected Optional vertSrc: string
Vertex shader source (copy shader by default)
Inherited from
Methods
dispose
▸ dispose(): void
Dispose video plugin
Returns
void
Inherited from
load
▸ load(renderer): Promise<void>
Initialize plugin
Initializes resources required for HD body patching.
Parameters
| Name | Type | Description |
|---|---|---|
renderer | Renderer<PoseResult> | Renderer this plugin is attached to |
Returns
Promise<void>
Promise resolving when initialization is finished
Overrides
process
▸ process(result, input): Promise<boolean>
Process the image
Patches (inpaints) foreground pixels according to evaluated high resolution segmentation mask.
Parameters
| Name | Type | Description |
|---|---|---|
result | PoseResult | Results of video processing |
input | WebGLTexture | Current image texture |
Returns
Promise<boolean>
True on success, false otherwise
Overrides
setupCamera
▸ setupCamera(ratio, angle): void
Set camera parameters
Could be overridden to adjust plugin's pipeline.
Parameters
| Name | Type | Description |
|---|---|---|
ratio | number | Aspect ration of input video |
angle | number | Vertical field of view in radians |
Returns
void
Inherited from
setupVideo
▸ setupVideo(size): void
Set video size
Adjusts shader and texture to a new size.
Parameters
| Name | Type | Description |
|---|---|---|
size | Size | Resolution of input video |
Returns
void
Inherited from
unload
▸ unload(): void
Reset plugin
Releases all resources and instances created in load().
Returns
void
Inherited from
update
▸ update(result, stream): Promise<void>
Update the image
Main method implementing webgl shader effect or filter. ShaderRenderer has current image texture that will be rendered. ShaderPlugin uses current texture as input and writes results to ShaderPlugin#output. ShaderPlugin#output becomes new current texture of ShaderRenderer. This way all ShaderPlugins attached to renderer organize a chain of effects applied on top of each other. Method process() implements shader effect itself, it's intended to be overridden by effect authors.
Parameters
| Name | Type | Description |
|---|---|---|
result | PoseResult | Results of video processing |
stream | HTMLCanvasElement | Captured video frame |
Returns
Promise<void>
Promise resolving when update is finished