0d42f63433f5e60cae5bc005c1f6c4a7de2a8078
[blender-staging.git] / source / blender / depsgraph / intern / eval / deg_eval.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/eval/deg_eval.cc
28  *  \ingroup depsgraph
29  *
30  * Evaluation engine entrypoints for Depsgraph Engine.
31  */
32
33 #pragma once
34
35 struct EvaluationContext;
36
37 namespace DEG {
38
39 struct Depsgraph;
40
41 /**
42  * Evaluate all nodes tagged for updating,
43  * \warning This is usually done as part of main loop, but may also be
44  * called from frame-change update.
45  *
46  * \note Time sources should be all valid!
47  */
48 void deg_evaluate_on_refresh(EvaluationContext *eval_ctx,
49                              Depsgraph *graph,
50                              const int layers);
51
52 }  // namespace DEG