blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult Struct Reference

#include <BKE_image_partial_update.hh>

Public Member Functions
	CollectResult (PartialUpdateChecker< TileData > *checker, ePartialUpdateCollectResult result_code)
const ePartialUpdateCollectResult	get_result_code () const
ePartialUpdateIterResult	get_next_change ()
	Load the next changed region.

Public Attributes
PartialUpdateChecker< TileData > *	checker
TileData	tile_data
	Tile specific data.
PartialUpdateRegion	changed_region
ePartialUpdateCollectResult	result_code

Detailed Description

template<typename TileData = NoTileData>
struct blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult

Definition at line 205 of file BKE_image_partial_update.hh.

Constructor & Destructor Documentation

CollectResult()

template<typename TileData = NoTileData>

blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::CollectResult ( PartialUpdateChecker< TileData > * checker, ePartialUpdateCollectResult result_code )

inline

Definition at line 219 of file BKE_image_partial_update.hh.

Member Function Documentation

get_next_change()

template<typename TileData = NoTileData>

ePartialUpdateIterResult blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_next_change ( )

inline

Load the next changed region.

This member function can only be called when partial changes are detected. (get_result_code() returns ePartialUpdateCollectResult::PartialChangesDetected).

When changes for another tile than the previous tile is loaded the tile_data will be updated.

Definition at line 240 of file BKE_image_partial_update.hh.

References blender::bke::image::partial_update::BKE_image_partial_update_get_next_change(), BLI_assert, BLI_assert_unreachable, blender::bke::image::partial_update::ChangeAvailable, blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::changed_region, blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::checker, blender::bke::image::partial_update::Finished, blender::bke::image::partial_update::PartialChangesDetected, result, blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::result_code, blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::tile_data, blender::bke::image::partial_update::PartialUpdateRegion::tile_number, and blender::bke::image::partial_update::PartialUpdateChecker< TileData >::user.

get_result_code()

template<typename TileData = NoTileData>

const ePartialUpdateCollectResult blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_result_code ( ) const

inline

Definition at line 226 of file BKE_image_partial_update.hh.

References blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::result_code.

Member Data Documentation

changed_region

template<typename TileData = NoTileData>

PartialUpdateRegion blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::changed_region

Definition at line 212 of file BKE_image_partial_update.hh.

Referenced by blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_next_change().

checker

template<typename TileData = NoTileData>

PartialUpdateChecker<TileData>* blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::checker

Definition at line 206 of file BKE_image_partial_update.hh.

Referenced by blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_next_change().

result_code

template<typename TileData = NoTileData>

ePartialUpdateCollectResult blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::result_code

Definition at line 213 of file BKE_image_partial_update.hh.

Referenced by blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_next_change(), and blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_result_code().

tile_data

template<typename TileData = NoTileData>

TileData blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::tile_data

Tile specific data.

Definition at line 211 of file BKE_image_partial_update.hh.

Referenced by blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult::get_next_change().

---

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

• BKE_image_partial_update.hh