From cecc1dc2bc885d5705e2d37ec2fcd5792dad82de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 29 Jun 2013 01:55:31 +0200 Subject: [PATCH] Renamed ImageWrapper to ImageReference. Better reflect what the class is actually about. --- src/AbstractImage.h | 2 +- src/BufferImage.h | 2 +- src/CMakeLists.txt | 2 +- src/CubeMapTexture.h | 4 ++-- src/CubeMapTextureArray.h | 6 +++--- src/Image.h | 2 +- src/ImageFormat.h | 4 ++-- src/{ImageWrapper.h => ImageReference.h} | 22 +++++++++++----------- src/Magnum.h | 8 ++++---- src/Texture.h | 4 ++-- src/Trade/ImageData.h | 2 +- 11 files changed, 29 insertions(+), 29 deletions(-) rename src/{ImageWrapper.h => ImageReference.h} (80%) diff --git a/src/AbstractImage.h b/src/AbstractImage.h index 304c3613c..412ee4179 100644 --- a/src/AbstractImage.h +++ b/src/AbstractImage.h @@ -38,7 +38,7 @@ namespace Magnum { /** @brief Non-templated base for one-, two- or three-dimensional images -See Image, ImageWrapper, BufferImage, Trade::ImageData documentation for +See Image, ImageReference, BufferImage, Trade::ImageData documentation for more information. @todo Where to put glClampColor() and glPixelStore() encapsulation? It is needed in AbstractFramebuffer::read(), Texture::setImage() etc (i.e. all diff --git a/src/BufferImage.h b/src/BufferImage.h index d49462817..24dfc3a6e 100644 --- a/src/BufferImage.h +++ b/src/BufferImage.h @@ -41,7 +41,7 @@ namespace Magnum { /** @brief %Buffer image -Stores image data in GPU memory. Interchangeable with Image, ImageWrapper or +Stores image data in GPU memory. Interchangeable with Image, ImageReference or Trade::ImageData. @see BufferImage1D, BufferImage2D, BufferImage3D, Buffer @requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0. diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 029e0e754..60ce0ab96 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -113,7 +113,7 @@ set(Magnum_HEADERS Framebuffer.h Image.h ImageFormat.h - ImageWrapper.h + ImageReference.h Magnum.h Mesh.h OpenGL.h diff --git a/src/CubeMapTexture.h b/src/CubeMapTexture.h index b9f99ba88..724b71088 100644 --- a/src/CubeMapTexture.h +++ b/src/CubeMapTexture.h @@ -165,7 +165,7 @@ class CubeMapTexture: public AbstractTexture { * @param coordinate Coordinate * @param level Mip level * @param internalFormat Internal format - * @param image Image, ImageWrapper, BufferImage or + * @param image Image, ImageReference, BufferImage or * Trade::ImageData of the same dimension count * @return Pointer to self (for method chaining) * @@ -181,7 +181,7 @@ class CubeMapTexture: public AbstractTexture { * @param coordinate Coordinate * @param level Mip level * @param offset Offset where to put data in the texture - * @param image Image, ImageWrapper, BufferImage or + * @param image Image, ImageReference, BufferImage or * Trade::ImageData of the same or one less dimension count * @return Pointer to self (for method chaining) * diff --git a/src/CubeMapTextureArray.h b/src/CubeMapTextureArray.h index e4e443a2d..4d0676888 100644 --- a/src/CubeMapTextureArray.h +++ b/src/CubeMapTextureArray.h @@ -165,7 +165,7 @@ class CubeMapTextureArray: public AbstractTexture { * @brief Set image data * @param level Mip level * @param internalFormat Internal format - * @param image Image, ImageWrapper, BufferImage or + * @param image Image, ImageReference, BufferImage or * Trade::ImageData of the same dimension count * @return Pointer to self (for method chaining) * @@ -184,7 +184,7 @@ class CubeMapTextureArray: public AbstractTexture { * @brief Set texture image 3D subdata * @param level Mip level * @param offset Offset where to put data in the texture - * @param image Image3D, ImageWrapper3D, BufferImage3D or + * @param image Image3D, ImageReference3D, BufferImage3D or * Trade::ImageData3D * @return Pointer to self (for method chaining) * @@ -210,7 +210,7 @@ class CubeMapTextureArray: public AbstractTexture { * @param coordinate Coordinate * @param level Mip level * @param offset Offset where to put data in the texture - * @param image Image2D, ImageWrapper2D, BufferImage2D or + * @param image Image2D, ImageReference2D, BufferImage2D or * Trade::ImageData2D * @return Pointer to self (for method chaining) * diff --git a/src/Image.h b/src/Image.h index 6f854adce..42efbb6ee 100644 --- a/src/Image.h +++ b/src/Image.h @@ -37,7 +37,7 @@ namespace Magnum { /** @brief %Image -Stores image data on client memory. Interchangeable with ImageWrapper, +Stores image data on client memory. Interchangeable with ImageReference, BufferImage or Trade::ImageData. @see Image1D, Image2D, Image3D */ diff --git a/src/ImageFormat.h b/src/ImageFormat.h index 2a358eca7..308f1f023 100644 --- a/src/ImageFormat.h +++ b/src/ImageFormat.h @@ -40,7 +40,7 @@ namespace Magnum { Note that some formats can be used only for framebuffer reading (using AbstractFramebuffer::read()) and some only for texture data (using Texture::setImage() and others). -@see Image, ImageWrapper, BufferImage, Trade::ImageData +@see Image, ImageReference, BufferImage, Trade::ImageData */ enum class ImageFormat: GLenum { /** @@ -254,7 +254,7 @@ enum class ImageFormat: GLenum { Note that some formats can be used only for framebuffer reading (using AbstractFramebuffer::read()) and some only for texture data (using Texture::setImage() and others). -@see Image, ImageWrapper, BufferImage, Trade::ImageData +@see Image, ImageReference, BufferImage, Trade::ImageData */ enum class ImageType: GLenum { /** Each component unsigned byte. */ diff --git a/src/ImageWrapper.h b/src/ImageReference.h similarity index 80% rename from src/ImageWrapper.h rename to src/ImageReference.h index 0050a2d63..f42498793 100644 --- a/src/ImageWrapper.h +++ b/src/ImageReference.h @@ -1,5 +1,5 @@ -#ifndef Magnum_ImageWrapper_h -#define Magnum_ImageWrapper_h +#ifndef Magnum_ImageReference_h +#define Magnum_ImageReference_h /* This file is part of Magnum. @@ -25,7 +25,7 @@ */ /** @file - * @brief Class Magnum::ImageWrapper + * @brief Class Magnum::ImageReference */ #include "Math/Vector3.h" @@ -35,7 +35,7 @@ namespace Magnum { /** -@brief %Image wrapper +@brief %Image reference Adds information about dimensions, color components and component type to some data in memory. @@ -47,9 +47,9 @@ same properties for each frame, such as video stream. Thus it is not possible to change image properties, only data pointer. Interchangeable with Image, BufferImage or Trade::ImageData. -@see ImageWrapper1D, ImageWrapper2D, ImageWrapper3D +@see ImageReference1D, ImageReference2D, ImageReference3D */ -template class ImageWrapper: public AbstractImage { +template class ImageReference: public AbstractImage { public: const static UnsignedInt Dimensions = dimensions; /**< @brief %Image dimension count */ @@ -63,7 +63,7 @@ template class ImageWrapper: public AbstractImage { * Note that the image data are not copied on construction, but they * are deleted on class destruction. */ - constexpr explicit ImageWrapper(const typename DimensionTraits::VectorType& size, ImageFormat format, ImageType type, void* data): AbstractImage(format, type), _size(size), _data(reinterpret_cast(data)) {} + constexpr explicit ImageReference(const typename DimensionTraits::VectorType& size, ImageFormat format, ImageType type, void* data): AbstractImage(format, type), _size(size), _data(reinterpret_cast(data)) {} /** * @brief Constructor @@ -74,7 +74,7 @@ template class ImageWrapper: public AbstractImage { * Data pointer is set to zero, call setData() to fill the image with * data. */ - constexpr explicit ImageWrapper(const typename DimensionTraits::VectorType& size, ImageFormat format, ImageType type): AbstractImage(format, type), _size(size), _data(nullptr) {} + constexpr explicit ImageReference(const typename DimensionTraits::VectorType& size, ImageFormat format, ImageType type): AbstractImage(format, type), _size(size), _data(nullptr) {} /** @brief %Image size */ constexpr typename DimensionTraits::VectorType size() const { return _size; } @@ -101,13 +101,13 @@ template class ImageWrapper: public AbstractImage { }; /** @brief One-dimensional image wrapper */ -typedef ImageWrapper<1> ImageWrapper1D; +typedef ImageReference<1> ImageReference1D; /** @brief Two-dimensional image wrapper */ -typedef ImageWrapper<2> ImageWrapper2D; +typedef ImageReference<2> ImageReference2D; /** @brief Three-dimensional image wrapper */ -typedef ImageWrapper<3> ImageWrapper3D; +typedef ImageReference<3> ImageReference3D; } diff --git a/src/Magnum.h b/src/Magnum.h index e1e0e58e6..53475bb91 100644 --- a/src/Magnum.h +++ b/src/Magnum.h @@ -378,10 +378,10 @@ typedef Image<3> Image3D; enum class ImageFormat: GLenum; enum class ImageType: GLenum; -template class ImageWrapper; -typedef ImageWrapper<1> ImageWrapper1D; -typedef ImageWrapper<2> ImageWrapper2D; -typedef ImageWrapper<3> ImageWrapper3D; +template class ImageReference; +typedef ImageReference<1> ImageReference1D; +typedef ImageReference<2> ImageReference2D; +typedef ImageReference<3> ImageReference3D; class Mesh; diff --git a/src/Texture.h b/src/Texture.h index 9cd269e5f..8dd306f2f 100644 --- a/src/Texture.h +++ b/src/Texture.h @@ -346,7 +346,7 @@ template class Texture: public AbstractTexture { * @brief Set image data * @param level Mip level * @param internalFormat Internal format - * @param image Image, ImageWrapper, BufferImage or + * @param image Image, ImageReference, BufferImage or * Trade::ImageData of the same dimension count * @return Pointer to self (for method chaining) * @@ -373,7 +373,7 @@ template class Texture: public AbstractTexture { * @brief Set image subdata * @param level Mip level * @param offset Offset where to put data in the texture - * @param image Image, ImageWrapper, BufferImage or + * @param image Image, ImageReference, BufferImage or * Trade::ImageData of the same or one less dimension count * @return Pointer to self (for method chaining) * diff --git a/src/Trade/ImageData.h b/src/Trade/ImageData.h index 7e56c1359..f0eec7c30 100644 --- a/src/Trade/ImageData.h +++ b/src/Trade/ImageData.h @@ -38,7 +38,7 @@ namespace Magnum { namespace Trade { @brief %Image data Access to image data provided by AbstractImporter subclasses. Interchangeable -with Image, ImageWrapper or BufferImage. +with Image, ImageReference or BufferImage. @see ImageData1D, ImageData2D, ImageData3D */ template class ImageData: public AbstractImage {