Browse Source

AbstractTexture: documented relation between loose and exact types.

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
1aca6caf5f
  1. 13
      src/AbstractTexture.h

13
src/AbstractTexture.h

@ -124,7 +124,12 @@ class MAGNUM_EXPORT AbstractTexture {
RGBA /**< Red, green, blue component and alpha. */ 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 { enum class ComponentType {
/** /**
* (Non-normalized) unsigned byte * (Non-normalized) unsigned byte
@ -237,12 +242,18 @@ class MAGNUM_EXPORT AbstractTexture {
/** /**
* Three-component RGB, unsigned normalized, each component * Three-component RGB, unsigned normalized, each component
* probably 8bit, 24bit total. * probably 8bit, 24bit total.
*
* Prefer to use the exactly specified version of this format, in
* this case `Components::RGB|ComponentType::%NormalizedUnsignedByte`.
*/ */
RGB = GL_RGB, RGB = GL_RGB,
/** /**
* Four-component RGBA, unsigned normalized, each component * Four-component RGBA, unsigned normalized, each component
* probably 8bit, 24bit total. * probably 8bit, 24bit total.
*
* Prefer to use the exactly specified version of this format, in
* this case `Components::RGBA|ComponentType::%NormalizedUnsignedByte`.
*/ */
RGBA = GL_RGBA, RGBA = GL_RGBA,

Loading…
Cancel
Save