Fix some docs with incorrect or missing variable names
This commit is contained in:
parent
c261124775
commit
8f4b422ece
@ -163,7 +163,7 @@ namespace PolyVox
|
|||||||
/// Increasing the size of the block cache will increase memory but may improve performance.
|
/// Increasing the size of the block cache will increase memory but may improve performance.
|
||||||
/// You may want to set this to a large value (e.g. 1024) when you are first loading your
|
/// You may want to set this to a large value (e.g. 1024) when you are first loading your
|
||||||
/// volume data and then set it to a smaller value (e.g.64) for general processing.
|
/// volume data and then set it to a smaller value (e.g.64) for general processing.
|
||||||
/// \param uBlockCacheSize The number of blocks for which uncompressed data can be cached.
|
/// \param uMaxNumberOfUncompressedBlocks The number of blocks for which uncompressed data can be cached.
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
template <typename VoxelType>
|
template <typename VoxelType>
|
||||||
void LargeVolume<VoxelType>::setMaxNumberOfUncompressedBlocks(uint32_t uMaxNumberOfUncompressedBlocks)
|
void LargeVolume<VoxelType>::setMaxNumberOfUncompressedBlocks(uint32_t uMaxNumberOfUncompressedBlocks)
|
||||||
@ -175,7 +175,7 @@ namespace PolyVox
|
|||||||
|
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
/// Increasing the number of blocks in memory causes fewer calls to dataRequiredHandler()/dataOverflowHandler()
|
/// Increasing the number of blocks in memory causes fewer calls to dataRequiredHandler()/dataOverflowHandler()
|
||||||
/// \param uMaxBlocks The number of blocks
|
/// \param uMaxNumberOfBlocksInMemory The number of blocks
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
template <typename VoxelType>
|
template <typename VoxelType>
|
||||||
void LargeVolume<VoxelType>::setMaxNumberOfBlocksInMemory(uint32_t uMaxNumberOfBlocksInMemory)
|
void LargeVolume<VoxelType>::setMaxNumberOfBlocksInMemory(uint32_t uMaxNumberOfBlocksInMemory)
|
||||||
|
@ -63,7 +63,7 @@ namespace PolyVox
|
|||||||
/**
|
/**
|
||||||
* Set the material value of the voxel
|
* Set the material value of the voxel
|
||||||
*
|
*
|
||||||
* \param uDensity The material to set to
|
* \param uMaterial The material to set to
|
||||||
*/
|
*/
|
||||||
void setMaterial(Type uMaterial) { m_uMaterial = uMaterial; }
|
void setMaterial(Type uMaterial) { m_uMaterial = uMaterial; }
|
||||||
|
|
||||||
|
@ -26,6 +26,7 @@ namespace PolyVox
|
|||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
/// This constructor creates a volume with a fixed size which is specified as a parameter.
|
/// This constructor creates a volume with a fixed size which is specified as a parameter.
|
||||||
/// \param regValid Specifies the minimum and maximum valid voxel positions.
|
/// \param regValid Specifies the minimum and maximum valid voxel positions.
|
||||||
|
/// \param uBlockSideLength The size of the block to use within the volume
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
template <typename VoxelType>
|
template <typename VoxelType>
|
||||||
SimpleVolume<VoxelType>::SimpleVolume
|
SimpleVolume<VoxelType>::SimpleVolume
|
||||||
|
@ -489,7 +489,7 @@ namespace PolyVox
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
\param tX The new value for the Y component of a 2, 3, or 4 dimensional Vector.
|
\param tY The new value for the Y component of a 2, 3, or 4 dimensional Vector.
|
||||||
*/
|
*/
|
||||||
template <uint32_t Size, typename Type>
|
template <uint32_t Size, typename Type>
|
||||||
inline void Vector<Size, Type>::setY(Type tY) throw()
|
inline void Vector<Size, Type>::setY(Type tY) throw()
|
||||||
@ -498,7 +498,7 @@ namespace PolyVox
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
\param tX The new value for the Z component of a 3 or 4 dimensional Vector.
|
\param tZ The new value for the Z component of a 3 or 4 dimensional Vector.
|
||||||
*/
|
*/
|
||||||
template <uint32_t Size, typename Type>
|
template <uint32_t Size, typename Type>
|
||||||
inline void Vector<Size, Type>::setZ(Type tZ) throw()
|
inline void Vector<Size, Type>::setZ(Type tZ) throw()
|
||||||
@ -507,7 +507,7 @@ namespace PolyVox
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
\param tX The new value for the W component of a 4 dimensional Vector.
|
\param tW The new value for the W component of a 4 dimensional Vector.
|
||||||
*/
|
*/
|
||||||
template <uint32_t Size, typename Type>
|
template <uint32_t Size, typename Type>
|
||||||
inline void Vector<Size, Type>::setW(Type tW) throw()
|
inline void Vector<Size, Type>::setW(Type tW) throw()
|
||||||
@ -545,7 +545,7 @@ namespace PolyVox
|
|||||||
|
|
||||||
\note This function does not make much sense on integer Vectors.
|
\note This function does not make much sense on integer Vectors.
|
||||||
|
|
||||||
\param Vector3D The Vector to find the angle to.
|
\param vector The Vector to find the angle to.
|
||||||
\return The angle between them in radians.
|
\return The angle between them in radians.
|
||||||
*/
|
*/
|
||||||
template <uint32_t Size, typename Type>
|
template <uint32_t Size, typename Type>
|
||||||
@ -562,8 +562,7 @@ namespace PolyVox
|
|||||||
right-hand rule such that if the two vectors are given by the index
|
right-hand rule such that if the two vectors are given by the index
|
||||||
finger and middle finger respectively then the cross product is given
|
finger and middle finger respectively then the cross product is given
|
||||||
by the thumb.
|
by the thumb.
|
||||||
\param a first Vector.
|
\param vector The vector to cross with this
|
||||||
\param b Second Vector.
|
|
||||||
\return The value of the cross product.
|
\return The value of the cross product.
|
||||||
\see dot()
|
\see dot()
|
||||||
*/
|
*/
|
||||||
|
Loading…
x
Reference in New Issue
Block a user