doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / intern / subdiv_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  * The Original Code is Copyright (C) 2018 by Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __SUBDIV_CONVERTER_H__
21 #define __SUBDIV_CONVERTER_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include "BKE_subdiv.h"
28
29 /* NOTE: Was initially used to get proper enumerator types, but this makes
30  * it tricky to compile without OpenSubdiv. */
31 /* #include "opensubdiv_converter_capi.h" */
32
33 struct Mesh;
34 struct OpenSubdiv_Converter;
35 struct SubdivSettings;
36
37 void BKE_subdiv_converter_init_for_mesh(struct OpenSubdiv_Converter *converter,
38                                         const struct SubdivSettings *settings,
39                                         const struct Mesh *mesh);
40
41 /* NOTE: Frees converter data, but not converter itself. This means, that if
42  * converter was allocated on heap, it is up to the user to free that memory. */
43 void BKE_subdiv_converter_free(struct OpenSubdiv_Converter *converter);
44
45 /* ============================ INTERNAL HELPERS ============================ */
46
47 /* TODO(sergey): Find a way to make it OpenSubdiv_VtxBoundaryInterpolation,
48  * without breaking compilation without OpenSubdiv. */
49 int BKE_subdiv_converter_vtx_boundary_interpolation_from_settings(
50         const SubdivSettings *settings);
51
52 /* TODO(sergey): Find a way to make it OpenSubdiv_FVarLinearInterpolation,
53  * without breaking compilation without OpenSubdiv. */
54 int BKE_subdiv_converter_fvar_linear_from_settings(
55         const SubdivSettings *settings);
56
57 #endif  /* __SUBDIV_CONVERTER_H__ */