ImageFormatSettings(bpy_struct)

base class — bpy_struct

class bpy.types.ImageFormatSettings.ImageFormatSettings(bpy_struct)

Settings for image formats

cineon_black

Log conversion reference blackpoint

Type

int in [0, 1024], default 0

cineon_gamma

Log conversion gamma

Type

float in [0, 10], default 0.0

cineon_white

Log conversion reference whitepoint

Type

int in [0, 1024], default 0

color_depth

Bit depth per channel

  • 8 8, 8 bit color channels.

  • 10 10, 10 bit color channels.

  • 12 12, 12 bit color channels.

  • 16 16, 16 bit color channels.

  • 32 32, 32 bit color channels.

Type

enum in [‘8’, ‘10’, ‘12’, ‘16’, ‘32’], default ‘8’

color_mode

Choose BW for saving grayscale images, RGB for saving red, green and blue channels, and RGBA for saving red, green, blue and alpha channels

  • BW BW, Images get saved in 8 bits grayscale (only PNG, JPEG, TGA, TIF).

  • RGB RGB, Images are saved with RGB (color) data.

  • RGBA RGBA, Images are saved with RGB and Alpha data (if supported).

Type

enum in [‘BW’, ‘RGB’, ‘RGBA’], default ‘BW’

compression

Amount of time to determine best compression: 0 = no compression with fast file output, 100 = maximum lossless compression with slow file output

Type

int in [0, 100], default 15

display_settings

Settings of device saved image would be displayed on

Type

ColorManagedDisplaySettings, (readonly)

exr_codec

Codec settings for OpenEXR

Type

enum in [‘NONE’, ‘PXR24’, ‘ZIP’, ‘PIZ’, ‘RLE’, ‘ZIPS’, ‘B44’, ‘B44A’, ‘DWAA’], default ‘NONE’

file_format

File format to save the rendered images as

  • BMP BMP, Output image in bitmap format.

  • IRIS Iris, Output image in (old!) SGI IRIS format.

  • PNG PNG, Output image in PNG format.

  • JPEG JPEG, Output image in JPEG format.

  • JPEG2000 JPEG 2000, Output image in JPEG 2000 format.

  • TARGA Targa, Output image in Targa format.

  • TARGA_RAW Targa Raw, Output image in uncompressed Targa format.

  • CINEON Cineon, Output image in Cineon format.

  • DPX DPX, Output image in DPX format.

  • OPEN_EXR_MULTILAYER OpenEXR MultiLayer, Output image in multilayer OpenEXR format.

  • OPEN_EXR OpenEXR, Output image in OpenEXR format.

  • HDR Radiance HDR, Output image in Radiance HDR format.

  • TIFF TIFF, Output image in TIFF format.

  • AVI_JPEG AVI JPEG, Output video in AVI JPEG format.

  • AVI_RAW AVI Raw, Output video in AVI Raw format.

  • FFMPEG FFmpeg video, The most versatile way to output video files.

Type

enum in [‘BMP’, ‘IRIS’, ‘PNG’, ‘JPEG’, ‘JPEG2000’, ‘TARGA’, ‘TARGA_RAW’, ‘CINEON’, ‘DPX’, ‘OPEN_EXR_MULTILAYER’, ‘OPEN_EXR’, ‘HDR’, ‘TIFF’, ‘AVI_JPEG’, ‘AVI_RAW’, ‘FFMPEG’], default ‘PNG’

jpeg2k_codec

Codec settings for Jpeg2000

Type

enum in [‘JP2’, ‘J2K’], default ‘JP2’

quality

Quality for image formats that support lossy compression

Type

int in [0, 100], default 90

stereo_3d_format

Settings for stereo 3d

Type

Stereo3dFormat, (readonly, never None)

tiff_codec

Compression mode for TIFF

Type

enum in [‘NONE’, ‘DEFLATE’, ‘LZW’, ‘PACKBITS’], default ‘DEFLATE’

use_cineon_log

Convert to logarithmic color space

Type

boolean, default False

use_jpeg2k_cinema_48

Use Openjpeg Cinema Preset (48fps)

Type

boolean, default False

use_jpeg2k_cinema_preset

Use Openjpeg Cinema Preset

Type

boolean, default False

use_jpeg2k_ycc

Save luminance-chrominance-chrominance channels instead of RGB colors

Type

boolean, default False

use_preview

When rendering animations, save JPG preview images in same directory

Type

boolean, default False

use_zbuffer

Save the z-depth per pixel (32 bit unsigned int z-buffer)

Type

boolean, default False

view_settings

Color management settings applied on image before saving

Type

ColorManagedViewSettings, (readonly)

views_format

Format of multiview media

  • INDIVIDUAL Individual, Individual files for each view with the prefix as defined by the scene views.

  • STEREO_3D Stereo 3D, Single file with an encoded stereo pair.

Type

enum in [‘INDIVIDUAL’, ‘STEREO_3D’], default ‘INDIVIDUAL’

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • CompositorNodeOutputFile.format

  • NodeOutputFileSlotFile.format

  • BakeSettings.image_settings

  • RenderSettings.image_settings

  • UILayout.template_image_settings

  • UILayout.template_image_views