GPencil: Add parameter removed by error in previous commit
[blender.git] / source / blender / compositor / intern / COM_Converter.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * Copyright 2011, Blender Foundation.
17  */
18
19 #pragma once
20
21 #include "COM_NodeOperation.h"
22
23 #ifdef WITH_CXX_GUARDEDALLOC
24 #  include "MEM_guardedalloc.h"
25 #endif
26
27 struct bNode;
28
29 namespace blender::compositor {
30
31 class Node;
32 class NodeOperationInput;
33 class NodeOperationOutput;
34 class NodeOperationBuilder;
35
36 /**
37  * \brief Wraps a bNode in its Node instance.
38  *
39  * For all nodetypes a wrapper class is created.
40  *
41  * \note When adding a new node to blender, this method needs to be changed to return the correct
42  * Node instance.
43  *
44  * \see Node
45  */
46 Node *COM_convert_bnode(bNode *b_node);
47
48 /**
49  * \brief True if the node is considered 'fast'.
50  *
51  * Slow nodes will be skipped if fast execution is required.
52  */
53 bool COM_bnode_is_fast_node(const bNode &b_node);
54
55 /**
56  * \brief This function will add a datetype conversion rule when the to-socket does not support the
57  * from-socket actual data type.
58  */
59 NodeOperation *COM_convert_data_type(const NodeOperationOutput &from,
60                                      const NodeOperationInput &to);
61
62 /**
63  * \brief This function will add a resolution rule based on the settings of the NodeInput.
64  *
65  * \note Conversion logic is implemented in this function.
66  * \see InputSocketResizeMode for the possible conversions.
67  */
68 void COM_convert_resolution(NodeOperationBuilder &builder,
69                             NodeOperationOutput *fromSocket,
70                             NodeOperationInput *toSocket);
71
72 }  // namespace blender::compositor