mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
144 lines
6.2 KiB
144 lines
6.2 KiB
#ifndef Magnum_DebugTools_TextureImage_h |
|
#define Magnum_DebugTools_TextureImage_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 |
|
Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a |
|
copy of this software and associated documentation files (the "Software"), |
|
to deal in the Software without restriction, including without limitation |
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
and/or sell copies of the Software, and to permit persons to whom the |
|
Software is furnished to do so, subject to the following conditions: |
|
|
|
The above copyright notice and this permission notice shall be included |
|
in all copies or substantial portions of the Software. |
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
DEALINGS IN THE SOFTWARE. |
|
*/ |
|
|
|
/** @file |
|
* @brief Function @ref Magnum::DebugTools::textureSubImage() |
|
*/ |
|
|
|
#include "Magnum/Magnum.h" |
|
#include "Magnum/DebugTools/visibility.h" |
|
#include "Magnum/GL/GL.h" |
|
|
|
namespace Magnum { namespace DebugTools { |
|
|
|
/** |
|
@brief Read range of given texture mip level to image |
|
|
|
Emulates @ref Texture2D::subImage() call on platforms that don't support it |
|
(such as OpenGL ES) by creating a framebuffer object and using |
|
@ref Framebuffer::read(). On desktop OpenGL, if @extension{ARB,get_texture_sub_image} |
|
is available, it's just an alias to @ref Texture2D::subImage(). |
|
|
|
Note that only @ref Magnum::PixelFormat "PixelFormat" and @ref PixelType values |
|
that are marked as framebuffer readable are supported. In addition, on OpenGL |
|
ES 3.0, images with @ref PixelType::Float are supported --- they are |
|
reinterpreted as @ref PixelType::UnsignedInt using additional shader and |
|
`floatBitsToUint()` GLSL function and then reinterpreted back to |
|
@ref PixelType::Float when read to client memory. |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D& image); |
|
|
|
/** |
|
@brief Read range of given texture mip level to image |
|
|
|
Convenience alternative to the above, example usage: |
|
|
|
@code{.cpp} |
|
Image2D image = DebugTools::textureSubImage(texture, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte}); |
|
@endcode |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT Image2D textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D&& image); |
|
|
|
/** |
|
@brief Read range of given cube map texture coordinate mip level to image |
|
|
|
Emulates @ref CubeMapTexture::subImage() call on platforms that don't support |
|
it (such as OpenGL ES) by creating a framebuffer object and using |
|
@ref Framebuffer::read(). |
|
|
|
Note that only @ref Magnum::PixelFormat "PixelFormat" and @ref PixelType values |
|
that are marked as framebuffer readable are supported. |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D& image); |
|
|
|
/** |
|
@brief Read range of given cube map texture coordinate mip level to image |
|
|
|
Convenience alternative to the above, example usage: |
|
|
|
@code{.cpp} |
|
Image2D image = DebugTools::textureSubImage(texture, CubeMapCoordinate::PositiveX, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte}); |
|
@endcode |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT Image2D textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D&& image); |
|
|
|
#ifndef MAGNUM_TARGET_GLES2 |
|
/** |
|
@brief Read range of given texture mip level to buffer image |
|
|
|
Emulates @ref Texture2D::subImage() call on platforms that don't support it |
|
(such as OpenGL ES) by creating a framebuffer object and using |
|
@ref Framebuffer::read(). On desktop OpenGL, if @extension{ARB,get_texture_sub_image} |
|
is available, it's just an alias to @ref Texture2D::subImage(). |
|
|
|
Note that only @ref Magnum::PixelFormat "PixelFormat" and @ref PixelType values |
|
that are marked as framebuffer readable are supported. |
|
@requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0. |
|
@requires_webgl20 Pixel buffer objects are not available in WebGL 1.0. |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage); |
|
|
|
/** |
|
@brief Read range of given texture mip level to buffer image |
|
|
|
Convenience alternative to the above, example usage: |
|
|
|
@code{.cpp} |
|
BufferImage2D image = DebugTools::textureSubImage(texture, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte}, BufferUsage::StaticRead); |
|
@endcode |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT GL::BufferImage2D textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage); |
|
|
|
/** |
|
@brief Read range of given cube map texture coordinate mip level to buffer image |
|
|
|
Emulates @ref CubeMapTexture::subImage() call on platforms that don't support |
|
it (such as OpenGL ES) by creating a framebuffer object and using |
|
@ref Framebuffer::read(). |
|
|
|
Note that only @ref Magnum::PixelFormat "PixelFormat" and @ref PixelType values |
|
that are marked as framebuffer readable are supported. |
|
@requires_gles30 Pixel buffer objects are not available in OpenGL ES 2.0. |
|
@requires_webgl20 Pixel buffer objects are not available in WebGL 1.0. |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT void textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage); |
|
|
|
/** |
|
@brief Read range of given cube map texture coordinate mip level to buffer image |
|
|
|
Convenience alternative to the above, example usage: |
|
|
|
@code{.cpp} |
|
BufferImage2D image = DebugTools::textureSubImage(texture, CubeMapCoordinate::PositiveX, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte}, BufferUsage::StaticRead); |
|
@endcode |
|
*/ |
|
MAGNUM_DEBUGTOOLS_EXPORT GL::BufferImage2D textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage); |
|
#endif |
|
|
|
}} |
|
|
|
#endif
|
|
|