AuroraMiddleware/OpenSubdiv
1
0
Fork 0
mirror of https://github.com/PixarAnimationStudios/OpenSubdiv synced 2025-01-11 09:00:08 +00:00
Code Issues Releases Wiki Activity

Fix undesirable doxygen annotations in osd.

Browse Source
This commit is contained in:
Takahito Tejima 2015-06-18 18:11:23 -07:00
parent ccf2690416
commit 8b7e55b6f5
4 changed files with 73 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
opensubdiv/osd/bufferDescriptor.h
View File

@ -43,20 +43,21 @@ namespace Osd {
///
/// * Note that each element has the same data type (float)
///
/// example:
/// n
/// -----+----------------------------------------+-------------------------
/// | vertex 0 |
/// -----+----------------------------------------+-------------------------
/// | X Y Z R G B A Xu Yu Zu Xv Yv Zv |
/// -----+----------------------------------------+-------------------------
/// <------------- stride = 13 -------------->
///
/// - XYZ (offset = n+0, length = 3, stride = 13)
/// - RGBA (offset = n+3, length = 4, stride = 13)
/// - uTangent (offset = n+7, length = 3, stride = 13)
/// - vTangent (offset = n+10, length = 3, stride = 13)
///
// example:
// n
// -----+----------------------------------------+-------------------------
// | vertex 0 |
// -----+----------------------------------------+-------------------------
// | X Y Z R G B A Xu Yu Zu Xv Yv Zv |
// -----+----------------------------------------+-------------------------
// <------------- stride = 13 -------------->
//
// - XYZ (offset = n+0, length = 3, stride = 13)
// - RGBA (offset = n+3, length = 4, stride = 13)
// - uTangent (offset = n+7, length = 3, stride = 13)
// - vTangent (offset = n+10, length = 3, stride = 13)
//
struct BufferDescriptor {
/// Default Constructor
@ -93,9 +94,12 @@ struct BufferDescriptor {
return !(this->operator==(other));
}
int offset; // offset to desired element data
int length; // number or length of the data
int stride; // stride to the next element
/// offset to desired element data
int offset;
/// number or length of the data
int length;
/// stride to the next element
int stride;
};
} // end namespace Osd

28
opensubdiv/osd/clEvaluator.h
View File

@ -133,14 +133,14 @@ public:
/// transparently from OsdMesh template interface.
///
/// @param srcBuffer Input primvar buffer.
/// must have BindCLBuffer() method returning a
/// const float pointer for read
/// must have BindCLBuffer() method returning the
/// cl_mem object for read
///
/// @param srcDesc vertex buffer descriptor for the input buffer
///
/// @param dstBuffer Output primvar buffer
/// must have BindCLBuffer() method returning a
/// float pointer for write
/// must have BindCLBuffer() method returning the
/// cl_mem object for results to be written
///
/// @param dstDesc vertex buffer descriptor for the output buffer
///
@ -193,17 +193,29 @@ public:
/// transparently from OsdMesh template interface.
///
/// @param srcBuffer Input primvar buffer.
/// must have BindCLBuffer() method returning a
/// const float pointer for read
/// must have BindCLBuffer() method returning the
/// cl_mem object for read
///
/// @param srcDesc vertex buffer descriptor for the input buffer
///
/// @param dstBuffer Output primvar buffer
/// must have BindCLBuffer() method returning a
/// float pointer for write
/// must have BindCLBuffer() method returning the
/// cl_mem object for results to be written
///
/// @param dstDesc vertex buffer descriptor for the output buffer
///
/// @param duBuffer Output U-derivative buffer
/// must have BindCLBuffer() method returning the
/// cl_mem object for du results to be written
///
/// @param duDesc vertex buffer descriptor for the du output buffer
///
/// @param dvBuffer Output V-derivative buffer
/// must have BindCLBuffer() method returning the
/// cl_mem object for dv results to be written
///
/// @param dvDesc vertex buffer descriptor for the dv output buffer
///
/// @param stencilTable stencil table to be applied. The table must have
/// SSBO interfaces.
///

44
opensubdiv/osd/glXFBEvaluator.h
View File

@ -193,12 +193,14 @@ public:
/// must have BindVBO() method returning a
/// float pointer for write
///
/// @param duDesc vertex buffer descriptor for the output buffer
/// @param duDesc vertex buffer descriptor for the du output buffer
///
/// @param dvBuffer Output V-derivative buffer
/// must have BindVBO() method returning a
/// float pointer for write
///
/// @param dvDesc vertex buffer descriptor for the dv output buffer
///
/// @param stencilTable stencil table to be applied. The table must have
/// Texture Buffer Object interfaces.
///
@ -293,6 +295,14 @@ public:
///
/// @param dstDesc vertex buffer descriptor for the output buffer
///
/// @param duBuffer GL buffer of output U-derivatives.
///
/// @param duDesc vertex buffer descriptor for the duBuffer
///
/// @param dvBuffer GL buffer of output V-derivatives.
///
/// @param dvDesc vertex buffer descriptor for the dvBuffer
///
/// @param stencilTable stencil table to be applied.
///
template <typename SRC_BUFFER, typename DST_BUFFER, typename STENCIL_TABLE>
@ -320,33 +330,37 @@ public:
/// \brief dispatch eval stencils function with derivatives.
/// dispatch the GLSL XFB kernel on on GPU asynchronously.
///
/// @param srcBuffer GL buffer of input primvars.
/// @param srcBuffer GL buffer of input primvars.
///
/// @param srcDesc vertex buffer descriptor for the srcBuffer
/// @param srcDesc vertex buffer descriptor for the srcBuffer
///
/// @param dstBuffer GL buffer of output primvars.
/// @param dstBuffer GL buffer of output primvars.
///
/// @param dstDesc vertex buffer descriptor for the dstBuffer
/// @param dstDesc vertex buffer descriptor for the dstBuffer
///
/// @param duBuffer GL buffer of output U-derivatives.
/// @param duBuffer GL buffer of output U-derivatives.
///
/// @param duDesc vertex buffer descriptor for the duBuffer
/// @param duDesc vertex buffer descriptor for the duBuffer
///
/// @param dvBuffer GL buffer of output V-derivatives.
/// @param dvBuffer GL buffer of output V-derivatives.
///
/// @param dvDesc vertex buffer descriptor for the dvBuffer
/// @param dvDesc vertex buffer descriptor for the dvBuffer
///
/// @param sizesBuffer GL buffer of the sizes in the stencil table
/// @param sizesBuffer GL buffer of the sizes in the stencil table
///
/// @param offsetsBuffer GL buffer of the offsets in the stencil table
/// @param offsetsBuffer GL buffer of the offsets in the stencil table
///
/// @param indicesBuffer GL buffer of the indices in the stencil table
/// @param indicesBuffer GL buffer of the indices in the stencil table
///
/// @param weightsBuffer GL buffer of the weifgrs in the stencil table
/// @param weightsBuffer GL buffer of the weights in the stencil table
///
/// @param start start index of stencil table
/// @param duWeightsBuffer GL buffer of the du weights in the stencil table
///
/// @param end end index of stencil table
/// @param dvWeightsBuffer GL buffer of the dv weights in the stencil table
///
/// @param start start index of stencil table
///
/// @param end end index of stencil table
///
bool EvalStencils(GLuint srcBuffer, BufferDescriptor const &srcDesc,
GLuint dstBuffer, BufferDescriptor const &dstDesc,

3
opensubdiv/osd/mesh.h
View File

@ -233,6 +233,7 @@ private:
Evaluators _evaluators;
};
/// @cond INTERNAL
// template helpers to see if the evaluator is instantiatable or not.
template <typename EVALUATOR>
@ -249,6 +250,8 @@ struct enable_if { typedef T type; };
template <typename T>
struct enable_if<false, T> { };
/// @endcond
// extract a kernel from cache if available
template <typename EVALUATOR, typename DEVICE_CONTEXT>
static EVALUATOR *GetEvaluator(