Browse Source

Documentation updates for Image classes.

pull/34/head
Vladimír Vondruš 13 years ago
parent
commit
1c928424ae
  1. 15
      src/BufferImage.h
  2. 12
      src/Image.h
  3. 12
      src/ImageReference.h
  4. 8
      src/Trade/ImageData.h

15
src/BufferImage.h

@ -26,7 +26,7 @@
#ifndef MAGNUM_TARGET_GLES2 #ifndef MAGNUM_TARGET_GLES2
/** @file /** @file
* @brief Class Magnum::BufferImage, typedef Magnum::BufferImage1D, Magnum::BufferImage2D, Magnum::BufferImage3D * @brief Class @ref Magnum::BufferImage, typedef @ref Magnum::BufferImage1D, @ref Magnum::BufferImage2D, @ref Magnum::BufferImage3D
*/ */
#endif #endif
@ -41,9 +41,9 @@ namespace Magnum {
/** /**
@brief %Buffer image @brief %Buffer image
Stores image data in GPU memory. Interchangeable with Image, ImageReference or Stores image data in GPU memory. Interchangeable with @ref Image,
Trade::ImageData. @ref ImageReference or @ref Trade::ImageData.
@see BufferImage1D, BufferImage2D, BufferImage3D, Buffer @see @ref BufferImage1D, @ref BufferImage2D, @ref BufferImage3D, @ref Buffer
@requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0. @requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0.
*/ */
template<UnsignedInt dimensions> class MAGNUM_EXPORT BufferImage: public AbstractImage { template<UnsignedInt dimensions> class MAGNUM_EXPORT BufferImage: public AbstractImage {
@ -55,8 +55,8 @@ template<UnsignedInt dimensions> class MAGNUM_EXPORT BufferImage: public Abstrac
* @param format Format of pixel data * @param format Format of pixel data
* @param type Data type of pixel data * @param type Data type of pixel data
* *
* Dimensions and buffer are empty, call setData() to fill the image * Dimensions and buffer are empty, call @ref setData() to fill the
* with data. * image with data.
*/ */
explicit BufferImage(ColorFormat format, ColorType type): AbstractImage(format, type) { explicit BufferImage(ColorFormat format, ColorType type): AbstractImage(format, type) {
_buffer.setTargetHint(Buffer::Target::PixelPack); _buffer.setTargetHint(Buffer::Target::PixelPack);
@ -78,8 +78,7 @@ template<UnsignedInt dimensions> class MAGNUM_EXPORT BufferImage: public Abstrac
* *
* Updates the image buffer with given data. The data are not deleted * Updates the image buffer with given data. The data are not deleted
* after filling the buffer. * after filling the buffer.
* * @see @ref Buffer::setData()
* @see Buffer::setData()
*/ */
void setData(const typename DimensionTraits<Dimensions, Int>::VectorType& size, ColorFormat format, ColorType type, const void* data, BufferUsage usage); void setData(const typename DimensionTraits<Dimensions, Int>::VectorType& size, ColorFormat format, ColorType type, const void* data, BufferUsage usage);

12
src/Image.h

@ -25,7 +25,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Image, typedef Magnum::Image1D, Magnum::Image2D, Magnum::Image3D * @brief Class @ref Magnum::Image, typedef @ref Magnum::Image1D, @ref Magnum::Image2D, @ref Magnum::Image3D
*/ */
#include "ImageReference.h" #include "ImageReference.h"
@ -35,9 +35,9 @@ namespace Magnum {
/** /**
@brief %Image @brief %Image
Stores image data on client memory. Interchangeable with ImageReference, Stores image data on client memory. Interchangeable with @ref ImageReference,
BufferImage or Trade::ImageData. @ref BufferImage or @ref Trade::ImageData.
@see Image1D, Image2D, Image3D @see @ref Image1D, @ref Image2D, @ref Image3D
*/ */
template<UnsignedInt dimensions> class Image: public AbstractImage { template<UnsignedInt dimensions> class Image: public AbstractImage {
public: public:
@ -60,8 +60,8 @@ template<UnsignedInt dimensions> class Image: public AbstractImage {
* @param format Format of pixel data * @param format Format of pixel data
* @param type Data type of pixel data * @param type Data type of pixel data
* *
* Dimensions and data pointer are set to zero, call setData() to fill * Dimensions are set to zero and data pointer to `nullptr`, call
* the image with data. * @ref setData() to fill the image with data.
*/ */
explicit Image(ColorFormat format, ColorType type): AbstractImage(format, type), _data(nullptr) {} explicit Image(ColorFormat format, ColorType type): AbstractImage(format, type), _data(nullptr) {}

12
src/ImageReference.h

@ -25,7 +25,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::ImageReference * @brief Class @ref Magnum::ImageReference, typedef @ref Magnum::ImageReference1D, @ref Magnum::ImageReference2D, @ref Magnum::ImageReference3D
*/ */
#include "Math/Vector3.h" #include "Math/Vector3.h"
@ -40,14 +40,14 @@ namespace Magnum {
Adds information about dimensions, color components and component type to some Adds information about dimensions, color components and component type to some
data in memory. data in memory.
Unlike Image, this class doesn't delete the data on destruction, so it is Unlike @ref Image, this class doesn't delete the data on destruction, so it is
targeted for wrapping data which are either stored in stack/constant memory targeted for wrapping data which are either stored in stack/constant memory
(and shouldn't be deleted) or they are managed by someone else and have the (and shouldn't be deleted) or they are managed by someone else and have the
same properties for each frame, such as video stream. Thus it is not possible same properties for each frame, such as video stream. Thus it is not possible
to change image properties, only data pointer. to change image properties, only data pointer.
Interchangeable with Image, BufferImage or Trade::ImageData. Interchangeable with @ref Image, @ref BufferImage or @ref Trade::ImageData.
@see ImageReference1D, ImageReference2D, ImageReference3D @see @ref ImageReference1D, @ref ImageReference2D, @ref ImageReference3D
*/ */
template<UnsignedInt dimensions> class ImageReference: public AbstractImage { template<UnsignedInt dimensions> class ImageReference: public AbstractImage {
public: public:
@ -68,8 +68,8 @@ template<UnsignedInt dimensions> class ImageReference: public AbstractImage {
* @param type Data type of pixel data * @param type Data type of pixel data
* @param size %Image size * @param size %Image size
* *
* Data pointer is set to zero, call setData() to fill the image with * Data pointer is set to `nullptr`, call @ref setData() to fill the
* data. * image with data.
*/ */
constexpr explicit ImageReference(ColorFormat format, ColorType type, const typename DimensionTraits<Dimensions, Int>::VectorType& size): AbstractImage(format, type), _size(size), _data(nullptr) {} constexpr explicit ImageReference(ColorFormat format, ColorType type, const typename DimensionTraits<Dimensions, Int>::VectorType& size): AbstractImage(format, type), _size(size), _data(nullptr) {}

8
src/Trade/ImageData.h

@ -25,7 +25,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Trade::ImageData * @brief Class @ref Magnum::Trade::ImageData, typedef @ref Magnum::Trade::ImageData1D, @ref Magnum::Trade::ImageData2D, @ref Magnum::Trade::ImageData3D
*/ */
#include "ImageReference.h" #include "ImageReference.h"
@ -35,9 +35,9 @@ namespace Magnum { namespace Trade {
/** /**
@brief %Image data @brief %Image data
Access to image data provided by AbstractImporter subclasses. Interchangeable Access to image data provided by @ref AbstractImporter subclasses.
with Image, ImageReference or BufferImage. Interchangeable with @ref Image, @ref ImageReference or @ref BufferImage.
@see ImageData1D, ImageData2D, ImageData3D @see @ref ImageData1D, @ref ImageData2D, @ref ImageData3D
*/ */
template<UnsignedInt dimensions> class ImageData: public AbstractImage { template<UnsignedInt dimensions> class ImageData: public AbstractImage {
public: public:

Loading…
Cancel
Save