Browse Source

Workaround Doxygen parsing bug.

Probably caused by MAGNUM_EXPORT macro.
vectorfields
Vladimír Vondruš 14 years ago
parent
commit
95725cae94
  1. 60
      src/AbstractTexture.h
  2. 7
      src/Camera.h
  3. 12
      src/Mesh.h

60
src/AbstractTexture.h

@ -414,7 +414,36 @@ class MAGNUM_EXPORT AbstractTexture {
Depth32FloatStencil8 = GL_DEPTH32F_STENCIL8
};
class InternalFormat;
/**
* @brief Internal format
*
* When specifying internal format, you can either specify as binary
* OR of component count (using Component enum) and data type per
* component (value from ComponentType enum), or using one of named
* internal formats from Format enum, e.g.:
* @code
* InternalFormat fmt1 = Format::RGBA;
* InternalFormat fmt2 = Components::RGBA|ComponentType::NormalizedUnsignedByte;
* @endcode
* You can also use the constructor directly instead of binary OR:
* @code
* InternalFormat fmt2(Components::RGBA, ComponentType::NormalizedUnsignedByte);
* @endcode
*/
class MAGNUM_EXPORT InternalFormat {
public:
/** @brief Constructor from component count and data type per component */
InternalFormat(Components components, ComponentType type);
/** @brief Constructor from named internal format */
inline constexpr InternalFormat(Format format): internalFormat(static_cast<GLint>(format)) {}
/** @brief OpenGL internal format ID */
inline constexpr operator GLint() const { return internalFormat; }
private:
GLint internalFormat;
};
/*@}*/
@ -539,36 +568,7 @@ class MAGNUM_EXPORT AbstractTexture {
GLuint texture;
};
/**
@brief Internal format
When specifying internal format, you can either specify as binary OR of
component count (using Component enum) and data type per component (value from
ComponentType enum), or using one of named internal formats from Format enum,
e.g.:
@code
InternalFormat fmt1 = Format::RGBA;
InternalFormat fmt2 = Components::RGBA|ComponentType::NormalizedUnsignedByte;
@endcode
You can also use the constructor directly instead of binary OR:
@code
InternalFormat fmt2(Components::RGBA, ComponentType::NormalizedUnsignedByte);
@endcode
*/
class MAGNUM_EXPORT AbstractTexture::InternalFormat {
public:
/** @brief Constructor from component count and data type per component */
InternalFormat(Components components, ComponentType type);
/** @brief Constructor from named internal format */
inline constexpr InternalFormat(Format format): internalFormat(static_cast<GLint>(format)) {}
/** @brief OpenGL internal format ID */
inline constexpr operator GLint() const { return internalFormat; }
private:
GLint internalFormat;
};
/** @brief Convertor of component count and data type to InternalFormat */
inline AbstractTexture::InternalFormat operator|(AbstractTexture::Components components, AbstractTexture::ComponentType type) {

7
src/Camera.h

@ -37,6 +37,7 @@ class MAGNUM_EXPORT Camera: public Object {
* @brief Features
*
* If not specified otherwise, all features are disabled by default.
* @see setFeature()
*/
enum class Feature: GLenum {
AlphaBlending = GL_BLEND, /**< Alpha blending */
@ -53,7 +54,11 @@ class MAGNUM_EXPORT Camera: public Object {
FaceCulling = GL_CULL_FACE /**< Back face culling */
};
/** @brief Aspect ratio policy */
/**
* @brief Aspect ratio policy
*
* @see aspectRatioPolicy(), setAspectRatioPolicy()
*/
enum class AspectRatioPolicy {
NotPreserved, /**< Don't preserve aspect ratio */
Extend, /**< Extend on larger side of view */

12
src/Mesh.h

@ -52,7 +52,11 @@ class MAGNUM_EXPORT Mesh {
Mesh& operator=(Mesh&& other) = delete;
public:
/** @brief Polygon mode */
/**
* @brief Polygon mode
*
* @see setPolygonMode()
*/
enum class PolygonMode: GLenum {
/**
* Interior of the polygon is filled.
@ -71,7 +75,11 @@ class MAGNUM_EXPORT Mesh {
Point = GL_POINT
};
/** @brief Primitive type */
/**
* @brief Primitive type
*
* @see primitive(), setPrimitive()
*/
enum class Primitive: GLenum {
/**
* Single points

Loading…
Cancel
Save