Blender: ImageFormatData Struct Reference

Blender V5.0

#include <DNA_scene_types.h>

Public Attributes
char	media_type
char	imtype
char	depth
char	planes
char	flag
char	quality
char	compress
char	exr_codec
char	exr_flag
char	jp2_flag
char	jp2_codec
char	tiff_codec
char	cineon_flag
char	_pad [3]
short	cineon_white
short	cineon_black
float	cineon_gamma
Stereo3dFormat	stereo3d_format
char	views_format
char	color_management
char	_pad1 [6]
ColorManagedViewSettings	view_settings
ColorManagedDisplaySettings	display_settings
ColorManagedColorspaceSettings	linear_colorspace_settings

Detailed Description

Generic image format settings, this is used for NodeImageFile and IMAGE_OT_save_as operator too.

NOTE: its a bit strange that even though this is an image format struct the imtype can still be used to select video formats. RNA ensures these enum's are only selectable for render output.

Definition at line 457 of file DNA_scene_types.h.

Member Data Documentation

◆ _pad

char ImageFormatData::_pad[3]

Definition at line 495 of file DNA_scene_types.h.

◆ _pad1

char ImageFormatData::_pad1[6]

Definition at line 506 of file DNA_scene_types.h.

◆ cineon_black

short ImageFormatData::cineon_black

Definition at line 496 of file DNA_scene_types.h.

◆ cineon_flag

char ImageFormatData::cineon_flag

CINEON.

Definition at line 494 of file DNA_scene_types.h.

Referenced by BKE_image_format_to_imbuf(), and do_versions_image_settings_2_60().

◆ cineon_gamma

float ImageFormatData::cineon_gamma

Definition at line 497 of file DNA_scene_types.h.

◆ cineon_white

short ImageFormatData::cineon_white

Definition at line 496 of file DNA_scene_types.h.

◆ color_management

char ImageFormatData::color_management

Definition at line 505 of file DNA_scene_types.h.

Referenced by BKE_image_format_init_for_write(), BKE_image_save_options_init(), and uiTemplateImageSettings().

◆ compress

char ImageFormatData::compress

(0 - 100), eg: PNG compression.

Definition at line 478 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_to_imbuf(), and do_versions_image_settings_2_60().

◆ depth

char ImageFormatData::depth

bits per channel, R_IMF_CHAN_DEPTH_8 -> 32, not a flag, only set 1 at a time.

Definition at line 468 of file DNA_scene_types.h.

Referenced by add_exr_compositing_result(), BKE_image_format_from_imbuf(), BKE_image_format_is_byte(), BKE_image_format_set(), BKE_image_format_to_imbuf(), BKE_image_render_write(), BKE_image_render_write_exr(), do_versions_image_settings_2_60(), image_clipboard_copy_exec(), IMB_stereo3d_ImBuf(), RE_render_result_rect_to_ibuf(), screen_opengl_render_init(), seq_result_needs_float(), and blender::ed::object::write_external_bake_pixels().

◆ display_settings

ColorManagedDisplaySettings ImageFormatData::display_settings

Definition at line 508 of file DNA_scene_types.h.

Referenced by BKE_image_format_color_management_copy(), BKE_image_format_color_management_copy_from_scene(), BKE_image_format_copy(), BKE_image_format_init(), BKE_image_format_init_for_write(), image_save_post(), and IMB_colormanagement_imbuf_for_write().

◆ exr_codec

char ImageFormatData::exr_codec

OpenEXR: R_IMF_EXR_CODEC_* values in low OPENEXR_CODEC_MASK bits.

Definition at line 483 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_to_imbuf(), BKE_image_render_write_exr(), do_versions_image_settings_2_60(), and uiTemplateImageSettings().

◆ exr_flag

char ImageFormatData::exr_flag

Definition at line 484 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_to_imbuf(), BKE_image_render_write_exr(), and blo_update_defaults_scene().

◆ flag

char ImageFormatData::flag

Generic options for all image types, alpha Z-buffer.

Definition at line 473 of file DNA_scene_types.h.

Referenced by BKE_image_render_write(), and do_versions_image_settings_2_60().

◆ imtype

char ImageFormatData::imtype

R_IMF_IMTYPE_PNG, R_...

Note: Video types should only ever be set from this structure when used from RenderData.

Definition at line 464 of file DNA_scene_types.h.

Referenced by add_exr_compositing_result(), BKE_image_buffer_format_writable(), BKE_image_format_from_imbuf(), BKE_image_format_is_byte(), BKE_image_format_set(), BKE_image_format_to_imbuf(), BKE_image_path_ext_from_imformat(), BKE_image_path_ext_from_imformat_ensure(), BKE_image_path_from_imformat(), BKE_image_render_write(), BKE_image_render_write_exr(), BKE_image_save_options_init(), BKE_image_save_options_update(), BKE_scene_multiview_num_videos_get(), blo_do_versions_430(), do_versions_image_settings_2_60(), do_versions_nodetree_multi_file_output_format_2_62_1(), do_write_image_or_movie(), image_save_post(), image_save_single(), image_settings_avi_to_ffmpeg(), IMB_colormanagement_imbuf_for_write(), MOV_filepath_from_settings(), MOV_validate_output_settings(), MOV_write_begin(), blender::nodes::node_composite_file_output_cc::node_declare(), RE_InitState(), RE_render_result_rect_to_ibuf(), RE_RenderAnim(), RE_RenderFrame(), screen_opengl_render_anim_init(), screen_opengl_render_anim_step(), screen_opengl_render_end(), screen_opengl_render_init(), screen_render_exec(), screen_render_invoke(), screenshot_exec(), uiTemplateImageFormatViews(), uiTemplateImageSettings(), and write_result().

◆ jp2_codec

char ImageFormatData::jp2_codec

Definition at line 488 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_to_imbuf(), and image_path_ext_from_imformat_impl().

◆ jp2_flag

char ImageFormatData::jp2_flag

Jpeg2000.

Definition at line 487 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_to_imbuf(), and do_versions_image_settings_2_60().

◆ linear_colorspace_settings

ColorManagedColorspaceSettings ImageFormatData::linear_colorspace_settings

Definition at line 509 of file DNA_scene_types.h.

Referenced by BKE_image_format_color_management_copy(), BKE_image_format_color_management_copy_from_scene(), BKE_image_format_copy(), BKE_image_format_init(), BKE_image_format_init_for_write(), BKE_image_render_write(), BKE_image_save_options_init(), BKE_image_save_options_update(), blo_do_versions_430(), image_exr_from_scene_linear_to_output(), image_save_post(), and IMB_colormanagement_imbuf_for_write().

◆ media_type

char ImageFormatData::media_type

Definition at line 459 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_init_for_write(), BKE_image_format_set(), IMB_colormanagement_imbuf_for_write(), and uiTemplateImageSettings().

◆ planes

char ImageFormatData::planes

R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA.

Definition at line 471 of file DNA_scene_types.h.

Referenced by add_exr_compositing_result(), BKE_image_format_from_imbuf(), BKE_image_format_set(), BKE_image_render_write_exr(), BKE_image_save_options_init(), BKE_imbuf_write_as(), do_versions_image_settings_2_60(), image_save_single(), IMB_colormanagement_imbuf_for_write(), RE_render_result_rect_to_ibuf(), screenshot_exec(), and blender::ed::object::write_external_bake_pixels().

◆ quality

char ImageFormatData::quality

(0 - 100), eg: JPEG quality.

Definition at line 476 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), BKE_image_format_to_imbuf(), BKE_image_render_write_exr(), BKE_image_save_options_init(), and do_versions_image_settings_2_60().

◆ stereo3d_format

Stereo3dFormat ImageFormatData::stereo3d_format

Multi-view.

Definition at line 500 of file DNA_scene_types.h.

Referenced by BKE_image_save_options_init(), BKE_scene_multiview_videos_dimensions_get(), image_open_single(), IMB_stereo3d_ImBuf(), and blender::ed::vse::load_data_init_from_operator().

◆ tiff_codec

char ImageFormatData::tiff_codec

TIFF.

Definition at line 491 of file DNA_scene_types.h.

Referenced by BKE_image_format_from_imbuf(), and BKE_image_format_to_imbuf().

◆ view_settings

ColorManagedViewSettings ImageFormatData::view_settings

Definition at line 507 of file DNA_scene_types.h.

Referenced by BKE_image_format_blend_read_data(), BKE_image_format_blend_write(), BKE_image_format_color_management_copy(), BKE_image_format_color_management_copy_from_scene(), BKE_image_format_copy(), BKE_image_format_free(), BKE_image_format_init(), BKE_image_format_init_for_write(), image_save_post(), and IMB_colormanagement_imbuf_for_write().

◆ views_format

char ImageFormatData::views_format

Definition at line 501 of file DNA_scene_types.h.

Referenced by BKE_image_format_set(), BKE_image_render_write(), BKE_image_save_options_init(), BKE_scene_multiview_num_videos_get(), BKE_scene_multiview_videos_dimensions_get(), image_open_single(), image_save_single(), blender::ed::vse::load_data_init_from_operator(), RE_RenderAnim(), and RE_WriteRenderViewsMovie().

The documentation for this struct was generated from the following file:

DNA_scene_types.h