ensightservice::AnimSaveRequest Struct Reference
Last update: 16.07.2025Public Attributes | |
| string | id = 1 |
| string | filename = 2 |
| map< string, string > | format_options = 3 |
| uint32 | width = 4 |
| uint32 | height = 5 |
| uint32 | aa_passes = 6 |
| bool | white_background = 7 |
| int32 | start_frame = 8 |
| int32 | num_frames = 9 |
| float | fps = 10 |
Detailed Description
Request that an image or animation be saved. If saving an animation, and format is an image format like png, save multiple images and insert an index like "_0003" into the file name before the extension. If saving one frame in an animation format, a one-frame movie will be written. Valid anim formats: .mp4, .avi, .mov Valid image formats: .png, .tif/.tiff, .jpg/.jpeg, .ppm
Format Option name Value Notes mp4: Quality Best|High|Medium|Low default: High Type 0|1 default: 1 1 for H.264, 0 for non-H.264 avi: Compression MJPEG|RAW|MPEG4V2 default: MPEG4V2 BitRate (a value between 0 and 80000) default: 20000 kbits/sec mov: BitRate (a value between 0 and 80000) default: 20000 kbits/sec png: Compression None|Fast|Best|Default default: Default (zlib compression setting) tif: Compression None|PackBits|Deflate default: PackBits jpg: Quality (a value between 0 and 100) default: 75 ppm: Format Binary|Ascii default: Binary
Definition at line 257 of file ensight.proto.
Member Data Documentation
◆ aa_passes
| uint32 ensightservice::AnimSaveRequest::aa_passes = 6 |
Num anti-aliasing passes. 0 uses EnSight default 4-pass antialiasing.
Definition at line 263 of file ensight.proto.
◆ filename
| string ensightservice::AnimSaveRequest::filename = 2 |
Name of file to save. Format determined from file extension. Defaults to .mp4 or .png with no file extension. UTF8 encoding. Existing files are overwritten.
Definition at line 259 of file ensight.proto.
◆ format_options
| map<string, string> ensightservice::AnimSaveRequest::format_options = 3 |
Options specific to certain formats, as (option_name, value) pairs.
Definition at line 260 of file ensight.proto.
◆ fps
| float ensightservice::AnimSaveRequest::fps = 10 |
Frames/sec. Ignored if saving an image.
Definition at line 267 of file ensight.proto.
◆ height
| uint32 ensightservice::AnimSaveRequest::height = 5 |
Image height. 0 means current window height.
Definition at line 262 of file ensight.proto.
◆ id
| string ensightservice::AnimSaveRequest::id = 1 |
Handle used to query progress or cancel a save. Any unique string, provided by the caller.
Definition at line 258 of file ensight.proto.
◆ num_frames
| int32 ensightservice::AnimSaveRequest::num_frames = 9 |
Num frames to save. -1 special value that means all timesteps. num_frames > num timesteps allows multiple cycles through time.
Definition at line 266 of file ensight.proto.
◆ start_frame
| int32 ensightservice::AnimSaveRequest::start_frame = 8 |
First frame to save. 0-based. -1 special value that means the current timestep.
Definition at line 265 of file ensight.proto.
◆ white_background
| bool ensightservice::AnimSaveRequest::white_background = 7 |
If True, set background to white, and change text and misc colors to black as necessary. Restore all, after save. If False, leave all colors as they are.
Definition at line 264 of file ensight.proto.
◆ width
| uint32 ensightservice::AnimSaveRequest::width = 4 |
Image width. 0 means current window width.
Definition at line 261 of file ensight.proto.
The documentation for this struct was generated from the following file:
- D:/Product-src/ensight/client/rpc_interface/ensight.proto
