image_partial_updater.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2021 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BKE_image.hh"
#include "BKE_image_partial_update.hh"
 
struct PartialImageUpdater {
  PartialUpdateUser *user;
  const Image *image;
 
  void ensure_image(const Image *new_image)
  {
    if (!is_valid(new_image)) {
      free();
      create(new_image);
    }
  }
 
  virtual ~PartialImageUpdater()
  {
    free();
  }
 
 private:
  bool is_valid(const Image *new_image) const
  {
    if (image != new_image) {
      return false;
    }
 
    return user != nullptr;
  }
 
  void create(const Image *new_image)
  {
    BLI_assert(user == nullptr);
    user = BKE_image_partial_update_create(new_image);
    image = new_image;
  }
 
  void free()
  {
    if (user != nullptr) {
      BKE_image_partial_update_free(user);
      user = nullptr;
      image = nullptr;
    }
  }
};