// ======================================================================== // // Copyright 2009-2015 Intel Corporation // // // // Licensed under the Apache License, Version 2.0 (the "License"); // // you may not use this file except in compliance with the License. // // You may obtain a copy of the License at // // // // http://www.apache.org/licenses/LICENSE-2.0 // // // // Unless required by applicable law or agreed to in writing, software // // distributed under the License is distributed on an "AS IS" BASIS, // // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // // See the License for the specific language governing permissions and // // limitations under the License. // // ======================================================================== // #ifndef __RTCORE_GEOMETRY_H__ #define __RTCORE_GEOMETRY_H__ /*! \ingroup embree_kernel_api */ /*! \{ */ /*! invalid geometry ID */ #define RTC_INVALID_GEOMETRY_ID ((unsigned)-1) /*! \brief Specifies the type of buffers when mapping buffers */ enum RTCBufferType { RTC_INDEX_BUFFER = 0x01000000, RTC_VERTEX_BUFFER = 0x02000000, RTC_VERTEX_BUFFER0 = 0x02000000, RTC_VERTEX_BUFFER1 = 0x02000001, RTC_USER_VERTEX_BUFFER = 0x02100000, RTC_USER_VERTEX_BUFFER0 = 0x02100000, RTC_USER_VERTEX_BUFFER1 = 0x02100001, RTC_FACE_BUFFER = 0x03000000, RTC_LEVEL_BUFFER = 0x04000001, RTC_EDGE_CREASE_INDEX_BUFFER = 0x05000000, RTC_EDGE_CREASE_WEIGHT_BUFFER = 0x06000000, RTC_VERTEX_CREASE_INDEX_BUFFER = 0x07000000, RTC_VERTEX_CREASE_WEIGHT_BUFFER = 0x08000000, RTC_HOLE_BUFFER = 0x09000001, }; /*! \brief Supported types of matrix layout for functions involving matrices */ enum RTCMatrixType { RTC_MATRIX_ROW_MAJOR = 0, RTC_MATRIX_COLUMN_MAJOR = 1, RTC_MATRIX_COLUMN_MAJOR_ALIGNED16 = 2, }; /*! \brief Supported geometry flags to specify handling in dynamic scenes. */ enum RTCGeometryFlags { RTC_GEOMETRY_STATIC = 0, //!< specifies static geometry that will change rarely RTC_GEOMETRY_DEFORMABLE = 1, //!< specifies dynamic geometry with deformable motion (BVH refit possible) RTC_GEOMETRY_DYNAMIC = 2, //!< specifies dynamic geometry with arbitrary motion (BVH refit not possible) }; /*! \brief Boundary interpolation mode for subdivision surfaces */ enum RTCBoundaryMode { RTC_BOUNDARY_NONE = 0, //!< ignores border patches RTC_BOUNDARY_EDGE_ONLY = 1, //!< soft boundary (default) RTC_BOUNDARY_EDGE_AND_CORNER = 2 //!< boundary corner vertices are sharp vertices }; /*! Intersection filter function for single rays. */ typedef void (*RTCFilterFunc)(void* ptr, /*!< pointer to user data */ RTCRay& ray /*!< intersection to filter */); /*! Intersection filter function for ray packets of size 4. */ typedef void (*RTCFilterFunc4)(const void* valid, /*!< pointer to valid mask */ void* ptr, /*!< pointer to user data */ RTCRay4& ray /*!< intersection to filter */); /*! Intersection filter function for ray packets of size 8. */ typedef void (*RTCFilterFunc8)(const void* valid, /*!< pointer to valid mask */ void* ptr, /*!< pointer to user data */ RTCRay8& ray /*!< intersection to filter */); /*! Intersection filter function for ray packets of size 16. */ typedef void (*RTCFilterFunc16)(const void* valid, /*!< pointer to valid mask */ void* ptr, /*!< pointer to user data */ RTCRay16& ray /*!< intersection to filter */); /*! Displacement mapping function. */ typedef void (*RTCDisplacementFunc)(void* ptr, /*!< pointer to user data of geometry */ unsigned geomID, /*!< ID of geometry to displace */ unsigned primID, /*!< ID of primitive of geometry to displace */ const float* u, /*!< u coordinates (source) */ const float* v, /*!< v coordinates (source) */ const float* nx, /*!< x coordinates of normalized normal at point to displace (source) */ const float* ny, /*!< y coordinates of normalized normal at point to displace (source) */ const float* nz, /*!< z coordinates of normalized normal at point to displace (source) */ float* px, /*!< x coordinates of points to displace (source and target) */ float* py, /*!< y coordinates of points to displace (source and target) */ float* pz, /*!< z coordinates of points to displace (source and target) */ size_t N /*!< number of points to displace */ ); /*! \brief Creates a new scene instance. A scene instance contains a reference to a scene to instantiate and the transformation to instantiate the scene with. An implementation will typically transform the ray with the inverse of the provided transformation and continue traversing the ray through the provided scene. If any geometry is hit, the instance ID (instID) member of the ray will get set to the geometry ID of the instance. */ RTCORE_API unsigned rtcNewInstance (RTCScene target, //!< the scene the instance belongs to RTCScene source //!< the scene to instantiate ); /*! \brief Creates a new scene instance. A scene instance contains a reference to a scene to instantiate and the transformation to instantiate the scene with. For motion blurred instances, a number of timesteps can get specified (currently only 1 or 2 timesteps are supported). An implementation will typically transform the ray with the inverse of the provided transformation and continue traversing the ray through the provided scene. If any geometry is hit, the instance ID (instID) member of the ray will get set to the geometry ID of the instance. */ RTCORE_API unsigned rtcNewInstance2 (RTCScene target, //!< the scene the instance belongs to RTCScene source, //!< the scene to instantiate size_t numTimeSteps = 1); //!< number of timesteps, one matrix per timestep /*! \brief Sets transformation of the instance */ RTCORE_API void rtcSetTransform (RTCScene scene, //!< scene handle unsigned geomID, //!< ID of geometry RTCMatrixType layout, //!< layout of transformation matrix const float* xfm //!< pointer to transformation matrix ); /*! \brief Sets transformation of the instance for specified timestep */ RTCORE_API void rtcSetTransform2 (RTCScene scene, //!< scene handle unsigned int geomID, //!< ID of geometry RTCMatrixType layout, //!< layout of transformation matrix const float* xfm, //!< pointer to transformation matrix size_t timeStep = 0 //!< timestep to set the matrix for ); /*! \brief Creates a new triangle mesh. The number of triangles (numTriangles), number of vertices (numVertices), and number of time steps (1 for normal meshes, and 2 for linear motion blur), have to get specified. The triangle indices can be set be mapping and writing to the index buffer (RTC_INDEX_BUFFER) and the triangle vertices can be set by mapping and writing into the vertex buffer (RTC_VERTEX_BUFFER). In case of linear motion blur, two vertex buffers have to get filled (RTC_VERTEX_BUFFER0, RTC_VERTEX_BUFFER1), one for each time step. The index buffer has the default layout of three 32 bit integer indices for each triangle. An index points to the ith vertex. The vertex buffer stores single precision x,y,z floating point coordinates aligned to 16 bytes. The value of the 4th float used for alignment can be arbitrary. */ RTCORE_API unsigned rtcNewTriangleMesh (RTCScene scene, //!< the scene the mesh belongs to RTCGeometryFlags flags, //!< geometry flags size_t numTriangles, //!< number of triangles size_t numVertices, //!< number of vertices size_t numTimeSteps = 1 //!< number of motion blur time steps ); /*! \brief Creates a new quad mesh. The number of quads (numQuads), number of vertices (numVertices), and number of time steps (1 for normal meshes, and 2 for linear motion blur), have to get specified. The quad indices can be set be mapping and writing to the index buffer (RTC_INDEX_BUFFER) and the quad vertices can be set by mapping and writing into the vertex buffer (RTC_VERTEX_BUFFER). In case of linear motion blur, two vertex buffers have to get filled (RTC_VERTEX_BUFFER0, RTC_VERTEX_BUFFER1), one for each time step. The index buffer has the default layout of three 32 bit integer indices for each quad. An index points to the ith vertex. The vertex buffer stores single precision x,y,z floating point coordinates aligned to 16 bytes. The value of the 4th float used for alignment can be arbitrary. */ RTCORE_API unsigned rtcNewQuadMesh (RTCScene scene, //!< the scene the mesh belongs to RTCGeometryFlags flags, //!< geometry flags size_t numQuads, //!< number of quads size_t numVertices, //!< number of vertices size_t numTimeSteps = 1 //!< number of motion blur time steps ); /*! \brief Creates a new subdivision mesh. The number of faces (numFaces), edges/indices (numEdges), vertices (numVertices), edge creases (numEdgeCreases), vertex creases (numVertexCreases), holes (numHoles), and time steps (numTimeSteps) have to get speficied at construction time. The following buffers have to get filled by the application: the face buffer (RTC_FACE_BUFFER) contains the number edges/indices (3 or 4) of each of the numFaces faces, the index buffer (RTC_INDEX_BUFFER) contains multiple (3 or 4) 32bit vertex indices for each face and numEdges indices in total, the vertex buffer (RTC_VERTEX_BUFFER) stores numVertices vertices as single precision x,y,z floating point coordinates aligned to 16 bytes. The value of the 4th float used for alignment can be arbitrary. Optionally, the application can fill the hole buffer (RTC_HOLE_BUFFER) with numHoles many 32 bit indices of faces that should be considered non-existing. Optionally, the application can fill the level buffer (RTC_LEVEL_BUFFER) with a tessellation level for each of the numEdges edges. The subdivision level is a positive floating point value, that specifies how many quads along the edge should get generated during tessellation. The tessellation level is a lower bound, thus the implementation is free to choose a larger level. If no level buffer is specified a level of 1 is used. Optionally, the application can fill the sparse edge crease buffers to make some edges appear sharper. The edge crease index buffer (RTC_EDGE_CREASE_INDEX_BUFFER) contains numEdgeCreases many pairs of 32 bit vertex indices that specify unoriented edges. The edge crease weight buffer (RTC_EDGE_CREASE_WEIGHT_BUFFER) stores for each of theses crease edges a positive floating point weight. The larger this weight, the sharper the edge. Specifying a weight of infinify is supported and marks an edge as infinitely sharp. Storing an edge multiple times with the same crease weight is allowed, but has lower performance. Storing the an edge multiple times with different crease weights results in undefined behaviour. For a stored edge (i,j), the reverse direction edges (j,i) does not have to get stored, as both are considered the same edge. Optionally, the application can fill the sparse vertex crease buffers to make some vertices appear sharper. The vertex crease index buffer (RTC_VERTEX_CREASE_INDEX_BUFFER), contains numVertexCreases many 32 bit vertex indices to speficy a set of vertices. The vertex crease weight buffer (RTC_VERTEX_CREASE_WEIGHT_BUFFER) specifies for each of these vertices a positive floating point weight. The larger this weight, the sharper the vertex. Specifying a weight of infinity is supported and makes the vertex infinitely sharp. Storing a vertex multiple times with the same crease weight is allowed, but has lower performance. Storing a vertex multiple times with different crease weights results in undefined behaviour. */ RTCORE_API unsigned rtcNewSubdivisionMesh (RTCScene scene, //!< the scene the mesh belongs to RTCGeometryFlags flags, //!< geometry flags size_t numFaces, //!< number of faces size_t numEdges, //!< number of edges size_t numVertices, //!< number of vertices size_t numEdgeCreases, //!< number of edge creases size_t numVertexCreases, //!< number of vertex creases size_t numHoles, //!< number of holes size_t numTimeSteps = 1 //!< number of motion blur time steps ); /*! \brief Creates a new hair geometry, consisting of multiple hairs represented as cubic bezier curves with varying radii. The number of curves (numCurves), number of vertices (numVertices), and number of time steps (1 for normal curves, and 2 for linear motion blur), have to get specified at construction time. Further, the curve index buffer (RTC_INDEX_BUFFER) and the curve vertex buffer (RTC_VERTEX_BUFFER) have to get set by mapping and writing to the appropiate buffers. In case of linear motion blur, two vertex buffers have to get filled (RTC_VERTEX_BUFFER0, RTC_VERTEX_BUFFER1), one for each time step. The index buffer has the default layout of a single 32 bit integer index for each curve, that references the start vertex of the curve. The vertex buffer stores 4 control points per curve, each such control point consists of a single precision (x,y,z) position and radius, stored in that order in memory. Individual hairs are considered to be subpixel sized which allows the implementation to approximate the intersection calculation. This in particular means that zooming onto one hair might show geometric artefacts. */ RTCORE_API unsigned rtcNewHairGeometry (RTCScene scene, //!< the scene the curves belong to RTCGeometryFlags flags, //!< geometry flags size_t numCurves, //!< number of curves size_t numVertices, //!< number of vertices size_t numTimeSteps = 1 //!< number of motion blur time steps ); /*! Sets a uniform tessellation rate for subdiv meshes and hair * geometry. For subdivision meshes the RTC_LEVEL_BUFFER can also be used * optionally to set a different tessellation rate per edge.*/ RTCORE_API void rtcSetTessellationRate (RTCScene scene, unsigned geomID, float tessellationRate); /*! \brief Creates a new line segment geometry, consisting of multiple segments with varying radii. The number of line segments (numSegments), number of vertices (numVertices), and number of time steps (1 for normal line segments, and 2 for linear motion blur), have to get specified at construction time. Further, the segment index buffer (RTC_INDEX_BUFFER) and the segment vertex buffer (RTC_VERTEX_BUFFER) have to get set by mapping and writing to the appropiate buffers. In case of linear motion blur, two vertex buffers have to get filled (RTC_VERTEX_BUFFER0, RTC_VERTEX_BUFFER1), one for each time step. The index buffer has the default layout of a single 32 bit integer index for each line segment, that references the start vertex of the segment. The vertex buffer stores 2 end points per line segment, each such point consists of a single precision (x,y,z) position and radius, stored in that order in memory. Individual segments are considered to be subpixel sized which allows the implementation to approximate the intersection calculation. This in particular means that zooming onto one line segment might show geometric artefacts. */ RTCORE_API unsigned rtcNewLineSegments (RTCScene scene, //!< the scene the line segments belong to RTCGeometryFlags flags, //!< geometry flags size_t numSegments, //!< number of line segments size_t numVertices, //!< number of vertices size_t numTimeSteps = 1 //!< number of motion blur time steps ); /*! \brief Sets 32 bit ray mask. */ RTCORE_API void rtcSetMask (RTCScene scene, unsigned geomID, int mask); /*! \brief Sets boundary interpolation mode for subdivision surfaces */ RTCORE_API void rtcSetBoundaryMode(RTCScene scene, unsigned geomID, RTCBoundaryMode mode); /*! \brief Maps specified buffer. This function can be used to set index and * vertex buffers of geometries. */ RTCORE_API void* rtcMapBuffer(RTCScene scene, unsigned geomID, RTCBufferType type); /*! \brief Unmaps specified buffer. A buffer has to be unmapped before the rtcEnable, rtcDisable, rtcUpdate, or rtcDeleteGeometry calls are executed. */ RTCORE_API void rtcUnmapBuffer(RTCScene scene, unsigned geomID, RTCBufferType type); /*! \brief Shares a data buffer between the application and * Embree. The passed buffer is used by Embree to store index and * vertex data. It has to remain valid as long as the mesh exists, * and the user is responsible to free the data when the mesh gets * deleted. One can optionally speficy a byte offset and byte stride * of the elements stored inside the buffer. The addresses * ptr+offset+i*stride have to be aligned to 4 bytes on Xeon CPUs and * 16 bytes on Xeon Phi accelerators. For vertex buffers, the 4 bytes * after the z-coordinate of the last vertex have to be readable memory, * thus padding is required for some layouts. If this function is not * called, Embree will allocate and manage buffers of the default * layout. */ RTCORE_API void rtcSetBuffer(RTCScene scene, unsigned geomID, RTCBufferType type, const void* ptr, size_t byteOffset, size_t byteStride); /*! \brief Enable geometry. Enabled geometry can be hit by a ray. */ RTCORE_API void rtcEnable (RTCScene scene, unsigned geomID); /*! \brief Update all geometry buffers. Each time geometry buffers got modified, the user has to call some update function to tell the ray tracing engine which buffers got modified. The rtcUpdate function taggs each geometry buffer of the specified geometry as modified. */ RTCORE_API void rtcUpdate (RTCScene scene, unsigned geomID); /*! \brief Update spefific geometry buffer. Each time geometry buffers got modified, the user has to call some update function to tell the ray tracing engine which buffers got modified. The rtcUpdateBuffer function taggs a specific buffer of some geometry as modified. */ RTCORE_API void rtcUpdateBuffer (RTCScene scene, unsigned geomID, RTCBufferType type); /*! \brief Disable geometry. Disabled geometry is not hit by any ray. Disabling and enabling geometry gives higher performance than deleting and recreating geometry. */ RTCORE_API void rtcDisable (RTCScene scene, unsigned geomID); /*! \brief Sets the displacement function. */ RTCORE_API void rtcSetDisplacementFunction (RTCScene scene, unsigned geomID, RTCDisplacementFunc func, RTCBounds* bounds); /*! \brief Sets the intersection filter function for single rays. */ RTCORE_API void rtcSetIntersectionFilterFunction (RTCScene scene, unsigned geomID, RTCFilterFunc func); /*! \brief Sets the intersection filter function for ray packets of size 4. */ RTCORE_API void rtcSetIntersectionFilterFunction4 (RTCScene scene, unsigned geomID, RTCFilterFunc4 func); /*! \brief Sets the intersection filter function for ray packets of size 8. */ RTCORE_API void rtcSetIntersectionFilterFunction8 (RTCScene scene, unsigned geomID, RTCFilterFunc8 func); /*! \brief Sets the intersection filter function for ray packets of size 16. */ RTCORE_API void rtcSetIntersectionFilterFunction16 (RTCScene scene, unsigned geomID, RTCFilterFunc16 func); /*! \brief Sets the occlusion filter function for single rays. */ RTCORE_API void rtcSetOcclusionFilterFunction (RTCScene scene, unsigned geomID, RTCFilterFunc func); /*! \brief Sets the occlusion filter function for ray packets of size 4. */ RTCORE_API void rtcSetOcclusionFilterFunction4 (RTCScene scene, unsigned geomID, RTCFilterFunc4 func); /*! \brief Sets the occlusion filter function for ray packets of size 8. */ RTCORE_API void rtcSetOcclusionFilterFunction8 (RTCScene scene, unsigned geomID, RTCFilterFunc8 func); /*! \brief Sets the occlusion filter function for ray packets of size 16. */ RTCORE_API void rtcSetOcclusionFilterFunction16 (RTCScene scene, unsigned geomID, RTCFilterFunc16 func); /*! Set pointer for user defined data per geometry. Invokations * of the various user intersect and occluded functions get passed * this data pointer when called. */ RTCORE_API void rtcSetUserData (RTCScene scene, unsigned geomID, void* ptr); /*! Get pointer for user defined data per geometry based on geomID. */ RTCORE_API void* rtcGetUserData (RTCScene scene, unsigned geomID); /*! Interpolates user data to some u/v location. The data buffer * specifies per vertex data to interpolate and can be one of the * RTC_VERTEX_BUFFER0/1 or RTC_USER_VERTEX_BUFFER0/1 and has to * contain numFloats floating point values to interpolate for each * vertex of the geometry. The dP array will get filled with the * interpolated data and the dPdu and dPdv arrays with the u and v * derivative of the interpolation. If the pointers dP is NULL, the * value will not get calculated. If dPdu and dPdv are NULL the * derivatives will not get calculated. Both dPdu and dPdv have to be * either valid or NULL. The buffer has to be padded at the end such * that the last element can be read safely using SSE * instructions. */ RTCORE_API void rtcInterpolate(RTCScene scene, unsigned geomID, unsigned primID, float u, float v, RTCBufferType buffer, float* P, float* dPdu, float* dPdv, size_t numFloats); /*! Interpolates user data to some u/v location. The data buffer * specifies per vertex data to interpolate and can be one of the * RTC_VERTEX_BUFFER0/1 or RTC_USER_VERTEX_BUFFER0/1 and has to * contain numFloats floating point values to interpolate for each * vertex of the geometry. The P array will get filled with the * interpolated datam the dPdu and dPdv arrays with the u and v * derivative of the interpolation, and the ddPdudu, ddPdvdv, and * ddPdudv arrays with the respective second derivatives. One can * disable 1) the calculation of the interpolated value by setting P * to NULL, 2) the calculation of the 1st order derivatives by * setting dPdu and dPdv to NULL, 3) the calculation of the second * order derivatives by setting ddPdudu, ddPdvdv, and ddPdudv to * NULL. The buffers have to be padded at the end such that the last * element can be read or written safely using SSE instructions. */ RTCORE_API void rtcInterpolate2(RTCScene scene, unsigned geomID, unsigned primID, float u, float v, RTCBufferType buffer, float* P, float* dPdu, float* dPdv, float* ddPdudu, float* ddPdvdv, float* ddPdudv, size_t numFloats); /*! Interpolates user data to an array of u/v locations. The valid * pointer points to an integer array that specified which entries in * the u/v arrays are valid (-1 denotes valid, and 0 invalid). If the * valid pointer is NULL all elements are considers valid. The data * buffer specifies per vertex data to interpolate and can be one of * the RTC_VERTEX_BUFFER0/1 or RTC_USER_VERTEX_BUFFER0/1 and has to * contain numFloats floating point values to interpolate for each * vertex of the geometry. The P array will get filled with the * interpolated data, and the dPdu and dPdv arrays with the u and v * derivative of the interpolation. If the pointers P is NULL, the * value will not get calculated. If dPdu and dPdv are NULL the * derivatives will not get calculated. Both dPdu and dPdv have to be * either valid or NULL. These destination arrays are filled in * structure of array (SoA) layout. The buffer has to be padded at * the end such that the last element can be read safely using SSE * instructions.*/ RTCORE_API void rtcInterpolateN(RTCScene scene, unsigned geomID, const void* valid, const unsigned* primIDs, const float* u, const float* v, size_t numUVs, RTCBufferType buffer, float* P, float* dPdu, float* dPdv, size_t numFloats); /*! Interpolates user data to an array of u/v locations. The valid * pointer points to an integer array that specified which entries in * the u/v arrays are valid (-1 denotes valid, and 0 invalid). If the * valid pointer is NULL all elements are considers valid. The data * buffer specifies per vertex data to interpolate and can be one of * the RTC_VERTEX_BUFFER0/1 or RTC_USER_VERTEX_BUFFER0/1 and has to * contain numFloats floating point values to interpolate for each * vertex of the geometry. The P array will get filled with the * interpolated datam the dPdu and dPdv arrays with the u and v * derivative of the interpolation, and the ddPdudu, ddPdvdv, and * ddPdudv arrays with the respective second derivatives. One can * disable 1) the calculation of the interpolated value by setting P * to NULL, 2) the calculation of the 1st order derivatives by * setting dPdu and dPdv to NULL, 3) the calculation of the second * order derivatives by setting ddPdudu, ddPdvdv, and ddPdudv to * NULL. These destination arrays are filled in structure of array * (SoA) layout. The buffer has to be padded at the end such that * the last element can be read safely using SSE * instructions. */ RTCORE_API void rtcInterpolateN2(RTCScene scene, unsigned geomID, const void* valid, const unsigned* primIDs, const float* u, const float* v, size_t numUVs, RTCBufferType buffer, float* P, float* dPdu, float* dPdv, float* ddPdudu, float* ddPdvdv, float* ddPdudv, size_t numFloats); /*! \brief Deletes the geometry. */ RTCORE_API void rtcDeleteGeometry (RTCScene scene, unsigned geomID); /*! @} */ #endif