From efd487845093b535e69e1fba1a5ddb83b781aa8d Mon Sep 17 00:00:00 2001 From: Daviw Williams Date: Fri, 17 May 2013 16:44:32 +0200 Subject: [PATCH] Updated documentation. --- .../PolyVoxCore/include/PolyVoxCore/BaseVolume.inl | 14 ++++++++++++-- .../include/PolyVoxCore/LargeVolume.inl | 14 ++++++++++++-- .../PolyVoxCore/include/PolyVoxCore/RawVolume.inl | 14 ++++++++++++-- .../include/PolyVoxCore/SimpleVolume.inl | 14 ++++++++++++-- 4 files changed, 48 insertions(+), 8 deletions(-) diff --git a/library/PolyVoxCore/include/PolyVoxCore/BaseVolume.inl b/library/PolyVoxCore/include/PolyVoxCore/BaseVolume.inl index 87dfc1fe..c9fc1fcb 100644 --- a/library/PolyVoxCore/include/PolyVoxCore/BaseVolume.inl +++ b/library/PolyVoxCore/include/PolyVoxCore/BaseVolume.inl @@ -181,6 +181,9 @@ namespace PolyVox /// \param uXPos The \c x position of the voxel /// \param uYPos The \c y position of the voxel /// \param uZPos The \c z position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -192,6 +195,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos The 3D position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -239,7 +245,9 @@ namespace PolyVox /// \param uYPos the \c y position of the voxel /// \param uZPos the \c z position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void BaseVolume::setVoxel(int32_t /*uXPos*/, int32_t /*uYPos*/, int32_t /*uZPos*/, VoxelType /*tValue*/, BoundsCheck /*eBoundsCheck*/) @@ -251,7 +259,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos the 3D position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void BaseVolume::setVoxel(const Vector3DInt32& /*v3dPos*/, VoxelType /*tValue*/, BoundsCheck /*eBoundsCheck*/) diff --git a/library/PolyVoxCore/include/PolyVoxCore/LargeVolume.inl b/library/PolyVoxCore/include/PolyVoxCore/LargeVolume.inl index 9f2c4119..7ecd5192 100644 --- a/library/PolyVoxCore/include/PolyVoxCore/LargeVolume.inl +++ b/library/PolyVoxCore/include/PolyVoxCore/LargeVolume.inl @@ -119,6 +119,9 @@ namespace PolyVox /// \param uXPos The \c x position of the voxel /// \param uYPos The \c y position of the voxel /// \param uZPos The \c z position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -149,6 +152,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos The 3D position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -285,7 +291,9 @@ namespace PolyVox /// \param uYPos the \c y position of the voxel /// \param uZPos the \c z position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void LargeVolume::setVoxel(int32_t uXPos, int32_t uYPos, int32_t uZPos, VoxelType tValue, BoundsCheck eBoundsCheck) @@ -316,7 +324,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos the 3D position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void LargeVolume::setVoxel(const Vector3DInt32& v3dPos, VoxelType tValue, BoundsCheck eBoundsCheck) diff --git a/library/PolyVoxCore/include/PolyVoxCore/RawVolume.inl b/library/PolyVoxCore/include/PolyVoxCore/RawVolume.inl index b7029dcf..42b618a0 100644 --- a/library/PolyVoxCore/include/PolyVoxCore/RawVolume.inl +++ b/library/PolyVoxCore/include/PolyVoxCore/RawVolume.inl @@ -77,6 +77,9 @@ namespace PolyVox /// \param uXPos The \c x position of the voxel /// \param uYPos The \c y position of the voxel /// \param uZPos The \c z position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -108,6 +111,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos The 3D position of the voxel /// \return The voxel value + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template VoxelType RawVolume::getVoxel(const Vector3DInt32& v3dPos, BoundsCheck eBoundsCheck) const @@ -215,7 +221,9 @@ namespace PolyVox /// \param uYPos the \c y position of the voxel /// \param uZPos the \c z position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void RawVolume::setVoxel(int32_t uXPos, int32_t uYPos, int32_t uZPos, VoxelType tValue, BoundsCheck eBoundsCheck) @@ -246,7 +254,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos the 3D position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void RawVolume::setVoxel(const Vector3DInt32& v3dPos, VoxelType tValue, BoundsCheck eBoundsCheck) diff --git a/library/PolyVoxCore/include/PolyVoxCore/SimpleVolume.inl b/library/PolyVoxCore/include/PolyVoxCore/SimpleVolume.inl index 7403dc74..71e8e902 100644 --- a/library/PolyVoxCore/include/PolyVoxCore/SimpleVolume.inl +++ b/library/PolyVoxCore/include/PolyVoxCore/SimpleVolume.inl @@ -77,6 +77,9 @@ namespace PolyVox /// \param uXPos The \c x position of the voxel /// \param uYPos The \c y position of the voxel /// \param uZPos The \c z position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -107,6 +110,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos The 3D position of the voxel + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. /// \return The voxel value //////////////////////////////////////////////////////////////////////////////// template @@ -215,7 +221,9 @@ namespace PolyVox /// \param uYPos the \c y position of the voxel /// \param uZPos the \c z position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void SimpleVolume::setVoxel(int32_t uXPos, int32_t uYPos, int32_t uZPos, VoxelType tValue, BoundsCheck eBoundsCheck) @@ -246,7 +254,9 @@ namespace PolyVox //////////////////////////////////////////////////////////////////////////////// /// \param v3dPos the 3D position of the voxel /// \param tValue the value to which the voxel will be set - /// \return whether the requested position is inside the volume + /// \param eBoundsCheck Controls whether bounds checking is performed on voxel access. It's safest to + /// set this to BoundsChecks::Full (the default), but if you are certain that the voxel you are accessing + /// is inside the volume's enclosing region then you can skip this check to gain some performance. //////////////////////////////////////////////////////////////////////////////// template void SimpleVolume::setVoxel(const Vector3DInt32& v3dPos, VoxelType tValue, BoundsCheck eBoundsCheck)