#include "MEM_guardedalloc.h"
#include "BLI_bitmap.h"
#include "BLI_boxpack_2d.h"
#include "BLI_linklist.h"
#include "BLI_listbase.h"
#include "BLI_threads.h"
#include "DNA_image_types.h"
#include "DNA_userdef_types.h"
#include "IMB_colormanagement.h"
#include "IMB_imbuf.h"
#include "IMB_imbuf_types.h"
#include "BKE_global.h"
#include "BKE_image.h"
#include "BKE_image_partial_update.hh"
#include "BKE_main.h"
#include "GPU_capabilities.h"
#include "GPU_state.h"
#include "GPU_texture.h"
#include "PIL_time.h"

Classes
struct	PackTile

Functions
bool	BKE_image_has_gpu_texture_premultiplied_alpha (Image image, ImBuf ibuf)

Deletion
static void	image_free_gpu (Image *ima, const bool immediate)

void	BKE_image_free_gputextures (Image *ima)

void	BKE_image_free_all_gputextures (Main *bmain)

void	BKE_image_free_anim_gputextures (Main *bmain)

void	BKE_image_free_old_gputextures (Main *bmain)

Paint Update
static void	image_update_gputexture_ex (Image ima, ImageTile tile, ImBuf *ibuf, int x, int y, int w, int h)

static ImBuf *	update_do_scale (uchar rect, float rect_float, int x, int y, int w, int h, int limit_w, int limit_h, int full_w, int full_h)

static void	gpu_texture_update_scaled (GPUTexture tex, uchar rect, float rect_float, int full_w, int full_h, int x, int y, int layer, const int tile_offset, const int *tile_size, int w, int h)

static void	gpu_texture_update_unscaled (GPUTexture tex, uchar rect, float *rect_float, int x, int y, int layer, const int tile_offset[2], int w, int h, int tex_stride, int tex_offset)

static void	gpu_texture_update_from_ibuf (GPUTexture tex, Image ima, ImBuf ibuf, ImageTile tile, int x, int y, int w, int h)

void	BKE_image_update_gputexture (Image ima, ImageUser iuser, int x, int y, int w, int h)

void	BKE_image_update_gputexture_delayed (struct Image ima, struct ImageTile image_tile, struct ImBuf *ibuf, int x, int y, int w, int h)

void	BKE_image_paint_set_mipmap (Main *bmain, bool mipmap)

UDIM GPU Texture
static bool	is_over_resolution_limit (int w, int h)

static int	smaller_power_of_2_limit (int num)

static GPUTexture *	gpu_texture_create_tile_mapping (Image *ima, const int multiview_eye)

static int	compare_packtile (const void a, const void b)

static GPUTexture *	gpu_texture_create_tile_array (Image ima, ImBuf main_ibuf)

Regular gpu texture
static GPUTexture **	get_image_gpu_texture_ptr (Image *ima, eGPUTextureTarget textarget, const int multiview_eye)

static GPUTexture *	image_gpu_texture_error_create (eGPUTextureTarget textarget)

static void	image_gpu_texture_partial_update_changes_available (Image *image, PartialUpdateChecker< ImageTileData >::CollectResult &changes)

static void	image_gpu_texture_try_partial_update (Image image, ImageUser iuser)

static GPUTexture *	image_get_gpu_texture (Image ima, ImageUser iuser, ImBuf *ibuf, eGPUTextureTarget textarget)

GPUTexture *	BKE_image_get_gpu_texture (Image image, ImageUser iuser, ImBuf *ibuf)

GPUTexture *	BKE_image_get_gpu_tiles (Image image, ImageUser iuser, ImBuf *ibuf)

GPUTexture *	BKE_image_get_gpu_tilemap (Image image, ImageUser iuser, ImBuf *ibuf)

Delayed GPU texture free
Image datablocks can be deleted by any thread, but there may not be any active OpenGL context. In that case we push them into a queue and free the buffers later.
static LinkNode *	gpu_texture_free_queue = nullptr

static ThreadMutex	gpu_texture_queue_mutex = BLI_MUTEX_INITIALIZER

static void	gpu_free_unused_buffers ()

void	BKE_image_free_unused_gpu_textures ()

Function Documentation

◆ BKE_image_free_all_gputextures()

void BKE_image_free_all_gputextures ( Main * bmain )

Definition at line 521 of file image_gpu.cc.

References BKE_image_free_gputextures(), Main::images, and LISTBASE_FOREACH.

Referenced by ED_object_texture_paint_mode_enter_ex(), and ED_object_texture_paint_mode_exit_ex().

◆ BKE_image_free_anim_gputextures()

void BKE_image_free_anim_gputextures ( struct Main * bmain )

Same as above but only free animated images.

Definition at line 530 of file image_gpu.cc.

References BKE_image_free_gputextures(), BKE_image_is_animated(), Main::images, and LISTBASE_FOREACH.

Referenced by ED_view3d_draw_offscreen().

◆ BKE_image_free_gputextures()

void BKE_image_free_gputextures ( Image * ima )

Definition at line 516 of file image_gpu.cc.

References BLI_thread_is_main(), and image_free_gpu().

Referenced by bake_targets_refresh(), BKE_image_free_all_gputextures(), BKE_image_free_anim_gputextures(), BKE_image_free_buffers_ex(), BKE_image_free_old_gputextures(), BKE_image_paint_set_mipmap(), paint_2d_redraw(), ptile_restore_runtime_map(), and texture_paint_camera_project_exec().

◆ BKE_image_free_old_gputextures()

void BKE_image_free_old_gputextures ( Main * bmain )

Definition at line 541 of file image_gpu.cc.

References BKE_image_free_buffers, BKE_image_free_gputextures(), BKE_image_has_opengl_texture(), G, IMA_NOCOLLECT, Main::images, LISTBASE_FOREACH, and PIL_check_seconds_timer().

Referenced by view3d_main_region_draw().

◆ BKE_image_free_unused_gpu_textures()

void BKE_image_free_unused_gpu_textures ( void )

Delayed free of OpenGL buffers by main thread.

Definition at line 481 of file image_gpu.cc.

References BLI_thread_is_main(), and gpu_free_unused_buffers().

Referenced by wm_draw_update(), and WM_exit_ex().

◆ BKE_image_get_gpu_texture()

GPUTexture* BKE_image_get_gpu_texture	(	struct Image *	image,
		struct ImageUser *	iuser,
		struct ImBuf *	ibuf
	)

Get the GPUTexture for a given Image.

iuser and ibuf are mutual exclusive parameters. The caller can pass the ibuf when already available. It is also required when requesting the GPUTexture for a render result.

Definition at line 438 of file image_gpu.cc.

References image(), image_get_gpu_texture(), and TEXTARGET_2D.

Referenced by DRW_shgroup_add_material_resources(), blender::draw::image_engine::SpaceNodeAccessor::get_gpu_textures(), blender::draw::image_engine::SpaceImageAccessor::get_gpu_textures(), gpencil_image_texture_get(), image_camera_background_texture_get(), OVERLAY_edit_uv_cache_init(), OVERLAY_image_empty_cache_populate(), OVERLAY_paint_cache_init(), and workbench_image_setup_ex().

◆ BKE_image_get_gpu_tilemap()

GPUTexture* BKE_image_get_gpu_tilemap	(	Image *	image,
		ImageUser *	iuser,
		ImBuf *	ibuf
	)

Definition at line 448 of file image_gpu.cc.

References image(), image_get_gpu_texture(), and TEXTARGET_TILE_MAPPING.

Referenced by DRW_shgroup_add_material_resources(), blender::draw::image_engine::SpaceImageAccessor::get_gpu_textures(), and workbench_image_setup_ex().

◆ BKE_image_get_gpu_tiles()

GPUTexture* BKE_image_get_gpu_tiles	(	Image *	image,
		ImageUser *	iuser,
		ImBuf *	ibuf
	)

Definition at line 443 of file image_gpu.cc.

References image(), image_get_gpu_texture(), and TEXTARGET_2D_ARRAY.

Referenced by DRW_shgroup_add_material_resources(), blender::draw::image_engine::SpaceImageAccessor::get_gpu_textures(), and workbench_image_setup_ex().

◆ BKE_image_has_gpu_texture_premultiplied_alpha()

bool BKE_image_has_gpu_texture_premultiplied_alpha	(	struct Image *	image,
		struct ImBuf *	ibuf
	)

Is the alpha of the GPUTexture for a given image/ibuf premultiplied.

Definition at line 44 of file image_gpu.cc.

References ELEM, IMA_ALPHA_PREMUL, IMA_ALPHA_STRAIGHT, IMA_TYPE_COMPOSITE, IMA_TYPE_R_RESULT, IMA_TYPE_UV_TEST, image(), and ImBuf::rect_float.

Referenced by gpu_texture_create_tile_array(), gpu_texture_update_from_ibuf(), image_get_gpu_texture(), and ShaderParameters::update().

◆ BKE_image_paint_set_mipmap()

void BKE_image_paint_set_mipmap	(	struct Main *	bmain,
		bool	mipmap
	)

Called on entering and exiting texture paint mode, temporary disabling/enabling mipmapping on all images for quick texture updates with glTexSubImage2D. images that didn't change don't have to be re-uploaded to OpenGL.

Definition at line 866 of file image_gpu.cc.

References Freestyle::a, BKE_image_free_gputextures(), BKE_image_has_opengl_texture(), ELEM, GPU_texture_mipmap_mode(), IMA_GPU_MIPMAP_COMPLETE, Main::images, LISTBASE_FOREACH, tex, TEXTARGET_2D, TEXTARGET_2D_ARRAY, and TEXTARGET_COUNT.

Referenced by ED_object_texture_paint_mode_enter_ex(), and ED_object_texture_paint_mode_exit_ex().

◆ BKE_image_update_gputexture()

void BKE_image_update_gputexture	(	struct Image *	ima,
		struct ImageUser *	iuser,
		int	x,
		int	y,
		int	w,
		int	h
	)

Partial update of texture for texture painting. This is often much quicker than fully updating the texture for high resolution images.

Definition at line 838 of file image_gpu.cc.

References BKE_image_acquire_ibuf(), BKE_image_get_tile_from_iuser, BKE_image_release_ibuf(), BKE_image_update_gputexture_delayed(), w(), x, and y.

Referenced by imapaint_image_update().

◆ BKE_image_update_gputexture_delayed()

void BKE_image_update_gputexture_delayed	(	struct Image *	ima,
		struct ImageTile *	image_tile,
		struct ImBuf *	ibuf,
		int	x,
		int	y,
		int	w,
		int	h
	)

Mark areas on the GPUTexture that needs to be updated. The areas are marked in chunks. The next time the GPUTexture is used these tiles will be refreshes. This saves time when writing to the same place multiple times This happens for during foreground rendering.

Definition at line 846 of file image_gpu.cc.

References BKE_image_partial_update_mark_full_update(), BKE_image_partial_update_mark_region(), BLI_rcti_init(), IMA_SRC_TILED, Image::source, w(), x, ImBuf::x, y, and ImBuf::y.

Referenced by BKE_image_update_gputexture(), and image_rect_update().

◆ compare_packtile()

static int compare_packtile	(	const void *	a,
		const void *	b
	)

static

Definition at line 128 of file image_gpu.cc.

References Freestyle::a, usdtokens::b(), and PackTile::pack_score.

Referenced by gpu_texture_create_tile_array().

◆ get_image_gpu_texture_ptr()

static GPUTexture** get_image_gpu_texture_ptr	(	Image *	ima,
		eGPUTextureTarget	textarget,
		const int	multiview_eye
	)

static

Definition at line 252 of file image_gpu.cc.

References BLI_assert, ELEM, Image::gputexture, and TEXTARGET_COUNT.

Referenced by image_get_gpu_texture().

◆ gpu_free_unused_buffers()

static void gpu_free_unused_buffers ( )

static

Definition at line 465 of file image_gpu.cc.

References BLI_linklist_pop(), BLI_mutex_lock(), BLI_mutex_unlock(), GPU_texture_free(), gpu_texture_free_queue, gpu_texture_queue_mutex, and tex.

Referenced by BKE_image_free_unused_gpu_textures(), and image_get_gpu_texture().

◆ gpu_texture_create_tile_array()

static GPUTexture* gpu_texture_create_tile_array	(	Image *	ima,
		ImBuf *	main_ibuf
	)

static

Definition at line 136 of file image_gpu.cc.

References BKE_image_acquire_ibuf(), BKE_image_has_gpu_texture_premultiplied_alpha(), BKE_image_release_ibuf(), BKE_imageuser_default(), BLI_addtail(), BLI_assert, BLI_box_pack_2d_fixedarea(), BLI_freelistN(), BLI_listbase_sort(), PackTile::boxpack, compare_packtile(), ListBase::first, Image::flag, GPU_mipmap_enabled(), GPU_texture_generate_mipmap(), GPU_texture_mipmap_mode(), Image::gpuflag, FixedSizeBoxPack::h, Image::id, IMA_GPU_MIPMAP_COMPLETE, IMA_HIGH_BITDEPTH, IMB_touch_gpu_texture(), IMB_update_gpu_texture_sub(), is_over_resolution_limit(), LISTBASE_FOREACH, max_ff(), max_ii(), min_ff(), ID::name, PackTile::pack_score, smaller_power_of_2_limit(), tex, tile, PackTile::tile, ImageUser::tile, ImageTile_Runtime::tilearray_layer, ImageTile_Runtime::tilearray_offset, ImageTile_Runtime::tilearray_size, Image::tiles, UNPACK2, w(), FixedSizeBoxPack::w, ImBuf::x, and ImBuf::y.

Referenced by image_get_gpu_texture().

◆ gpu_texture_create_tile_mapping()

static GPUTexture* gpu_texture_create_tile_mapping	(	Image *	ima,
		const int	multiview_eye
	)

static

Definition at line 80 of file image_gpu.cc.

References BKE_image_sort_tiles(), data, GPU_RGBA32F, GPU_texture_create_1d_array(), GPU_texture_height(), GPU_texture_mipmap_mode(), GPU_texture_width(), Image::gputexture, Image::id, ListBase::last, LISTBASE_FOREACH, MEM_callocN, MEM_freeN, ID::name, tex, TEXTARGET_2D_ARRAY, tile, ImageTile::tile_number, ImageTile_Runtime::tilearray_layer, ImageTile_Runtime::tilearray_offset, ImageTile_Runtime::tilearray_size, Image::tiles, and width.

Referenced by image_get_gpu_texture().

◆ gpu_texture_update_from_ibuf()

static void gpu_texture_update_from_ibuf	(	GPUTexture *	tex,
		Image *	ima,
		ImBuf *	ibuf,
		ImageTile *	tile,
		int	x,
		int	y,
		int	w,
		int	h
	)

static

Definition at line 690 of file image_gpu.cc.

References BKE_image_has_gpu_texture_premultiplied_alpha(), ImBuf::channels, GPU_mipmap_enabled(), GPU_texture_generate_mipmap(), GPU_texture_height(), GPU_texture_unbind(), gpu_texture_update_scaled(), gpu_texture_update_unscaled(), GPU_texture_width(), Image::gpuflag, IMA_GPU_MIPMAP_COMPLETE, IMB_colormanagement_imbuf_to_byte_texture(), IMB_colormanagement_imbuf_to_float_texture(), IMB_colormanagement_space_is_data(), IMB_colormanagement_space_is_scene_linear(), IMB_colormanagement_space_is_srgb(), max_ii(), MEM_freeN, MEM_mallocN, min_ii(), padding(), ImBuf::rect, ImBuf::rect_colorspace, ImBuf::rect_float, scaled(), tex, tile, ImageTile_Runtime::tilearray_layer, ImageTile_Runtime::tilearray_offset, ImageTile_Runtime::tilearray_size, w(), x, ImBuf::x, y, and ImBuf::y.

Referenced by image_update_gputexture_ex().

◆ gpu_texture_update_scaled()

static void gpu_texture_update_scaled	(	GPUTexture *	tex,
		uchar *	rect,
		float *	rect_float,
		int	full_w,
		int	full_h,
		int	x,
		int	y,
		int	layer,
		const int *	tile_offset,
		const int *	tile_size,
		int	w,
		int	h
	)

static

Definition at line 622 of file image_gpu.cc.

References data, GPU_DATA_FLOAT, GPU_DATA_UBYTE, GPU_texture_height(), GPU_texture_update_sub(), GPU_texture_width(), IMB_freeImBuf(), ImBuf::rect, ImBuf::rect_float, tex, update_do_scale(), w(), x, and y.

Referenced by gpu_texture_update_from_ibuf().

◆ gpu_texture_update_unscaled()

static void gpu_texture_update_unscaled	(	GPUTexture *	tex,
		uchar *	rect,
		float *	rect_float,
		int	x,
		int	y,
		int	layer,
		const int	tile_offset[2],
		int	w,
		int	h,
		int	tex_stride,
		int	tex_offset
	)