Blender: blender::bke::image::partial_update::PartialUpdateRegisterImpl Struct Reference

Blender V5.0

Partial update changes stored inside the image runtime. More...

Public Member Functions
void	update_resolution (const ImageTile image_tile, const ImBuf image_buffer)
void	mark_full_update ()
void	mark_region (const ImageTile image_tile, const rcti updated_region)
void	ensure_empty_changeset ()
void	commit_current_changeset ()
	Move the current changeset to the history and resets the current changeset.
void	limit_history ()
	Limit the number of items in the changeset.
bool	can_construct (ChangesetID changeset_id)
	Check if data is available to construct the update tiles for the given changeset_id.
std::optional< TileChangeset >	changed_tile_chunks_since (const ImageTile *image_tile, const ChangesetID from_changeset)
	collect all historic changes since a given changeset.

Public Attributes
ChangesetID	first_changeset_id
	changeset id of the first changeset kept in history.
ChangesetID	last_changeset_id
	changeset id of the top changeset kept in history.
Vector< Changeset >	history
	history of changesets.
Changeset	current_changeset
	The current changeset. New changes will be added to this changeset.

Detailed Description

Partial update changes stored inside the image runtime.

The PartialUpdateRegisterImpl will keep track of changes over time. Changes are groups inside TileChangesets.

Definition at line 349 of file image_partial_update.cc.

Member Function Documentation

◆ can_construct()

bool blender::bke::image::partial_update::PartialUpdateRegisterImpl::can_construct ( ChangesetID changeset_id )

inline

Check if data is available to construct the update tiles for the given changeset_id.

The update tiles can be created when changeset id is between

Definition at line 422 of file image_partial_update.cc.

References first_changeset_id, and last_changeset_id.

Referenced by blender::bke::image::partial_update::BKE_image_partial_update_collect_changes().

◆ changed_tile_chunks_since()

std::optional< TileChangeset > blender::bke::image::partial_update::PartialUpdateRegisterImpl::changed_tile_chunks_since	(	const ImageTile *	image_tile,
		const ChangesetID	from_changeset )

inline

collect all historic changes since a given changeset.

Definition at line 438 of file image_partial_update.cc.

References blender::bke::image::partial_update::TileChangeset::chunk_x_len, blender::bke::image::partial_update::TileChangeset::chunk_y_len, first_changeset_id, history, and ImageTile::tile_number.

Referenced by blender::bke::image::partial_update::BKE_image_partial_update_collect_changes().

◆ commit_current_changeset()

void blender::bke::image::partial_update::PartialUpdateRegisterImpl::commit_current_changeset ( )

inline

Move the current changeset to the history and resets the current changeset.

Definition at line 398 of file image_partial_update.cc.

References current_changeset, history, and last_changeset_id.

Referenced by ensure_empty_changeset().

◆ ensure_empty_changeset()

void blender::bke::image::partial_update::PartialUpdateRegisterImpl::ensure_empty_changeset ( )

inline

Definition at line 386 of file image_partial_update.cc.

References commit_current_changeset(), current_changeset, and limit_history().

Referenced by blender::bke::image::partial_update::BKE_image_partial_update_collect_changes().

◆ limit_history()

void blender::bke::image::partial_update::PartialUpdateRegisterImpl::limit_history ( )

inline

Limit the number of items in the changeset.

Definition at line 406 of file image_partial_update.cc.

References first_changeset_id, history, blender::bke::image::partial_update::MAX_HISTORY_LEN, and max_ii().

Referenced by ensure_empty_changeset().

◆ mark_full_update()

void blender::bke::image::partial_update::PartialUpdateRegisterImpl::mark_full_update ( )

inline

Definition at line 371 of file image_partial_update.cc.

References current_changeset, first_changeset_id, history, and last_changeset_id.

Referenced by BKE_image_partial_update_mark_full_update(), and update_resolution().

◆ mark_region()

void blender::bke::image::partial_update::PartialUpdateRegisterImpl::mark_region	(	const ImageTile *	image_tile,
		const rcti *	updated_region )

inline

Definition at line 379 of file image_partial_update.cc.

References current_changeset, blender::bke::image::partial_update::TileChangeset::has_dirty_chunks(), and blender::bke::image::partial_update::TileChangeset::mark_region().

Referenced by BKE_image_partial_update_mark_region().

◆ update_resolution()

void blender::bke::image::partial_update::PartialUpdateRegisterImpl::update_resolution	(	const ImageTile *	image_tile,
		const ImBuf *	image_buffer )

inline

Definition at line 360 of file image_partial_update.cc.

References current_changeset, blender::bke::image::partial_update::TileChangeset::has_dirty_chunks(), history, mark_full_update(), and blender::bke::image::partial_update::TileChangeset::update_resolution().

Referenced by BKE_image_partial_update_mark_region().

Member Data Documentation

◆ current_changeset

Changeset blender::bke::image::partial_update::PartialUpdateRegisterImpl::current_changeset

The current changeset. New changes will be added to this changeset.

Definition at line 358 of file image_partial_update.cc.

Referenced by commit_current_changeset(), ensure_empty_changeset(), mark_full_update(), mark_region(), and update_resolution().

◆ first_changeset_id

ChangesetID blender::bke::image::partial_update::PartialUpdateRegisterImpl::first_changeset_id

changeset id of the first changeset kept in history.

Definition at line 351 of file image_partial_update.cc.

Referenced by can_construct(), changed_tile_chunks_since(), limit_history(), and mark_full_update().

◆ history

Vector<Changeset> blender::bke::image::partial_update::PartialUpdateRegisterImpl::history

history of changesets.

Definition at line 356 of file image_partial_update.cc.

Referenced by changed_tile_chunks_since(), commit_current_changeset(), limit_history(), mark_full_update(), and update_resolution().

◆ last_changeset_id

ChangesetID blender::bke::image::partial_update::PartialUpdateRegisterImpl::last_changeset_id

changeset id of the top changeset kept in history.

Definition at line 353 of file image_partial_update.cc.

Referenced by blender::bke::image::partial_update::BKE_image_partial_update_collect_changes(), can_construct(), commit_current_changeset(), and mark_full_update().

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

image_partial_update.cc