From 998bb58ca5373b3d21413d7f3e45d95800672926 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 12 Feb 2015 22:02:55 +0100 Subject: [PATCH] Doc++ --- src/Magnum/CubeMapTexture.h | 6 ++++++ src/Magnum/Texture.h | 4 ++++ src/Magnum/TextureArray.h | 4 ++++ 3 files changed, 14 insertions(+) diff --git a/src/Magnum/CubeMapTexture.h b/src/Magnum/CubeMapTexture.h index 8d2ac0cb7..4ba014ba3 100644 --- a/src/Magnum/CubeMapTexture.h +++ b/src/Magnum/CubeMapTexture.h @@ -389,6 +389,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * @fn_gl{GetTextureImage} * @requires_gl45 Extension @extension{ARB,direct_state_access} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Int level, Image3D& image); @@ -407,6 +408,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * See @ref image(Int, Image3D&) for more information. * @requires_gl45 Extension @extension{ARB,direct_state_access} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Int level, BufferImage3D& image, BufferUsage usage); @@ -444,6 +446,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * @fn_gl_extension{GetTextureImage,EXT,direct_state_access}, * eventually @fn_gl{GetTexImage} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Coordinate coordinate, Int level, Image2D& image); @@ -461,6 +464,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * * See @ref image(Coordinate, Int, Image2D&) for more information. * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Coordinate coordinate, Int level, BufferImage2D& image, BufferUsage usage); @@ -480,6 +484,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * for more information. * @requires_gl45 Extension @extension{ARB,get_texture_sub_image} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void subImage(Int level, const Range3Di& range, Image3D& image) { AbstractTexture::subImage<3>(level, range, image); @@ -501,6 +506,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture { * for more information. * @requires_gl45 Extension @extension{ARB,get_texture_sub_image} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void subImage(Int level, const Range3Di& range, BufferImage3D& image, BufferUsage usage) { AbstractTexture::subImage<3>(level, range, image, usage); diff --git a/src/Magnum/Texture.h b/src/Magnum/Texture.h index 031f4d6e2..e150022ac 100644 --- a/src/Magnum/Texture.h +++ b/src/Magnum/Texture.h @@ -649,6 +649,7 @@ template class Texture: public AbstractTexture { * @fn_gl_extension{GetTextureImage,EXT,direct_state_access}, * eventually @fn_gl{GetTexImage} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Int level, Image& image) { AbstractTexture::image(level, image); @@ -671,6 +672,7 @@ template class Texture: public AbstractTexture { * * See @ref image(Int, Image&) for more information. * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. * @todo Make it more flexible (usable with * @extension{ARB,buffer_storage}, avoiding relocations...) */ @@ -698,6 +700,7 @@ template class Texture: public AbstractTexture { * @see @fn_gl{GetTextureSubImage} * @requires_gl45 Extension @extension{ARB,get_texture_sub_image} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void subImage(Int level, const RangeTypeFor& range, Image& image) { AbstractTexture::subImage(level, range, image); @@ -723,6 +726,7 @@ template class Texture: public AbstractTexture { * for more information. * @requires_gl45 Extension @extension{ARB,get_texture_sub_image} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void subImage(Int level, const RangeTypeFor& range, BufferImage& image, BufferUsage usage) { AbstractTexture::subImage(level, range, image, usage); diff --git a/src/Magnum/TextureArray.h b/src/Magnum/TextureArray.h index ea4c4e307..3f4af188b 100644 --- a/src/Magnum/TextureArray.h +++ b/src/Magnum/TextureArray.h @@ -352,6 +352,7 @@ template class TextureArray: public AbstractTexture { * * See @ref Texture::image(Int, Image&) for more information. * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Int level, Image& image) { AbstractTexture::image(level, image); @@ -373,6 +374,7 @@ template class TextureArray: public AbstractTexture { * See @ref Texture::image(Int, BufferImage&, BufferUsage) for more * information. * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void image(Int level, BufferImage& image, BufferUsage usage) { AbstractTexture::image(level, image, usage); @@ -394,6 +396,7 @@ template class TextureArray: public AbstractTexture { * for more information. * @requires_gl45 Extension @extension{ARB,get_texture_sub_image} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void subImage(Int level, const RangeTypeFor& range, Image& image) { AbstractTexture::subImage(level, range, image); @@ -415,6 +418,7 @@ template class TextureArray: public AbstractTexture { * for more information. * @requires_gl45 Extension @extension{ARB,get_texture_sub_image} * @requires_gl Texture image queries are not available in OpenGL ES. + * See @ref Framebuffer::read() for possible workaround. */ void subImage(Int level, const RangeTypeFor& range, BufferImage& image, BufferUsage usage) { AbstractTexture::subImage(level, range, image, usage);