BKE_image_partial_update.hh File Reference

#include "BLI_utildefines.h"
#include "BLI_rect.h"
#include "DNA_image_types.h"

Go to the source code of this file.

Classes
struct	blender::bke::image::partial_update::PartialUpdateRegion
	A region to update. More...
class	blender::bke::image::partial_update::AbstractTileData
	Abstract class to load tile data when using the PartialUpdateChecker. More...
class	blender::bke::image::partial_update::NoTileData
	Class to not load any tile specific data when iterating over changes. More...
class	blender::bke::image::partial_update::ImageTileData
	Load the ImageTile and ImBuf associated with the partial change. More...
struct	blender::bke::image::partial_update::PartialUpdateChecker< TileData >
struct	blender::bke::image::partial_update::PartialUpdateChecker< TileData >::CollectResult

Namespaces
	blender
	blender::bke
	blender::bke::image
	blender::bke::image::partial_update

Typedefs
using	blender::bke::image::TileNumber = int

Enumerations
enum class	blender::bke::image::partial_update::ePartialUpdateCollectResult { blender::bke::image::partial_update::FullUpdateNeeded , blender::bke::image::partial_update::NoChangesDetected , blender::bke::image::partial_update::PartialChangesDetected }
	Result codes of #BKE_image_partial_update_collect_changes. More...
enum class	blender::bke::image::partial_update::ePartialUpdateIterResult { blender::bke::image::partial_update::Finished = 0 , blender::bke::image::partial_update::ChangeAvailable = 1 }
	Return codes of #BKE_image_partial_update_get_next_change. More...

Functions
ePartialUpdateCollectResult	blender::bke::image::partial_update::BKE_image_partial_update_collect_changes (struct Image *image, struct PartialUpdateUser *user)
	collect the partial update since the last request. More...
ePartialUpdateIterResult	blender::bke::image::partial_update::BKE_image_partial_update_get_next_change (struct PartialUpdateUser *user, struct PartialUpdateRegion *r_region)

Detailed Description

To reduce the overhead of image processing this file contains a mechanism to detect areas of the image that are changed. These areas are organized in chunks. Changes that happen over time are organized in changesets.

A common use case is to update GPUTexture for drawing where only that part is uploaded that only changed.

Definition in file BKE_image_partial_update.hh.