Browse Source

Doc++

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

12
src/Magnum/DebugOutput.h

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

6
src/Magnum/Sampler.h

@ -78,7 +78,11 @@ class MAGNUM_EXPORT Sampler {
* @see @ref Texture::setMinificationFilter() "*Texture::setMinificationFilter()" * @see @ref Texture::setMinificationFilter() "*Texture::setMinificationFilter()"
*/ */
enum class Mipmap: GLint { 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.** * Select nearest mip level. **Unavailable on rectangle textures.**

2
src/Magnum/TextureFormat.h

@ -125,6 +125,8 @@ enum class TextureFormat: GLenum {
* RGB, normalized unsigned, size implementation-dependent. Not allowed in * RGB, normalized unsigned, size implementation-dependent. Not allowed in
* unemulated @ref Texture::setStorage() "*Texture::setStorage()" calls, in * unemulated @ref Texture::setStorage() "*Texture::setStorage()" calls, in
* that case use @ref TextureFormat::RGB8 "TextureFormat::RGB8" instead. * 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 * @deprecated_gl Prefer to use the exactly specified version of this
* format, e.g. @ref TextureFormat::RGB8. * format, e.g. @ref TextureFormat::RGB8.
*/ */

Loading…
Cancel
Save