Blender  V2.93
Public Types | Public Member Functions | Public Attributes | List of all members
Image Struct Reference

#include <Image.h>

Public Types

enum  Format { Format_RGB , Format_ARGB }
 

Public Member Functions

 Image ()
 
 ~Image ()
 
void allocate (uint w, uint h)
 
uint width () const
 
uint height () const
 
const Color32 * scanline (uint h) const
 
Color32 * scanline (uint h)
 
const Color32 * pixels () const
 
Color32 * pixels ()
 
const Color32 & pixel (uint idx) const
 
Color32 & pixel (uint idx)
 
const Color32 & pixel (uint x, uint y) const
 
Color32 & pixel (uint x, uint y)
 
Format format () const
 
void setFormat (Format f)
 

Public Attributes

ID id
 
char filepath [1024]
 
struct MovieCache * cache
 
struct GPUTexture * gputexture [3][2]
 
ListBase anims
 
struct RenderResult * rr
 
ListBase renderslots
 
short render_slot
 
short last_render_slot
 
int flag
 
short source
 
short type
 
int lastframe
 
ListBase gpu_refresh_areas
 
int gpuframenr
 
short gpuflag
 
short gpu_pass
 
short gpu_layer
 
short gpu_view
 
char _pad2 [4]
 
struct PackedFile *packedfile DNA_DEPRECATED
 
struct ListBase packedfiles
 
struct PreviewImage * preview
 
int lastused
 
int gen_x
 
int gen_y
 
char gen_type
 
char gen_flag
 
short gen_depth
 
float gen_color [4]
 
float aspx
 
float aspy
 
ColorManagedColorspaceSettings colorspace_settings
 
char alpha_mode
 
char _pad
 
char eye
 
char views_format
 
int active_tile_index
 
ListBase tiles
 
ListBase views
 
struct Stereo3dFormat * stereo3d_format
 

Detailed Description

32 bit RGBA image.

Definition at line 36 of file imbuf/intern/dds/Image.h.

Member Enumeration Documentation

◆ Format

enum Image::Format
Enumerator
Format_RGB 
Format_ARGB 

Definition at line 38 of file imbuf/intern/dds/Image.h.

Constructor & Destructor Documentation

◆ Image()

Image::Image ( )

Definition at line 35 of file Image.cpp.

◆ ~Image()

Image::~Image ( )

Definition at line 39 of file Image.cpp.

Member Function Documentation

◆ allocate()

void Image::allocate ( uint  w,
uint  h 
)

Definition at line 44 of file Image.cpp.

References w().

Referenced by DirectDrawSurface::mipmap().

◆ format()

Image::Format Image::format ( ) const

Definition at line 114 of file Image.cpp.

Referenced by imb_load_dds().

◆ height()

uint Image::height ( ) const

Definition at line 63 of file Image.cpp.

Referenced by ColorBlock::init().

◆ pixel() [1/4]

Color32 & Image::pixel ( uint  idx)

Definition at line 105 of file Image.cpp.

◆ pixel() [2/4]

const Color32 & Image::pixel ( uint  idx) const

Definition at line 96 of file Image.cpp.

Referenced by pixel().

◆ pixel() [3/4]

Color32 & Image::pixel ( uint  x,
uint  y 
)
inline

Definition at line 87 of file imbuf/intern/dds/Image.h.

References pixel(), width(), x, and y.

◆ pixel() [4/4]

const Color32 & Image::pixel ( uint  x,
uint  y 
) const
inline

Definition at line 82 of file imbuf/intern/dds/Image.h.

References pixel(), width(), x, and y.

◆ pixels() [1/2]

Color32 * Image::pixels ( )

Definition at line 91 of file Image.cpp.

◆ pixels() [2/2]

const Color32 * Image::pixels ( ) const

Definition at line 86 of file Image.cpp.

Referenced by imb_load_dds(), and ColorBlock::init().

◆ scanline() [1/2]

Color32 * Image::scanline ( uint  h)

Definition at line 77 of file Image.cpp.

◆ scanline() [2/2]

const Color32 * Image::scanline ( uint  h) const

Definition at line 68 of file Image.cpp.

◆ setFormat()

void Image::setFormat ( Image::Format  f)

Definition at line 119 of file Image.cpp.

Referenced by DirectDrawSurface::mipmap().

◆ width()

uint Image::width ( ) const

Definition at line 58 of file Image.cpp.

Referenced by ColorBlock::init(), and pixel().

Member Data Documentation

◆ _pad

char Image::_pad

Definition at line 187 of file DNA_image_types.h.

◆ _pad2

char Image::_pad2[4]

Definition at line 165 of file DNA_image_types.h.

◆ active_tile_index

int Image::active_tile_index

Definition at line 195 of file DNA_image_types.h.

Referenced by draw_udim_tile_grids(), tile_add_exec(), tile_add_invoke(), tile_fill_exec(), tile_fill_poll(), tile_remove_exec(), and tile_remove_poll().

◆ alpha_mode

char Image::alpha_mode

Definition at line 185 of file DNA_image_types.h.

Referenced by BKE_image_alpha_mode_from_extension(), BKE_image_has_gpu_texture_premultiplied_alpha(), blo_do_versions_260(), blo_do_versions_pre250(), gpencil_image_texture_get(), image_camera_background_texture_get(), image_init_color_management(), imagewrap(), imagewraposa(), imagewraposa_aniso(), imbuf_alpha_flags_for_image(), node_shader_gpu_tex_environment(), node_shader_gpu_tex_image(), ntree_version_245(), OVERLAY_image_empty_cache_populate(), OVERLAY_paint_cache_init(), and workbench_image_setup_ex().

◆ anims

ListBase Image::anims

Definition at line 147 of file DNA_image_types.h.

Referenced by BKE_image_has_anim(), image_blend_read_data(), image_copy_data(), image_free_anims(), image_load_movie_file(), image_match_len_exec(), load_movie_single(), and uiTemplateImageInfo().

◆ aspx

float Image::aspx

Definition at line 181 of file DNA_image_types.h.

Referenced by BKE_image_get_aspect(), blo_do_versions_pre250(), ED_space_image_get_aspect(), image_camera_background_texture_get(), image_main_region_set_view2d(), overlay_image_calc_aspect(), and WIDGETGROUP_empty_image_refresh().

◆ aspy

float Image::aspy

Definition at line 181 of file DNA_image_types.h.

Referenced by BKE_image_get_aspect(), blo_do_versions_pre250(), ED_space_image_get_aspect(), image_camera_background_texture_get(), image_main_region_set_view2d(), overlay_image_calc_aspect(), and WIDGETGROUP_empty_image_refresh().

◆ cache

struct MovieCache* Image::cache

Not written in file.

Definition at line 142 of file DNA_image_types.h.

Referenced by BKE_image_file_format_set(), BKE_image_free_all_textures(), BKE_image_free_anim_ibufs(), BKE_image_get_first_ibuf(), BKE_image_get_ibuf_with_name(), BKE_image_has_loaded_ibuf(), BKE_image_is_dirty_writable(), BKE_image_merge(), draw_image_cache(), image_blend_read_lib(), image_copy_data(), image_foreach_cache(), image_free_cached_frames(), image_mem_size(), image_save_sequence_exec(), imagecache_get(), imagecache_put(), and imagecache_remove().

◆ colorspace_settings

ColorManagedColorspaceSettings Image::colorspace_settings

Definition at line 184 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), BKE_image_fill_tile(), blo_do_versions_260(), image_acquire_ibuf(), image_copy_data(), image_init(), image_init_color_management(), image_node_colorspace(), image_save_post(), IMB_colormanagement_check_file_config(), load_image_single(), load_movie_single(), load_sequence_single(), node_shader_gpu_tex_environment(), node_shader_gpu_tex_image(), and uiTemplateImage().

◆ DNA_DEPRECATED

struct PackedFile* packedfile Image::DNA_DEPRECATED

Deprecated.

Definition at line 168 of file DNA_image_types.h.

◆ eye

char Image::eye

For viewer node stereoscopy.

Definition at line 191 of file DNA_image_types.h.

Referenced by image_get_multiview_index(), and wm_draw_region_stereo_set().

◆ filepath

char Image::filepath[1024]

File path, 1024 = FILE_MAX.

Definition at line 139 of file DNA_image_types.h.

Referenced by BKE_bpath_traverse_id(), BKE_image_add_from_imbuf(), BKE_image_add_generated(), BKE_image_alpha_mode_from_extension(), BKE_image_fill_tile(), BKE_image_has_filepath(), BKE_image_is_openexr(), BKE_image_load(), BKE_image_load_exists_ex(), BKE_image_packfiles(), BKE_image_packfiles_from_mem(), BKE_image_sequence_guess_offset(), BKE_image_signal(), BKE_image_user_file_path(), blo_do_versions_270(), blo_do_versions_pre250(), image_acquire_ibuf(), image_has_valid_path(), image_open_invoke(), image_open_single(), image_replace_exec(), image_replace_invoke(), image_save_exec(), image_save_options_init(), image_save_post(), image_unpack_invoke(), and image_update_views_format().

◆ flag

int Image::flag

Definition at line 153 of file DNA_image_types.h.

Referenced by blo_do_versions_260(), blo_do_versions_pre250(), draw_plane_marker_image(), gpu_texture_create_tile_array(), image_buttons_region_draw(), image_camera_background_texture_get(), image_get_gpu_texture(), image_init(), image_open_single(), image_sample(), image_sample_apply(), image_update_views_format(), imagewrap(), imagewraposa(), imagewraposa_aniso(), IMB_colormanagement_display_settings_from_ctx(), load_movie_single(), and ntree_version_245().

◆ gen_color

float Image::gen_color[4]

Definition at line 178 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), blo_do_versions_270(), and image_acquire_ibuf().

◆ gen_depth

short Image::gen_depth

Definition at line 177 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), and image_acquire_ibuf().

◆ gen_flag

char Image::gen_flag

Definition at line 176 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), and image_acquire_ibuf().

◆ gen_type

char Image::gen_type

Definition at line 176 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), blo_do_versions_pre250(), image_acquire_ibuf(), ubuf_from_image_no_tiles(), and uiTemplateImage().

◆ gen_x

int Image::gen_x

Definition at line 175 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), BKE_image_signal(), blo_do_versions_pre250(), and image_acquire_ibuf().

◆ gen_y

int Image::gen_y

Definition at line 175 of file DNA_image_types.h.

Referenced by BKE_image_add_generated(), BKE_image_signal(), blo_do_versions_pre250(), and image_acquire_ibuf().

◆ gpu_layer

short Image::gpu_layer

Definition at line 163 of file DNA_image_types.h.

Referenced by image_get_gpu_texture().

◆ gpu_pass

short Image::gpu_pass

Definition at line 162 of file DNA_image_types.h.

Referenced by image_get_gpu_texture().

◆ gpu_refresh_areas

ListBase Image::gpu_refresh_areas

Definition at line 159 of file DNA_image_types.h.

Referenced by BKE_image_update_gputexture_delayed(), image_blend_read_data(), image_free_data(), and image_get_gpu_texture().

◆ gpu_view

short Image::gpu_view

Definition at line 164 of file DNA_image_types.h.

Referenced by image_get_gpu_texture().

◆ gpuflag

short Image::gpuflag

Definition at line 161 of file DNA_image_types.h.

Referenced by BKE_image_acquire_renderresult(), BKE_image_update_gputexture_delayed(), BKE_image_user_frame_calc(), ED_image_slot_cycle(), gpu_texture_create_tile_array(), gpu_texture_update_from_ibuf(), image_blend_read_data(), image_free_gpu(), image_get_gpu_texture(), and screen_opengl_render_apply().

◆ gpuframenr

int Image::gpuframenr

Definition at line 160 of file DNA_image_types.h.

Referenced by BKE_image_user_frame_calc().

◆ gputexture

struct GPUTexture* Image::gputexture[3][2]

Not written in file 3 = TEXTARGET_COUNT, 2 = stereo eyes.

Definition at line 144 of file DNA_image_types.h.

Referenced by BKE_image_add_tile(), BKE_image_has_opengl_texture(), get_image_gpu_texture_ptr(), gpu_texture_create_tile_mapping(), image_copy_data(), image_foreach_cache(), image_free_gpu(), image_free_tile(), and image_update_gputexture_ex().

◆ id

ID Image::id

Definition at line 136 of file DNA_image_types.h.

Referenced by bake_images(), bake_object_check(), bake_targets_clear(), bake_targets_init_image_textures(), bake_targets_init_internal(), bake_targets_output_external(), bake_targets_refresh(), BKE_image_all_free_anim_ibufs(), BKE_image_ensure_viewer(), BKE_image_free(), BKE_image_free_all_textures(), BKE_image_load_exists_ex(), BKE_image_print_memlist(), BKE_image_signal(), BKE_image_user_file_path(), BKE_packedfile_count_all(), BKE_packedfile_pack_all(), BKE_packedfile_unpack_all(), blo_do_versions_260(), blo_do_versions_270(), blo_do_versions_pre250(), brush_make_local(), blender::deg::DepsgraphNodeBuilder::build_image(), blender::deg::DepsgraphRelationBuilder::build_image(), clear_images_poly(), clear_single_image(), count_images(), cryptomatte_init_from_node_image(), ED_imapaint_bucket_fill(), ED_object_assign_active_image(), empty_drop_named_image_invoke(), eyedropper_cryptomatte_sample_image_fl(), finish_images(), gpencil_boundaryfill_area(), gpencil_erase_processed_area(), gpencil_invert_image(), gpencil_render_offscreen(), gpencil_set_borders(), gpu_texture_create_tile_array(), gpu_texture_create_tile_mapping(), image_blend_write(), image_changed(), image_copy_data(), image_free_data(), image_get_gpu_texture(), image_init_after_load(), image_new_exec(), image_open_exec(), image_open_invoke(), image_pack_exec(), image_reload_exec(), image_replace_exec(), image_save_options_init(), image_save_post(), image_scale_exec(), image_unpack_invoke(), image_update_views_format(), IMB_colormanagement_check_file_config(), load_image_single(), node_socket_copy_default_value(), pack_all_invoke(), paint_2d_redraw(), palette_extract_img_exec(), proj_paint_add_slot(), proj_paint_state_viewport_init(), project_paint_end(), texture_paint_camera_project_exec(), texture_paint_image_from_view_exec(), tracking_plane_tracks_copy(), uhandle_lookup_by_name(), and uhandle_restore_list().

◆ last_render_slot

short Image::last_render_slot

Definition at line 151 of file DNA_image_types.h.

Referenced by BKE_image_acquire_renderresult(), BKE_image_backup_render(), BKE_image_clear_renderslot(), BKE_image_release_renderresult(), BKE_image_remove_renderslot(), ED_image_slot_cycle(), image_blend_read_data(), image_cycle_render_slot_exec(), image_get_render_result(), and image_rect_update().

◆ lastframe

int Image::lastframe

Definition at line 155 of file DNA_image_types.h.

Referenced by BKE_image_user_file_path(), image_get_cached_ibuf(), image_get_entry_and_index(), load_image_single(), load_sequence_single(), paint_sample_color(), and project_paint_PickColor().

◆ lastused

int Image::lastused

Definition at line 172 of file DNA_image_types.h.

Referenced by BKE_image_tag_time().

◆ packedfiles

struct ListBase Image::packedfiles

Definition at line 168 of file DNA_image_types.h.

Referenced by BKE_image_has_packedfile(), BKE_image_packfiles(), BKE_image_packfiles_from_mem(), BKE_image_signal(), BKE_packedfile_unpack_image(), blo_do_versions_270(), image_blend_read_data(), image_blend_write(), image_copy_data(), image_free_packedfiles(), image_load_image_file(), image_memorypack_imbuf(), image_not_packed_poll(), image_unpack_invoke(), and load_image_single().

◆ preview

struct PreviewImage* Image::preview

Definition at line 170 of file DNA_image_types.h.

Referenced by blo_do_versions_pre250(), image_blend_read_data(), image_blend_write(), image_copy_data(), image_free_data(), and image_init_after_load().

◆ render_slot

short Image::render_slot

Definition at line 151 of file DNA_image_types.h.

Referenced by BKE_image_acquire_renderresult(), BKE_image_backup_render(), BKE_image_release_renderresult(), BKE_image_remove_renderslot(), ED_image_slot_cycle(), image_add_render_slot_exec(), image_blend_read_data(), image_clear_render_slot_exec(), image_cycle_render_slot_exec(), image_get_render_result(), image_rect_update(), image_remove_render_slot_exec(), ui_imageuser_slot_menu(), uiTemplateImage(), and uiTemplateImageLayers().

◆ renderslots

ListBase Image::renderslots

Definition at line 150 of file DNA_image_types.h.

Referenced by BKE_image_add_renderslot(), BKE_image_backup_render(), BKE_image_clear_renderslot(), BKE_image_get_renderslot(), BKE_image_remove_renderslot(), ED_image_slot_cycle(), image_add_render_slot_exec(), image_blend_read_data(), image_blend_write(), image_copy_data(), image_foreach_cache(), image_free_data(), and ui_imageuser_slot_menu().

◆ rr

struct RenderResult* Image::rr

Definition at line 148 of file DNA_image_types.h.

Referenced by BKE_image_acquire_renderresult(), BKE_image_free_buffers_ex(), BKE_image_init_imageuser(), BKE_image_release_renderresult(), cmp_node_image_create_outputs(), blender::compositor::ImageNode::convertToOperations(), cryptomatte_init_from_node_image(), draw_image_main(), eyedropper_cryptomatte_sample_image_fl(), blender::compositor::MultilayerBaseOperation::getImBuf(), blender::compositor::MultilayerColorOperation::getMetaData(), image_copy_data(), image_foreach_cache(), image_get_ibuf_multilayer(), image_load_sequence_multilayer(), paint_2d_new_stroke(), space_image_gpu_texture_get(), and uiTemplateImage().

◆ source

short Image::source

Definition at line 154 of file DNA_image_types.h.

Referenced by BKE_bpath_traverse_id(), BKE_image_add_tile(), BKE_image_ensure_viewer(), BKE_image_fill_tile(), BKE_image_get_tile(), BKE_image_get_tile_from_pos(), BKE_image_has_multiple_ibufs(), BKE_image_is_animated(), BKE_image_is_multilayer(), BKE_image_is_openexr(), BKE_image_load(), BKE_image_load_exists_ex(), BKE_image_memorypack(), BKE_image_remove_tile(), BKE_image_save(), BKE_image_signal(), BKE_image_user_file_path(), BKE_packedfile_pack_all(), blo_do_versions_260(), blo_do_versions_pre250(), clipUVTransform(), draw_image_cache(), draw_image_main(), draw_image_main_helpers(), draw_udim_tile_grids(), ED_space_image_show_cache(), gpencil_trace_image_exec(), gpencil_trace_image_poll(), image_acquire_ibuf(), image_cache_image_add(), image_camera_background_texture_get(), image_get_cached_ibuf(), image_get_entry_and_index(), image_get_multiview_index(), image_init(), image_main_region_draw(), image_mem_size(), image_open_exec(), image_open_single(), image_pack_test(), image_refresh(), image_replace_exec(), image_save_as_invoke(), image_save_as_poll(), image_save_options_init(), image_save_post(), image_save_sequence_exec(), image_should_be_saved(), image_unpack_exec(), image_unpack_invoke(), image_view_all(), imagewrap(), node_shader_gpu_tex_image(), OVERLAY_edit_uv_init(), paint_sample_color(), project_paint_face_paint_tile(), space_image_gpu_texture_get(), tile_add_poll(), tile_fill_poll(), tile_remove_poll(), trace_start_job(), ubuf_from_image_no_tiles(), uiTemplateImage(), uiTemplateImageInfo(), and workbench_image_setup_ex().

◆ stereo3d_format

struct Stereo3dFormat* Image::stereo3d_format

Definition at line 200 of file DNA_image_types.h.

Referenced by blo_do_versions_270(), image_blend_read_data(), image_blend_write(), image_copy_data(), image_free_data(), image_init(), image_load_image_file(), image_load_movie_file(), image_load_sequence_file(), image_open_single(), and image_save_options_init().

◆ tiles

ListBase Image::tiles

Definition at line 196 of file DNA_image_types.h.

Referenced by bake_targets_refresh(), BKE_image_add_tile(), BKE_image_find_nearest_tile(), BKE_image_free_buffers_ex(), BKE_image_get_tile(), BKE_image_load_exists_ex(), BKE_image_remove_tile(), BKE_image_save(), BKE_image_signal(), BKE_image_user_frame_calc(), draw_image_main(), draw_udim_tile_grids(), gpu_texture_create_tile_array(), gpu_texture_create_tile_mapping(), image_blend_read_data(), image_blend_write(), image_cache_image_add(), image_copy_data(), image_free_data(), image_free_tile(), image_init(), image_update_gputexture_ex(), image_view_all(), paint_2d_new_stroke(), tile_add_exec(), tile_add_invoke(), tile_fill_exec(), and tile_remove_exec().

◆ type

short Image::type

Definition at line 154 of file DNA_image_types.h.

Referenced by BKE_image_acquire_renderresult(), BKE_image_ensure_viewer(), BKE_image_get_size(), BKE_image_has_gpu_texture_premultiplied_alpha(), BKE_image_is_multilayer(), BKE_image_memorypack(), BKE_image_release_renderresult(), BKE_image_signal(), blo_do_versions_pre250(), compo_get_recalc_flags(), blender::compositor::ImageNode::convertToOperations(), draw_image_main(), draw_image_main_helpers(), ED_space_image_acquire_buffer(), ED_space_image_get_size(), ED_space_image_scopes_update(), ED_space_image_set(), ED_space_image_show_render(), eyedropper_cryptomatte_sample_image_fl(), find_area_showing_r_result(), image_acquire_ibuf(), image_cycle_render_slot_poll(), image_get_cached_ibuf(), image_get_entry_and_index(), image_get_ibuf_multilayer(), image_get_multiview_index(), image_init(), image_load_sequence_multilayer(), image_save_as_invoke(), image_save_options_init(), image_save_post(), image_save_sequence_exec(), image_save_single(), image_should_be_saved_when_modified(), image_user_refresh_scene(), load_image_single(), load_sequence_single(), OVERLAY_edit_uv_init(), trace_start_job(), uiTemplateImage(), uiTemplateImageLayers(), and uiTemplateImageViews().

◆ views

ListBase Image::views

ImageView.

Definition at line 199 of file DNA_image_types.h.

Referenced by BKE_image_ensure_viewer_views(), BKE_image_free_views(), BKE_image_is_multiview(), BKE_image_is_stereo(), BKE_image_memorypack(), BKE_image_multiview_index(), BKE_image_packfiles(), BKE_image_user_file_path(), image_add_view(), image_blend_read_data(), image_blend_write(), image_copy_data(), image_free_tile(), image_init_multilayer_multiview(), image_load_image_file(), image_load_movie_file(), image_load_sequence_file(), image_num_files(), image_save_single(), image_update_views_format(), ui_imageuser_view_menu_multiview(), and uiblock_layer_pass_buttons().

◆ views_format

char Image::views_format

Definition at line 192 of file DNA_image_types.h.

Referenced by BKE_image_memorypack(), image_load_image_file(), image_load_movie_file(), image_load_sequence_file(), image_num_files(), image_open_single(), image_save_options_init(), and image_update_views_format().

The documentation for this struct was generated from the following files:
Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1