Blender V5.3
opensubdiv_converter_capi.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2015 Blender Foundation
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#include <span>
8#include <utility>
9
11
16constexpr float OPENSUBDIV_SHARPNESS_INFINITE = 10.0f;
17
25 std::span<const std::pair<int, int>> edges;
26 std::span<const int> face_offsets;
27 std::span<const int> corner_verts;
28
36 std::span<const float> edge_sharpness;
37 std::span<const float> vert_sharpness;
38
40
43
44 // Denotes whether this converter specifies full topology, which includes
45 // vertices, edges, faces, vertices+edges of a face and edges/faces of a
46 // vertex.
47 // Otherwise this converter will only provide number of vertices and faces,
48 // and vertices of faces. The rest of topology will be created by OpenSubdiv.
49 //
50 // NOTE: Even if converter does not provide full topology, it still needs
51 // to provide number of edges and vertices-of-edge. Those are used to assign
52 // topology tags.
54
56 // Face relationships.
57
58 // Array of edge indices the face consists of.
59 // Aligned with the vertex indices array, edge i connects face vertex i
60 // with face index i+1.
61 void (*getFaceEdges)(const OpenSubdiv_Converter *converter,
62 const int face_index,
63 int *face_edges);
64
66 // Edge relationships.
67
68 // Number of faces which are sharing the given edge.
69 int (*getNumEdgeFaces)(const OpenSubdiv_Converter *converter, const int edge_index);
70 // Array of face indices which are sharing the given edge.
71 void (*getEdgeFaces)(const OpenSubdiv_Converter *converter, const int edge, int *edge_faces);
72
74 // Vertex relationships.
75
76 // Number of edges which are adjacent to the given vertex.
77 int (*getNumVertexEdges)(const OpenSubdiv_Converter *converter, const int vertex_index);
78 // Array for edge indices which are adjacent to the given vertex.
79 void (*getVertexEdges)(const OpenSubdiv_Converter *converter,
80 const int vertex_index,
81 int *vertex_edges);
82 // Number of faces which are adjacent to the given vertex.
83 int (*getNumVertexFaces)(const OpenSubdiv_Converter *converter, const int vertex_index);
84 // Array for face indices which are adjacent to the given vertex.
85 void (*getVertexFaces)(const OpenSubdiv_Converter *converter,
86 const int vertex_index,
87 int *vertex_faces);
88
90 // UV coordinates.
91
92 // Number of UV layers.
93 int (*getNumUVLayers)(const OpenSubdiv_Converter *converter);
94
95 // We need some corner connectivity information, which might not be trivial
96 // to be gathered (might require multiple matching calculations per corver
97 // query).
98 // precalc() is called before any corner connectivity or UV coordinate is
99 // queried from the given layer, allowing converter to calculate and cache
100 // complex complex-to-calculate information.
101 // finish() is called after converter is done porting UV layer to OpenSubdiv,
102 // allowing to free cached data.
103 void (*precalcUVLayer)(const OpenSubdiv_Converter *converter, const int layer_index);
104 void (*finishUVLayer)(const OpenSubdiv_Converter *converter);
105
106 // Get number of UV coordinates in the current layer (layer which was
107 // specified in precalcUVLayer().
109 // For the given face index and its corner (known as loop in Blender)
110 // get corresponding UV coordinate index.
112 const int face_index,
113 const int corner_index);
114
116 // User data associated with this converter.
117
118 void (*freeUserData)(const OpenSubdiv_Converter *converter);
120};
OpenSubdiv_FVarLinearInterpolation
OpenSubdiv_VtxBoundaryInterpolation
OpenSubdiv_SchemeType
constexpr float OPENSUBDIV_SHARPNESS_INFINITE
void(*) getFaceEdges(const OpenSubdiv_Converter *converter, const int face_index, int *face_edges)
OpenSubdiv_VtxBoundaryInterpolation vtx_boundary_interpolation
std::span< const float > edge_sharpness
OpenSubdiv_FVarLinearInterpolation fvar_linear_interpolation
std::span< const float > vert_sharpness
void(*) getVertexEdges(const OpenSubdiv_Converter *converter, const int vertex_index, int *vertex_edges)
int(*) getNumUVCoordinates(const OpenSubdiv_Converter *converter)
OpenSubdiv_SchemeType scheme_type
void(*) getVertexFaces(const OpenSubdiv_Converter *converter, const int vertex_index, int *vertex_faces)
int(*) getNumVertexFaces(const OpenSubdiv_Converter *converter, const int vertex_index)
std::span< const int > face_offsets
std::span< const std::pair< int, int > > edges
void(*) precalcUVLayer(const OpenSubdiv_Converter *converter, const int layer_index)
void(*) getEdgeFaces(const OpenSubdiv_Converter *converter, const int edge, int *edge_faces)
int(*) getNumVertexEdges(const OpenSubdiv_Converter *converter, const int vertex_index)
int(*) getNumUVLayers(const OpenSubdiv_Converter *converter)
std::span< const int > corner_verts
int(*) getFaceCornerUVIndex(const OpenSubdiv_Converter *converter, const int face_index, const int corner_index)
int(*) getNumEdgeFaces(const OpenSubdiv_Converter *converter, const int edge_index)
bool(*) specifiesFullTopology(const OpenSubdiv_Converter *converter)
void(*) finishUVLayer(const OpenSubdiv_Converter *converter)
void(*) freeUserData(const OpenSubdiv_Converter *converter)