Browse Source

Shaders: completed documentation review.

pull/54/merge
Vladimír Vondruš 12 years ago
parent
commit
0d7dd09ae8
  1. 4
      src/Magnum/Shaders/AbstractVector.h
  2. 10
      src/Magnum/Shaders/Flat.h
  3. 10
      src/Magnum/Shaders/Phong.h

4
src/Magnum/Shaders/AbstractVector.h

@ -43,13 +43,13 @@ template<UnsignedInt dimensions> class AbstractVector: public AbstractShaderProg
/** @brief Vertex position */
typedef typename Generic<dimensions>::Position Position;
/** @brief Texture coordinates */
/** @brief %Texture coordinates */
typedef typename Generic<dimensions>::TextureCoordinates TextureCoordinates;
#ifdef MAGNUM_BUILD_DEPRECATED
enum: Int {
/**
* Vector texture binding unit
* %Vector texture binding unit
* @deprecated Use @ref Magnum::Shaders::AbstractVector::setVectorTexture() "setVectorTexture()" instead.
*/
VectorTextureLayer = 16

10
src/Magnum/Shaders/Flat.h

@ -65,7 +65,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT Flat: public Abstra
typedef typename Generic<dimensions>::Position Position;
/**
* @brief Texture coordinates
* @brief %Texture coordinates
*
* Used only if @ref Flag::Textured is set.
*/
@ -84,7 +84,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT Flat: public Abstra
#ifdef DOXYGEN_GENERATING_OUTPUT
/**
* @brief Shader flag
* @brief %Flag
*
* @see @ref Flags, @ref flags()
*/
@ -93,7 +93,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT Flat: public Abstra
};
/**
* @brief Shader flags
* @brief %Flags
*
* @see @ref flags()
*/
@ -105,11 +105,11 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT Flat: public Abstra
/**
* @brief Constructor
* @param flags Shader flags
* @param flags %Flags
*/
explicit Flat(Flags flags = Flags());
/** @brief Shader flags */
/** @brief %Flags */
Flags flags() const { return _flags; }
/**

10
src/Magnum/Shaders/Phong.h

@ -55,7 +55,7 @@ class MAGNUM_SHADERS_EXPORT Phong: public AbstractShaderProgram {
typedef Generic3D::Normal Normal; /**< @brief Normal direction */
/**
* @brief Texture coordinates
* @brief %Texture coordinates
*
* Used only if one of @ref Flag::AmbientTexture, @ref Flag::DiffuseTexture
* or @ref Flag::SpecularTexture is set.
@ -91,7 +91,7 @@ class MAGNUM_SHADERS_EXPORT Phong: public AbstractShaderProgram {
#endif
/**
* @brief Shader flag
* @brief %Flag
*
* @see @ref Flags, @ref flags()
*/
@ -102,7 +102,7 @@ class MAGNUM_SHADERS_EXPORT Phong: public AbstractShaderProgram {
};
/**
* @brief Shader flags
* @brief %Flags
*
* @see @ref flags()
*/
@ -110,11 +110,11 @@ class MAGNUM_SHADERS_EXPORT Phong: public AbstractShaderProgram {
/**
* @brief Constructor
* @param flags Shader flags
* @param flags %Flags
*/
explicit Phong(Flags flags = Flags());
/** @brief Shader flags */
/** @brief %Flags */
Flags flags() const { return _flags; }
/**

Loading…
Cancel
Save