From 1aca6caf5fcba6b3a1796029ac2efefffcac9b07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 28 May 2012 21:19:23 +0200 Subject: [PATCH] AbstractTexture: documented relation between loose and exact types. --- src/AbstractTexture.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/AbstractTexture.h b/src/AbstractTexture.h index 773958613..d5a24292d 100644 --- a/src/AbstractTexture.h +++ b/src/AbstractTexture.h @@ -124,7 +124,12 @@ class MAGNUM_EXPORT AbstractTexture { RGBA /**< Red, green, blue component and alpha. */ }; - /** @brief Type of data per each component */ + /** + * @brief Type of data per each component + * + * `NormalizedUnsignedByte` and `NormalizedUnsignedShort` are the + * main ones for general usage. + */ enum class ComponentType { /** * (Non-normalized) unsigned byte @@ -237,12 +242,18 @@ class MAGNUM_EXPORT AbstractTexture { /** * Three-component RGB, unsigned normalized, each component * probably 8bit, 24bit total. + * + * Prefer to use the exactly specified version of this format, in + * this case `Components::RGB|ComponentType::%NormalizedUnsignedByte`. */ RGB = GL_RGB, /** * Four-component RGBA, unsigned normalized, each component * probably 8bit, 24bit total. + * + * Prefer to use the exactly specified version of this format, in + * this case `Components::RGBA|ComponentType::%NormalizedUnsignedByte`. */ RGBA = GL_RGBA,