Browse Source

Renamed ImageWrapper to ImageReference.

Better reflect what the class is actually about.
pull/278/head
Vladimír Vondruš 13 years ago
parent
commit
cecc1dc2bc
  1. 2
      src/AbstractImage.h
  2. 2
      src/BufferImage.h
  3. 2
      src/CMakeLists.txt
  4. 4
      src/CubeMapTexture.h
  5. 6
      src/CubeMapTextureArray.h
  6. 2
      src/Image.h
  7. 4
      src/ImageFormat.h
  8. 22
      src/ImageReference.h
  9. 8
      src/Magnum.h
  10. 4
      src/Texture.h
  11. 2
      src/Trade/ImageData.h

2
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

2
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.

2
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

4
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)
*

6
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)
*

2
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
*/

4
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. */

22
src/ImageWrapper.h → 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<UnsignedInt dimensions> class ImageWrapper: public AbstractImage {
template<UnsignedInt dimensions> class ImageReference: public AbstractImage {
public:
const static UnsignedInt Dimensions = dimensions; /**< @brief %Image dimension count */
@ -63,7 +63,7 @@ template<UnsignedInt dimensions> 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<Dimensions, Int>::VectorType& size, ImageFormat format, ImageType type, void* data): AbstractImage(format, type), _size(size), _data(reinterpret_cast<unsigned char*>(data)) {}
constexpr explicit ImageReference(const typename DimensionTraits<Dimensions, Int>::VectorType& size, ImageFormat format, ImageType type, void* data): AbstractImage(format, type), _size(size), _data(reinterpret_cast<unsigned char*>(data)) {}
/**
* @brief Constructor
@ -74,7 +74,7 @@ template<UnsignedInt dimensions> class ImageWrapper: public AbstractImage {
* Data pointer is set to zero, call setData() to fill the image with
* data.
*/
constexpr explicit ImageWrapper(const typename DimensionTraits<Dimensions, Int>::VectorType& size, ImageFormat format, ImageType type): AbstractImage(format, type), _size(size), _data(nullptr) {}
constexpr explicit ImageReference(const typename DimensionTraits<Dimensions, Int>::VectorType& size, ImageFormat format, ImageType type): AbstractImage(format, type), _size(size), _data(nullptr) {}
/** @brief %Image size */
constexpr typename DimensionTraits<Dimensions, Int>::VectorType size() const { return _size; }
@ -101,13 +101,13 @@ template<UnsignedInt dimensions> 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;
}

8
src/Magnum.h

@ -378,10 +378,10 @@ typedef Image<3> Image3D;
enum class ImageFormat: GLenum;
enum class ImageType: GLenum;
template<UnsignedInt> class ImageWrapper;
typedef ImageWrapper<1> ImageWrapper1D;
typedef ImageWrapper<2> ImageWrapper2D;
typedef ImageWrapper<3> ImageWrapper3D;
template<UnsignedInt> class ImageReference;
typedef ImageReference<1> ImageReference1D;
typedef ImageReference<2> ImageReference2D;
typedef ImageReference<3> ImageReference3D;
class Mesh;

4
src/Texture.h

@ -346,7 +346,7 @@ template<UnsignedInt dimensions> 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<UnsignedInt dimensions> 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)
*

2
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<UnsignedInt dimensions> class ImageData: public AbstractImage {

Loading…
Cancel
Save