Browse Source

Doc++

pull/231/head
Vladimír Vondruš 8 years ago
parent
commit
44b571f380
  1. 2
      src/Magnum/CubeMapTexture.h
  2. 2
      src/Magnum/CubeMapTextureArray.h
  3. 12
      src/Magnum/DebugOutput.h
  4. 6
      src/Magnum/Sampler.h
  5. 2
      src/Magnum/Texture.h
  6. 2
      src/Magnum/TextureArray.h
  7. 2
      src/Magnum/TextureFormat.h

2
src/Magnum/CubeMapTexture.h

@ -413,7 +413,7 @@ class MAGNUM_EXPORT CubeMapTexture: public AbstractTexture {
* @requires_extension Extension @extension{EXT,texture_sRGB_decode}
* @requires_es_extension OpenGL ES 3.0 or extension
* @extension{EXT,sRGB} and
* @extension{ANDROID,extension_pack_es31a}/
* @extension{ANDROID,extension_pack_es31a} /
* @extension2{EXT,texture_sRGB_decode,texture_sRGB_decode}
* @requires_gles SRGB decode is not available in WebGL.
*/

2
src/Magnum/CubeMapTextureArray.h

@ -364,7 +364,7 @@ class MAGNUM_EXPORT CubeMapTextureArray: public AbstractTexture {
*
* See @ref Texture::setSRGBDecode() for more information.
* @requires_extension Extension @extension{EXT,texture_sRGB_decode}
* @requires_es_extension Extension @extension{ANDROID,extension_pack_es31a}/
* @requires_es_extension Extension @extension{ANDROID,extension_pack_es31a} /
* @extension2{EXT,texture_sRGB_decode,texture_sRGB_decode}
*/
CubeMapTextureArray& setSRGBDecode(bool decode) {

12
src/Magnum/DebugOutput.h

@ -495,23 +495,17 @@ class MAGNUM_EXPORT DebugMessage {
* @brief Message source
*
* @see @ref insert()
* @todoc use m_enum_values_as_keywords once deprecated values are gone
* @m_enum_values_as_keywords
*/
enum class Source: GLenum {
/**
* External debugger or third-party middleware
* @m_keywords{GL_DEBUG_SOURCE_THIRD_PARTY}
*/
/** External debugger or third-party middleware */
#ifndef MAGNUM_TARGET_GLES2
ThirdParty = GL_DEBUG_SOURCE_THIRD_PARTY,
#else
ThirdParty = GL_DEBUG_SOURCE_THIRD_PARTY_KHR,
#endif
/**
* The application
* @m_keywords{GL_DEBUG_SOURCE_APPLICATION}
*/
/** The application */
#ifndef MAGNUM_TARGET_GLES2
Application = GL_DEBUG_SOURCE_APPLICATION
#else

6
src/Magnum/Sampler.h

@ -78,7 +78,11 @@ class MAGNUM_EXPORT Sampler {
* @see @ref Texture::setMinificationFilter() "*Texture::setMinificationFilter()"
*/
enum class Mipmap: GLint {
Base = GL_NEAREST & ~GL_NEAREST, /**< Select base mip level */
/**
* Select base mip level
* @m_keywords{GL_NEAREST}
*/
Base = GL_NEAREST & ~GL_NEAREST,
/**
* Select nearest mip level. **Unavailable on rectangle textures.**

2
src/Magnum/Texture.h

@ -575,7 +575,7 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* @requires_extension Extension @extension{EXT,texture_sRGB_decode}
* @requires_es_extension OpenGL ES 3.0 or extension
* @extension{EXT,sRGB} and
* @extension{ANDROID,extension_pack_es31a}/
* @extension{ANDROID,extension_pack_es31a} /
* @extension2{EXT,texture_sRGB_decode,texture_sRGB_decode}
* @requires_gles SRGB decode is not available in WebGL.
*/

2
src/Magnum/TextureArray.h

@ -387,7 +387,7 @@ template<UnsignedInt dimensions> class TextureArray: public AbstractTexture {
*
* See @ref Texture::setSRGBDecode() for more information.
* @requires_extension Extension @extension{EXT,texture_sRGB_decode}
* @requires_es_extension Extension @extension{ANDROID,extension_pack_es31a}/
* @requires_es_extension Extension @extension{ANDROID,extension_pack_es31a} /
* @extension2{EXT,texture_sRGB_decode,texture_sRGB_decode}
* @requires_gles SRGB decode is not available in WebGL.
*/

2
src/Magnum/TextureFormat.h

@ -125,6 +125,8 @@ enum class TextureFormat: GLenum {
* RGB, normalized unsigned, size implementation-dependent. Not allowed in
* unemulated @ref Texture::setStorage() "*Texture::setStorage()" calls, in
* that case use @ref TextureFormat::RGB8 "TextureFormat::RGB8" instead.
* @requires_gl Can't be used as a render target in OpenGL ES or WebGL. See
* @ref TextureFormat::RGBA for an alternative.
* @deprecated_gl Prefer to use the exactly specified version of this
* format, e.g. @ref TextureFormat::RGB8.
*/

Loading…
Cancel
Save