#include "CLG_log.h"
#include "MEM_guardedalloc.h"
#include "BLI_blenlib.h"
#include "BLI_map.hh"
#include "BLI_threads.h"
#include "BLI_utildefines.h"
#include "DNA_image_types.h"
#include "DNA_object_types.h"
#include "DNA_screen_types.h"
#include "DNA_space_types.h"
#include "DNA_windowmanager_types.h"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"
#include "BKE_context.hh"
#include "BKE_image.hh"
#include "BKE_paint.hh"
#include "BKE_undo_system.hh"
#include "DEG_depsgraph.hh"
#include "ED_object.hh"
#include "ED_paint.hh"
#include "ED_undo.hh"
#include "ED_util.hh"
#include "WM_api.hh"

Classes
struct	PaintTileKey

struct	PaintTile

struct	PaintTileMap

struct	UndoImageTile

struct	UndoImageBuf

struct	UndoImageHandle

struct	ImageUndoStep

Functions
Paint Tiles
Created on demand while painting, use to access the previous state for some paint operations. These buffers are also used for undo when available.
static ImBuf *	imbuf_alloc_temp_tile ()

static void	ptile_free (PaintTile *ptile)

static void	ptile_invalidate_map (PaintTileMap *paint_tile_map)

void *	ED_image_paint_tile_find (PaintTileMap paint_tile_map, Image image, ImBuf ibuf, ImageUser iuser, int x_tile, int y_tile, ushort **r_mask, bool validate)

static uint8_t *	image_undo_steal_and_assign_byte_buffer (ImBuf ibuf, uint8_t new_buffer_data)

static float *	image_undo_steal_and_assign_float_buffer (ImBuf ibuf, float new_buffer_data)

void *	ED_image_paint_tile_push (PaintTileMap paint_tile_map, Image image, ImBuf ibuf, ImBuf tmpibuf, ImageUser iuser, int x_tile, int y_tile, ushort r_mask, bool r_valid, bool use_thread_lock, bool find_prev)

static void	ptile_restore_runtime_map (PaintTileMap *paint_tile_map)

Image Undo Tile
static uint32_t	index_from_xy (uint32_t tile_x, uint32_t tile_y, const uint32_t tiles_dims[2])

static UndoImageTile *	utile_alloc (bool has_float)

static void	utile_init_from_imbuf (UndoImageTile utile, const uint32_t x, const uint32_t y, const ImBuf ibuf, ImBuf *tmpibuf)

static void	utile_restore (const UndoImageTile utile, const uint x, const uint y, ImBuf ibuf, ImBuf *tmpibuf)

static void	utile_decref (UndoImageTile *utile)

Image Undo Buffer
static UndoImageBuf *	ubuf_from_image_no_tiles (Image image, const ImBuf ibuf)

static void	ubuf_from_image_all_tiles (UndoImageBuf ubuf, const ImBuf ibuf)

static void	ubuf_ensure_compat_ibuf (const UndoImageBuf ubuf, ImBuf ibuf)

static void	ubuf_free (UndoImageBuf *ubuf)

Image Undo Handle
static void	uhandle_restore_list (ListBase *undo_handles, bool use_init)

static void	uhandle_free_list (ListBase *undo_handles)

Image Undo Internal Utilities
static UndoImageBuf *	uhandle_lookup_ubuf (UndoImageHandle uh, const Image , const char *ibuf_filepath)

static UndoImageBuf *	uhandle_add_ubuf (UndoImageHandle uh, Image image, ImBuf *ibuf)

static UndoImageBuf *	uhandle_ensure_ubuf (UndoImageHandle uh, Image image, ImBuf *ibuf)

static UndoImageHandle *	uhandle_lookup_by_name (ListBase undo_handles, const Image image, int tile_number)

static UndoImageHandle *	uhandle_lookup (ListBase undo_handles, const Image image, int tile_number)

static UndoImageHandle *	uhandle_add (ListBase undo_handles, Image image, ImageUser *iuser)

static UndoImageHandle *	uhandle_ensure (ListBase undo_handles, Image image, ImageUser *iuser)

Implements ED Undo System
static UndoImageBuf *	ubuf_lookup_from_reference (ImageUndoStep us_prev, const Image image, int tile_number, const UndoImageBuf *ubuf)

static bool	image_undosys_poll (bContext *C)

static void	image_undosys_step_encode_init (bContext , UndoStep us_p)

static bool	image_undosys_step_encode (bContext C, Main , UndoStep *us_p)

static void	image_undosys_step_decode_undo_impl (ImageUndoStep *us, bool is_final)

static void	image_undosys_step_decode_redo_impl (ImageUndoStep *us)

static void	image_undosys_step_decode_undo (ImageUndoStep *us, bool is_final)

static void	image_undosys_step_decode_redo (ImageUndoStep *us)

static void	image_undosys_step_decode (bContext C, Main bmain, UndoStep *us_p, const eUndoStepDir dir, bool is_final)

static void	image_undosys_step_free (UndoStep *us_p)

static void	image_undosys_foreach_ID_ref (UndoStep us_p, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void user_data)

void	ED_image_undosys_type (UndoType *ut)

Utilities
Note image undo exposes ED_image_undo_push_begin, ED_image_undo_push_end which must be called by the operator directly. Unlike most other undo stacks this is needed: So we can always access the state before the image was painted onto, which is needed if previous undo states aren't image-type. So operators can access the pixel-data before the stroke was applied, at run-time.
PaintTileMap *	ED_image_paint_tile_map_get ()

void	ED_image_undo_restore (UndoStep *us)

static ImageUndoStep *	image_undo_push_begin (const char *name, PaintMode paint_mode)

void	ED_image_undo_push_begin (const char *name, PaintMode paint_mode)

void	ED_image_undo_push_begin_with_image (const char name, Image image, ImBuf ibuf, ImageUser iuser)

void	ED_image_undo_push_end ()

Variables
static CLG_LogRef	LOG = {"ed.image.undo"}

Thread Locking
static SpinLock	paint_tiles_lock

void	ED_image_paint_tile_lock_init ()

void	ED_image_paint_tile_lock_end ()

Detailed Description

Overview

Each undo step is a ImageUndoStep
Each ImageUndoStep stores a list of UndoImageHandle
- Each UndoImageHandle stores a list of UndoImageBuf (this is the undo systems equivalent of an ImBuf).
  - Each UndoImageBuf stores an array of UndoImageTile The tiles are shared between UndoImageBuf's to avoid duplication.

When the undo system manages an image, there will always be a full copy (as a UndoImageBuf) each new undo step only stores modified tiles.

Definition in file image_undo.cc.

Function Documentation

◆ ED_image_paint_tile_find()

void * ED_image_paint_tile_find	(	PaintTileMap *	paint_tile_map,
		Image *	image,
		ImBuf *	ibuf,
		ImageUser *	iuser,
		int	x_tile,
		int	y_tile,
		ushort **	r_mask,
		bool	validate )

◆ ED_image_paint_tile_lock_end()

void ED_image_paint_tile_lock_end ( )

Definition at line 70 of file image_undo.cc.

References BLI_spin_end(), and paint_tiles_lock.

Referenced by project_paint_end().

◆ ED_image_paint_tile_lock_init()

void ED_image_paint_tile_lock_init ( )

Definition at line 65 of file image_undo.cc.

References BLI_spin_init(), and paint_tiles_lock.

Referenced by proj_paint_state_thread_init().

◆ ED_image_paint_tile_map_get()

PaintTileMap * ED_image_paint_tile_map_get ( )

Definition at line 1085 of file image_undo.cc.

References BKE_undosys_stack_init_or_active_with_type(), BKE_UNDOSYS_TYPE_IMAGE, BLI_assert, ED_undo_stack_get(), ImageUndoStep::paint_mode, ImageUndoStep::paint_tile_map, UndoStack::step_init, and Texture2D.

Referenced by ED_imapaint_dirty_region(), paint_2d_do_making_brush(), project_paint_undo_subtiles(), and blender::ed::sculpt_paint::paint::image::push_undo().

◆ ED_image_paint_tile_push()

void * ED_image_paint_tile_push	(	PaintTileMap *	paint_tile_map,
		Image *	image,
		ImBuf *	ibuf,
		ImBuf **	tmpibuf,
		ImageUser *	iuser,
		int	x_tile,
		int	y_tile,
		ushort **	r_mask,
		bool **	r_valid,
		bool	use_thread_lock,
		bool	find_prev )