From e2befa425a84c9e4ec715442e85624a5d3669a4f Mon Sep 17 00:00:00 2001 From: Falk David Date: Thu, 10 Feb 2022 11:34:12 +0100 Subject: GPencil: Update-on-write using update cache This implements the update cache described in T95401. The cache is currently only used for drawing strokes and sculpting (using the push brush). **Note: Making use of the cache throughout grease pencil will have to be done incrementally in other patches. ** The update cache stores what elements have changed in the original data-block since the last time the eval object was updated. Additionally, the update cache can store multiple updates to the data and minimizes the number of elements that need to be copied. Elements can be tagged using `BKE_gpencil_tag_full_update` and `BKE_gpencil_tag_light_update`. A full update means that the element itself will be copied but also all of the content inside. E.g. when a layer is tagged for a full update, the layer, all the frames inside the layer and all the strokes inside the frames will be copied. A light update means that only the properties of the element are copied without any of the content. E.g. if a layer is tagged with a light update, it will copy the layer name, opacity, transform, etc. When the update cache is in use (e.g. elements have been tagged) then the depsgraph will not trigger a copy-on-write, but an update-on-write. This means that the update cache will be used to determine what elements have changed and then only those elements will be copied over to the eval object. If the update cache is empty or the data block was tagged with a full update, we always fall back to a copy-on-write. Currently, the update cache is only used by the active depsgraph. This is because we need to free the update cache after an update-on-write so it's reset and we need to make sure it is not freed or read by other depsgraphs. Co-authored-by: @yann-lty This patch was contributed by The SPA Studios. Reviewed By: sergey, antoniov, #dependency_graph, pepeland, mendio Maniphest Tasks: T95401 Differential Revision: https://developer.blender.org/D13984 --- .../intern/eval/deg_eval_runtime_backup_gpencil.cc | 59 ++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 source/blender/depsgraph/intern/eval/deg_eval_runtime_backup_gpencil.cc (limited to 'source/blender/depsgraph/intern/eval/deg_eval_runtime_backup_gpencil.cc') diff --git a/source/blender/depsgraph/intern/eval/deg_eval_runtime_backup_gpencil.cc b/source/blender/depsgraph/intern/eval/deg_eval_runtime_backup_gpencil.cc new file mode 100644 index 00000000000..63d1eb9f711 --- /dev/null +++ b/source/blender/depsgraph/intern/eval/deg_eval_runtime_backup_gpencil.cc @@ -0,0 +1,59 @@ +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * The Original Code is Copyright (C) 2022 Blender Foundation. + * All rights reserved. + */ + +/** \file + * \ingroup depsgraph + */ + +#include "intern/eval/deg_eval_runtime_backup_gpencil.h" +#include "intern/depsgraph.h" + +#include "BKE_gpencil.h" +#include "BKE_gpencil_update_cache.h" + +#include "DNA_gpencil_types.h" + +namespace blender::deg { + +GPencilBackup::GPencilBackup(const Depsgraph *depsgraph) : depsgraph(depsgraph) +{ +} + +void GPencilBackup::init_from_gpencil(bGPdata *UNUSED(gpd)) +{ +} + +void GPencilBackup::restore_to_gpencil(bGPdata *gpd) +{ + bGPdata *gpd_orig = reinterpret_cast(gpd->id.orig_id); + + /* We check for the active depsgraph here to avoid freeing the cache on the original object + * multiple times. This free is only needed for the case where we tagged a full update in the + * update cache and did not do an update-on-write. */ + if (depsgraph->is_active) { + BKE_gpencil_free_update_cache(gpd_orig); + } + /* Doing a copy-on-write copies the update cache pointer. Make sure to reset it + * to NULL as we should never use the update cache from eval data. */ + gpd->runtime.update_cache = NULL; + /* Make sure to update the original runtime pointers in the eval data. */ + BKE_gpencil_data_update_orig_pointers(gpd_orig, gpd); +} + +} // namespace blender::deg -- cgit v1.2.3