Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / mikktspace / mikktspace.h
1 /** \file \ingroup mikktspace
2  */
3 /**
4  *  Copyright (C) 2011 by Morten S. Mikkelsen
5  *
6  *  This software is provided 'as-is', without any express or implied
7  *  warranty.  In no event will the authors be held liable for any damages
8  *  arising from the use of this software.
9  *
10  *  Permission is granted to anyone to use this software for any purpose,
11  *  including commercial applications, and to alter it and redistribute it
12  *  freely, subject to the following restrictions:
13  *
14  *  1. The origin of this software must not be misrepresented; you must not
15  *     claim that you wrote the original software. If you use this software
16  *     in a product, an acknowledgment in the product documentation would be
17  *     appreciated but is not required.
18  *  2. Altered source versions must be plainly marked as such, and must not be
19  *     misrepresented as being the original software.
20  *  3. This notice may not be removed or altered from any source distribution.
21  */
22
23 #ifndef __MIKKTSPACE_H__
24 #define __MIKKTSPACE_H__
25
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /* Author: Morten S. Mikkelsen
32  * Version: 1.0
33  *
34  * The files mikktspace.h and mikktspace.c are designed to be
35  * stand-alone files and it is important that they are kept this way.
36  * Not having dependencies on structures/classes/libraries specific
37  * to the program, in which they are used, allows them to be copied
38  * and used as is into any tool, program or plugin.
39  * The code is designed to consistently generate the same
40  * tangent spaces, for a given mesh, in any tool in which it is used.
41  * This is done by performing an internal welding step and subsequently an order-independent evaluation
42  * of tangent space for meshes consisting of triangles and quads.
43  * This means faces can be received in any order and the same is true for
44  * the order of vertices of each face. The generated result will not be affected
45  * by such reordering. Additionally, whether degenerate (vertices or texture coordinates)
46  * primitives are present or not will not affect the generated results either.
47  * Once tangent space calculation is done the vertices of degenerate primitives will simply
48  * inherit tangent space from neighboring non degenerate primitives.
49  * The analysis behind this implementation can be found in my master's thesis
50  * which is available for download --> http://image.diku.dk/projects/media/morten.mikkelsen.08.pdf
51  * Note that though the tangent spaces at the vertices are generated in an order-independent way,
52  * by this implementation, the interpolated tangent space is still affected by which diagonal is
53  * chosen to split each quad. A sensible solution is to have your tools pipeline always
54  * split quads by the shortest diagonal. This choice is order-independent and works with mirroring.
55  * If these have the same length then compare the diagonals defined by the texture coordinates.
56  * XNormal which is a tool for baking normal maps allows you to write your own tangent space plugin
57  * and also quad triangulator plugin.
58  */
59
60
61 typedef int tbool;
62 typedef struct SMikkTSpaceContext SMikkTSpaceContext;
63
64 typedef struct {
65         // Returns the number of faces (triangles/quads) on the mesh to be processed.
66         int (*m_getNumFaces)(const SMikkTSpaceContext * pContext);
67
68         // Returns the number of vertices on face number iFace
69         // iFace is a number in the range {0, 1, ..., getNumFaces()-1}
70         int (*m_getNumVerticesOfFace)(const SMikkTSpaceContext * pContext, const int iFace);
71
72         // returns the position/normal/texcoord of the referenced face of vertex number iVert.
73         // iVert is in the range {0,1,2} for triangles and {0,1,2,3} for quads.
74         void (*m_getPosition)(const SMikkTSpaceContext * pContext, float fvPosOut[], const int iFace, const int iVert);
75         void (*m_getNormal)(const SMikkTSpaceContext * pContext, float fvNormOut[], const int iFace, const int iVert);
76         void (*m_getTexCoord)(const SMikkTSpaceContext * pContext, float fvTexcOut[], const int iFace, const int iVert);
77
78         // either (or both) of the two setTSpace callbacks can be set.
79         // The call-back m_setTSpaceBasic() is sufficient for basic normal mapping.
80
81         // This function is used to return the tangent and fSign to the application.
82         // fvTangent is a unit length vector.
83         // For normal maps it is sufficient to use the following simplified version of the bitangent which is generated at pixel/vertex level.
84         // bitangent = fSign * cross(vN, tangent);
85         // Note that the results are returned unindexed. It is possible to generate a new index list
86         // But averaging/overwriting tangent spaces by using an already existing index list WILL produce INCRORRECT results.
87         // DO NOT! use an already existing index list.
88         void (*m_setTSpaceBasic)(const SMikkTSpaceContext * pContext, const float fvTangent[], const float fSign, const int iFace, const int iVert);
89
90         // This function is used to return tangent space results to the application.
91         // fvTangent and fvBiTangent are unit length vectors and fMagS and fMagT are their
92         // true magnitudes which can be used for relief mapping effects.
93         // fvBiTangent is the "real" bitangent and thus may not be perpendicular to fvTangent.
94         // However, both are perpendicular to the vertex normal.
95         // For normal maps it is sufficient to use the following simplified version of the bitangent which is generated at pixel/vertex level.
96         // fSign = bIsOrientationPreserving ? 1.0f : (-1.0f);
97         // bitangent = fSign * cross(vN, tangent);
98         // Note that the results are returned unindexed. It is possible to generate a new index list
99         // But averaging/overwriting tangent spaces by using an already existing index list WILL produce INCRORRECT results.
100         // DO NOT! use an already existing index list.
101         void (*m_setTSpace)(const SMikkTSpaceContext * pContext, const float fvTangent[], const float fvBiTangent[], const float fMagS, const float fMagT,
102                                                 const tbool bIsOrientationPreserving, const int iFace, const int iVert);
103 } SMikkTSpaceInterface;
104
105 struct SMikkTSpaceContext
106 {
107         SMikkTSpaceInterface * m_pInterface;    // initialized with callback functions
108         void * m_pUserData;                                             // pointer to client side mesh data etc. (passed as the first parameter with every interface call)
109 };
110
111 // these are both thread safe!
112 tbool genTangSpaceDefault(const SMikkTSpaceContext * pContext); // Default (recommended) fAngularThreshold is 180 degrees (which means threshold disabled)
113 tbool genTangSpace(const SMikkTSpaceContext * pContext, const float fAngularThreshold);
114
115
116 // To avoid visual errors (distortions/unwanted hard edges in lighting), when using sampled normal maps, the
117 // normal map sampler must use the exact inverse of the pixel shader transformation.
118 // The most efficient transformation we can possibly do in the pixel shader is
119 // achieved by using, directly, the "unnormalized" interpolated tangent, bitangent and vertex normal: vT, vB and vN.
120 // pixel shader (fast transform out)
121 // vNout = normalize( vNt.x * vT + vNt.y * vB + vNt.z * vN );
122 // where vNt is the tangent space normal. The normal map sampler must likewise use the
123 // interpolated and "unnormalized" tangent, bitangent and vertex normal to be compliant with the pixel shader.
124 // sampler does (exact inverse of pixel shader):
125 // float3 row0 = cross(vB, vN);
126 // float3 row1 = cross(vN, vT);
127 // float3 row2 = cross(vT, vB);
128 // float fSign = dot(vT, row0)<0 ? -1 : 1;
129 // vNt = normalize( fSign * float3(dot(vNout,row0), dot(vNout,row1), dot(vNout,row2)) );
130 // where vNout is the sampled normal in some chosen 3D space.
131 //
132 // Should you choose to reconstruct the bitangent in the pixel shader instead
133 // of the vertex shader, as explained earlier, then be sure to do this in the normal map sampler also.
134 // Finally, beware of quad triangulations. If the normal map sampler doesn't use the same triangulation of
135 // quads as your renderer then problems will occur since the interpolated tangent spaces will differ
136 // eventhough the vertex level tangent spaces match. This can be solved either by triangulating before
137 // sampling/exporting or by using the order-independent choice of diagonal for splitting quads suggested earlier.
138 // However, this must be used both by the sampler and your tools/rendering pipeline.
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif