ensightservice::AnimSaveRequest Struct Reference
Last update: 17.04.2023Public Attributes | |
| string | id = 1 |
| Handle used to query progress or cancel a save. Any unique string, provided by the caller. | |
| string | 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. | |
| map< string, string > | format_options = 3 |
| Options specific to certain formats, as (option_name, value) pairs. | |
| uint32 | width = 4 |
| Image width. 0 means current window width. | |
| uint32 | height = 5 |
| Image height. 0 means current window height. | |
| uint32 | aa_passes = 6 |
| Num anti-aliasing passes. 0 uses EnSight default 4-pass antialiasing. | |
| bool | 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. | |
| int32 | start_frame = 8 |
| First frame to save. 0-based. -1 special value that means the current timestep. | |
| int32 | num_frames = 9 |
| Num frames to save. -1 special value that means all timesteps. num_frames > num timesteps allows multiple cycles through time. | |
| float | fps = 10 |
| Frames/sec. Ignored if saving an image. | |
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.
The documentation for this struct was generated from the following file:
- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc_interface/ensight.proto