Browse Source

Doc++

Also remove redundant preprocessor branches.
pull/51/head
Vladimír Vondruš 12 years ago
parent
commit
3e40bdd443
  1. 25
      src/Magnum/CubeMapTextureArray.h
  2. 15
      src/Magnum/RectangleTexture.h
  3. 2
      src/Magnum/Texture.h
  4. 8
      src/Magnum/TextureArray.h

25
src/Magnum/CubeMapTextureArray.h

@ -104,7 +104,7 @@ class CubeMapTextureArray: public AbstractTexture {
static Vector3i maxSize();
/**
* @brief Set base mip level
* @copybrief Texture::setBaseLevel()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBaseLevel() for more information.
@ -115,7 +115,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set max mip level
* @copybrief Texture::setMaxLevel()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setMaxLevel() for more information.
@ -138,7 +138,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set minimum level-of-detail parameter
* @copybrief Texture::setMinLod()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setMinLod() for more information.
@ -149,7 +149,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set maximum level-of-detail parameter
* @copybrief Texture::setMaxLod()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setMaxLod() for more information.
@ -160,7 +160,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set level-of-detail bias
* @copybrief Texture::setLodBias()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setLodBias() for more information.
@ -177,7 +177,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set border color
* @copybrief Texture::setBorderColor(const Color4&)
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBorderColor(const Color4&) for more
@ -189,7 +189,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set border color for integer texture
* @copybrief Texture::setBorderColor(const Vector4ui&)
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBorderColor(const Vector4ui&) for more
@ -201,7 +201,7 @@ class CubeMapTextureArray: public AbstractTexture {
}
/**
* @brief Set border color for integer texture
* @copybrief Texture::setBorderColor(const Vector4ui&)
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBorderColor(const Vector4i&) for more
@ -218,13 +218,16 @@ class CubeMapTextureArray: public AbstractTexture {
return *this;
}
#ifndef MAGNUM_TARGET_GLES
/** @copydoc Texture::setDepthStencilMode() */
/**
* @copybrief Texture::setDepthStencilMode()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setDepthStencilMode() for more information.
*/
CubeMapTextureArray& setDepthStencilMode(Sampler::DepthStencilMode mode) {
AbstractTexture::setDepthStencilMode(mode);
return *this;
}
#endif
/**
* @brief %Image size in given mip level

15
src/Magnum/RectangleTexture.h

@ -149,7 +149,7 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture {
}
/**
* @brief Set border color
* @copybrief Texture::setBorderColor(const Color4&)
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBorderColor(const Color4&) for more
@ -161,7 +161,7 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture {
}
/**
* @brief Set border color for integer texture
* @copybrief Texture::setBorderColor(const Vector4ui&)
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBorderColor(const Vector4ui&) for more
@ -173,7 +173,7 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture {
}
/**
* @brief Set border color for integer texture
* @copybrief Texture::setBorderColor(const Vector4ui&)
* @return Reference to self (for method chaining)
*
* See @ref Texture::setBorderColor(const Vector4i&) for more
@ -190,13 +190,16 @@ class MAGNUM_EXPORT RectangleTexture: public AbstractTexture {
return *this;
}
#ifndef MAGNUM_TARGET_GLES
/** @copydoc Texture::setDepthStencilMode() */
/**
* @copybrief Texture::setDepthStencilMode()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setDepthStencilMode() for more information.
*/
RectangleTexture& setDepthStencilMode(Sampler::DepthStencilMode mode) {
AbstractTexture::setDepthStencilMode(mode);
return *this;
}
#endif
/**
* @brief Set storage

2
src/Magnum/Texture.h

@ -445,11 +445,13 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
#ifndef MAGNUM_TARGET_GLES
/**
* @brief Set depth/stencil texture mode
* @return Reference to self (for method chaining)
*
* Selects which component of packed depth/stencil texture is used for
* texturing. If @extension{EXT,direct_state_access} is not available,
* the texture is bound to some texture unit before the operation.
* Initial value is @ref Sampler::DepthStencilMode::DepthComponent.
* @note Depth textures can be only 1D or 2D.
* @see @fn_gl{ActiveTexture}, @fn_gl{BindTexture} and @fn_gl{TexParameter}
* or @fn_gl_extension{TextureParameter,EXT,direct_state_access}
* with @def_gl{DEPTH_STENCIL_TEXTURE_MODE}

8
src/Magnum/TextureArray.h

@ -90,6 +90,7 @@ documentation for more information about usage in shaders.
@requires_gl30 %Extension @extension{EXT,texture_array}
@requires_gles30 %Array textures are not available in OpenGL ES 2.0.
@requires_gl 1D array textures are not available in OpenGL ES, only 2D ones.
@todo Fix this when @es_extension{NV,texture_array} is in ES2 extension headers
*/
template<UnsignedInt dimensions> class TextureArray: public AbstractTexture {
public:
@ -196,7 +197,12 @@ template<UnsignedInt dimensions> class TextureArray: public AbstractTexture {
}
#ifndef MAGNUM_TARGET_GLES
/** @copydoc Texture::setDepthStencilMode() */
/**
* @copybrief Texture::setDepthStencilMode()
* @return Reference to self (for method chaining)
*
* See @ref Texture::setDepthStencilMode() for more information.
*/
TextureArray<dimensions>& setDepthStencilMode(Sampler::DepthStencilMode mode) {
AbstractTexture::setDepthStencilMode(mode);
return *this;

Loading…
Cancel
Save