image_format#

file.image_format(p0: str) → int#

Specifies the file format to be used when an image is created.

If the image is saved to a disk file the filename is concatenated with an extension as follows:
bmp - .bmp                                                    gif - .gif
jpeg -.jpg                                                    mov - .mov
tiff -.tif                                                    envideo -.evo
png - .png                                                    mpeg -.mpg
postscript -.ps                                                       avi - .avi
encapsulated ps -.eps                                                 POVRAY -.pov & .inc  (requires gold license)
sgi -.rgb                                                     

Args:

p0:

‘image_format’

The image format which must be one of:
bmp
jpeg
tiff
png
postscript
sgi
evo
evo
mpeg
gif
mov
avi
POVRAY

Examples:

ensight.file.image_format("jpeg")
ensight.file.image_file("/tmp/test_image")
ensight.file.save_image()

Returns:

zero on success, non-zero on error