magnum

History

Vladimír Vondruš 6d41597d1d Split the OpenGL layer out, pt 9: generic pixel formats. This is quite big, so: * There are new Magnum::PixelFormat and Magnum::CompressedPixelFormat enums, which contain generic API-independent formats. In particular, PixelFormat replaces GL::PixelFormat and GL::PixelType with a single value. * There's GL::pixelFormat(), GL::pixelType(), GL::compressedPixelFormat() to convert the generic enums to GL-specific. The mapping is only in one direction, done with a lookup table (generic enums are indices to that table). * GL classes taking the formats directly (such as GL::BufferImage) have overloads that take both the GL-specific and generic format. * The generic Image, CompressedImage, ImageView, CompressedImageView, and Trade::ImageData classes now accept the generic formats first-class. However, it's also possible to store an implementation-specific value to cover cases where a generic format enum doesn't have support for a particular format. This is done by wrapping the value using pixelFormatWrap() or compressedPixelFormatWrap(). Particular GPU APIs then assume it's their implementation-specific value and extract the value back using pixelFormatUnwrap() or compressedPixelFormatUnwrap(). There's also an isPixelFormatImplementationSpecific() and isCompressedPixelFormatImplementationSpecific() that distinguishes these values. * Many operations need pixel size and in order to have it even for implementation-specific formats, a corresponding pixelSize() overload is found via ADL on construction and the calculated size stored along the format. Previously the pixel size was only calculated on demand, but that's not possible now. In case such overload is not available, it's possible to pass pixel size manually as well. * In order to support the GL format+type pair, Image, ImageView and Trade::ImageData, there's now an additional untyped formatExtra() field that holds the second value. * The CompressedPixelStorage class is now unconditionally available on all targets, including OpenGL ES and WebGL. However, on OpenGL ES the GL APIs expect that it's all at default values. I attempted to preserve backwards compatibility as much as possible: * The PixelFormat and CompressedPixelFormat enum now contains generic API-independent values. The GL-specific formats are present there, but marked as deprecated. Use either the generic values or GL::PixelFormat (togehter with GL::PixelType) and GL::CompressedPixelFormat instead. There's a lot of ugliness caused by this, but seems to work well. * Image::type() functions are deprecated as they were too GL-specific. Use formatExtra() and cast it to GL::PixelType instead. Image constructors take templated format or format+extra arguments, so passing GL-specific values to them should still work.		8 years ago
..
CMakeLists.txt	Split the OpenGL layer out, pt 9: generic pixel formats.	8 years ago
Magnum.cpp	Split the OpenGL layer out, pt 9: generic pixel formats.	8 years ago
MagnumDebugTools.cpp	doc: compiling Debug Tools page code snippets.	8 years ago
MagnumGL-framebuffer.cpp	Split the OpenGL layer out, pt 1: moving files to a new location.	8 years ago
MagnumGL.cpp	Split the OpenGL layer out, pt 9: generic pixel formats.	8 years ago
MagnumMath.cpp	doc: compiling Types page code snippets.	8 years ago
MagnumMeshTools.cpp	doc: compiled code snippets for the MeshTools namespace.	8 years ago
MagnumPlatform-custom.cpp	doc: converted Platform docs to use compiled code snippets.	8 years ago
MagnumPlatform-portability.cpp	doc: make the snippet actually compile on ES.	8 years ago
MagnumPlatform-windowless-custom.cpp	doc: converted Platform docs to use compiled code snippets.	8 years ago
MagnumPlatform-windowless-thread.cpp	doc: converted Platform docs to use compiled code snippets.	8 years ago
MagnumPlatform-windowless.cpp	doc: converted Platform docs to use compiled code snippets.	8 years ago
MagnumPlatform.cpp	doc: converted Platform docs to use compiled code snippets.	8 years ago
MagnumShaders.cpp	Shaders: rename texture binding functions from set() to bind().	8 years ago
MagnumText.cpp	Shaders: rename texture binding functions from set() to bind().	8 years ago
MagnumTrade.cpp	Split the OpenGL layer out, pt 9: generic pixel formats.	8 years ago
README.md	doc: apply pngcrush to Getting Started images.	8 years ago
coding-style.h	Enable search-related aliases in Doxyfile, update related coding style doc.	8 years ago
configure.h.cmake	Updated copyright year.	8 years ago
debugtools-compareimage.ansi	Doc++	8 years ago
debugtools-compareimage.cpp	Updated copyright year.	8 years ago
getting-started-blue.cpp	doc: using an actual snippet from the getting started app source.	8 years ago
getting-started.cpp	doc: using an actual snippet from the getting started app source.	8 years ago
image1.tga	DebugTools: initial implementation of CompareImage class.	9 years ago
image2.tga	DebugTools: initial implementation of CompareImage class.	9 years ago
plugins.cpp	Doc++	8 years ago

README.md

Snippets that possibly generate output for Magnum documentation ###############################################################

"Getting started" image

Displayed by the getting-started executable. Run the app and take screenshot using Spectacle (including decorations, 880x707). Similarly for the gray version. The resulting files should be resized to half. pngcrush to them for smaller file sizes:

pngcrush -ow getting-started.png
pngcrush -ow getting-started-blue.png

The output printed by the application can be used to update the example output in doc/getting-started.dox.