diff --git a/include/CDynamicMeshBuffer.h b/include/CDynamicMeshBuffer.h index c0ee356f..3989b3e4 100644 --- a/include/CDynamicMeshBuffer.h +++ b/include/CDynamicMeshBuffer.h @@ -14,7 +14,7 @@ namespace irr { namespace scene { - + //! Implementation of the IMeshBuffer interface for which can work with 16 and 32 bit indices as well as different vertex types class CDynamicMeshBuffer: public IDynamicMeshBuffer { public: diff --git a/include/CMeshBuffer.h b/include/CMeshBuffer.h index 22b1c9e1..ca48c163 100644 --- a/include/CMeshBuffer.h +++ b/include/CMeshBuffer.h @@ -12,7 +12,7 @@ namespace irr { namespace scene { - //! Template implementation of the IMeshBuffer interface + //! Template implementation of the IMeshBuffer interface for 16-bit buffers template class CMeshBuffer : public IMeshBuffer { diff --git a/include/EMeshBufferTypes.h b/include/EMeshBufferTypes.h index c9d5fc3f..8a30240e 100644 --- a/include/EMeshBufferTypes.h +++ b/include/EMeshBufferTypes.h @@ -16,16 +16,16 @@ namespace scene of simple numbers (easier to add external classes). */ enum EMESH_BUFFER_TYPE { - //! SMeshBuffer + //! SMeshBuffer (16 bit buffers) EMBT_STANDARD = MAKE_IRR_ID('s','t','a','n'), - //! SMeshBufferLightMap + //! SMeshBufferLightMap (16 bit buffers) EMBT_LIGHTMAP = MAKE_IRR_ID('l','i','g','h'), - //! SMeshBufferTangents + //! SMeshBufferTangents (16 bit buffers) EMBT_TANGENTS = MAKE_IRR_ID('t','a','n','g'), - //! CDynamicMeshBuffer + //! CDynamicMeshBuffer (16 or 32 bit buffers) EMBT_DYNAMIC = MAKE_IRR_ID('d','y','n','a'), // SSharedMeshBuffer diff --git a/include/IMeshBuffer.h b/include/IMeshBuffer.h index 5b43ffce..eff92dc4 100644 --- a/include/IMeshBuffer.h +++ b/include/IMeshBuffer.h @@ -72,11 +72,17 @@ namespace scene virtual video::E_INDEX_TYPE getIndexType() const =0; //! Get access to indices. - /** \return Pointer to indices array. */ + /** Note: For historical reasons data pointer is of type u16*, but + for an index type of EIT_32BIT the index data is using an u32 array + and therefore needs a cast to u32*. + \return Pointer to indices array. */ virtual const u16* getIndices() const = 0; //! Get access to indices. - /** \return Pointer to indices array. */ + /** Note: For historical reasons data pointer is of type u16*, but + for an index type of EIT_32BIT the index data is using an u32 array + and therefore needs a cast to u32*. + \return Pointer to indices array. */ virtual u16* getIndices() = 0; //! Get amount of indices in this meshbuffer.