Magnum::DebugTools namespace

Debug tools.

Contents

Debugging helpers, renderers and profilers.

This library is built if WITH_DEBUGTOOLS is enabled when building Magnum. To use this library with CMake, you need to request the DebugTools component of the Magnum package and link to the Magnum::DebugTools target:

find_package(Magnum REQUIRED DebugTools)

# ...
target_link_libraries(your-app Magnum::DebugTools)

See Downloading and building, Usage with CMake and Debugging helpers for more information.

Classes

class CompareFileToImage
File-to-image comparator.
class CompareImage
Image comparator.
class CompareImageFile
Image file comparator.
class CompareImageToFile
Image-to-file comparator.
template<UnsignedInt dimensions>
class ForceRenderer
Force renderer.
class ForceRendererOptions
Force renderer options.
template<UnsignedInt dimensions>
class ObjectRenderer
Object renderer.
class ObjectRendererOptions
Object renderer options.
class Profiler
Profiler.
class ResourceManager
Resource manager for debug tools.
template<UnsignedInt dimensions>
class ShapeRenderer deprecated
Shape renderer.
class ShapeRendererOptions deprecated
Shape renderer options.

Typedefs

using ForceRenderer2D = ForceRenderer<2>
Two-dimensional force renderer.
using ForceRenderer3D = ForceRenderer<3>
Three-dimensional force renderer.
using ObjectRenderer2D = ObjectRenderer<2>
Two-dimensional object renderer.
using ObjectRenderer3D = ObjectRenderer<3>
Three-dimensional object renderer.
using ShapeRenderer2D = ShapeRenderer<2> deprecated
Two-dimensional shape renderer.
using ShapeRenderer3D = ShapeRenderer<3> deprecated
Three-dimensional shape renderer.

Functions

template<class T>
auto bufferSubData(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size) -> Containers::Array<T>
Buffer subdata.
template<class T = char>
auto bufferData(GL::Buffer& buffer) -> Containers::Array<T>
Buffer data.
void textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D& image)
Read range of given texture mip level to image.
auto textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D&& image) -> Image2D
Read range of given texture mip level to image.
void textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage)
Read range of given texture mip level to buffer image.
auto textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage) -> GL::BufferImage2D
Read range of given texture mip level to buffer image.
void textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D& image)
Read range of given cube map texture coordinate mip level to image.
auto textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D&& image) -> Image2D
Read range of given cube map texture coordinate mip level to image.
void textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage)
Read range of given cube map texture coordinate mip level to buffer image.
auto textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage) -> GL::BufferImage2D
Read range of given cube map texture coordinate mip level to buffer image.

Typedef documentation

typedef ShapeRenderer<2> Magnum::DebugTools::ShapeRenderer2D

Two-dimensional shape renderer.

typedef ShapeRenderer<3> Magnum::DebugTools::ShapeRenderer3D

Three-dimensional shape renderer.

Function documentation

template<class T>
Containers::Array<T> Magnum::DebugTools::bufferSubData(GL::Buffer& buffer, GLintptr offset, GLsizeiptr size)

Buffer subdata.

Emulates GL::Buffer::subData() call on platforms that don't support it (such as OpenGL ES) by using GL::Buffer::map().

template<class T = char>
Containers::Array<T> Magnum::DebugTools::bufferData(GL::Buffer& buffer)

Buffer data.

Emulates GL::Buffer::data() call on platforms that don't support it (such as OpenGL ES) by using GL::Buffer::map().

void Magnum::DebugTools::textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D& image)

Read range of given texture mip level to image.

Emulates GL::Texture2D::subImage() call on platforms that don't support it (such as OpenGL ES) by creating a framebuffer object and using GL::Framebuffer::read(). On desktop OpenGL, if ARB_get_texture_sub_image is available, it's just an alias to GL::Texture2D::subImage().

Note that only GL::PixelFormat and GL::PixelType values that are marked as framebuffer readable are supported; their generic PixelFormat counterparts are supported as well. In addition, on OpenGL ES 3.0, images with GL::PixelType::Float are supported — they are reinterpreted as GL::PixelType::UnsignedInt using an additional shader and the floatBitsToUint() GLSL function and then reinterpreted back to GL::PixelType::Float when read to client memory.

Image2D Magnum::DebugTools::textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, Image2D&& image)

Read range of given texture mip level to image.

Convenience alternative to the above, example usage:

Image2D image = DebugTools::textureSubImage(texture, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte});

void Magnum::DebugTools::textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage)

Read range of given texture mip level to buffer image.

Emulates GL::Texture2D::subImage() call on platforms that don't support it (such as OpenGL ES) by creating a framebuffer object and using GL::Framebuffer::read(). On desktop OpenGL, if ARB_get_texture_sub_image is available, it's just an alias to GL::Texture2D::subImage().

Note that only GL::PixelFormat and GL::PixelType values that are marked as framebuffer readable are supported; their generic PixelFormat counterparts are supported as well.

GL::BufferImage2D Magnum::DebugTools::textureSubImage(GL::Texture2D& texture, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage)

Read range of given texture mip level to buffer image.

Convenience alternative to the above, example usage:

BufferImage2D image = DebugTools::textureSubImage(texture, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte}, BufferUsage::StaticRead);

void Magnum::DebugTools::textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D& image)

Read range of given cube map texture coordinate mip level to image.

Emulates GL::CubeMapTexture::subImage() call on platforms that don't support it (such as OpenGL ES) by creating a framebuffer object and using GL::Framebuffer::read().

Note that only GL::PixelFormat and GL::PixelType values that are marked as framebuffer readable are supported; their generic PixelFormat counterparts are supported as well.

Image2D Magnum::DebugTools::textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, Image2D&& image)

Read range of given cube map texture coordinate mip level to image.

Convenience alternative to the above, example usage:

Image2D image = DebugTools::textureSubImage(texture, CubeMapCoordinate::PositiveX, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte});

void Magnum::DebugTools::textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D& image, GL::BufferUsage usage)

Read range of given cube map texture coordinate mip level to buffer image.

Emulates GL::CubeMapTexture::subImage() call on platforms that don't support it (such as OpenGL ES) by creating a framebuffer object and using GL::Framebuffer::read().

Note that only GL::PixelFormat and GL::PixelType values that are marked as framebuffer readable are supported; their generic PixelFormat counterparts are supported as well.

GL::BufferImage2D Magnum::DebugTools::textureSubImage(GL::CubeMapTexture& texture, GL::CubeMapCoordinate coordinate, Int level, const Range2Di& range, GL::BufferImage2D&& image, GL::BufferUsage usage)

Read range of given cube map texture coordinate mip level to buffer image.

Convenience alternative to the above, example usage:

BufferImage2D image = DebugTools::textureSubImage(texture, CubeMapCoordinate::PositiveX, 0, rect, {PixelFormat::RGBA, PixelType::UnsignedByte}, BufferUsage::StaticRead);