poIPost CaptureImageByRegion

Renders a specific region of the current HyperView window to an off-screen image.

Syntax

poIPost_handle CaptureImageByRegionregionType filename quality

Application

HyperView Tcl Modify

Description

This command renders the current HyperView window, crops the rendering to the specified region, and then writes it to an off-screen image.

Inputs

regionType
The region of the window which will be saved. MODELSONLY specifies that the window will be cropped so that only the models will be visible.
filename
The name of the file.
quality
The image quality (1-4, with 1 as the default).

Example

To render the current HyperView window and specify that the window will be cropped so that only the models are visible:
set t [::post::GetT]
::post::GetPostHandle post$t
post$t CaptureImageByRegion MODELSONLY C:/image.jpg 4
post$t ReleaseHandle

Error

Returns 0 if successful, otherwise an error code.