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