From 27a80cb76e737c3ddcc127f9d5350be1388ea38d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 17 Dec 2013 21:12:17 +0100 Subject: [PATCH] Shaders: doc++ --- src/Shaders/Flat.h | 3 ++- src/Shaders/Vector.h | 9 +++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/Shaders/Flat.h b/src/Shaders/Flat.h index 955a62f2e..00740ddae 100644 --- a/src/Shaders/Flat.h +++ b/src/Shaders/Flat.h @@ -25,7 +25,7 @@ */ /** @file - * @brief Class Magnum::Shaders::Flat + * @brief Class @ref Magnum::Shaders::Flat, typedef @ref Magnum::Shaders::Flat2D, @ref Magnum::Shaders::Flat3D */ #include "Math/Matrix3.h" @@ -62,6 +62,7 @@ Shaders::Flat2D shader(Shaders::Flat2D::Flag::Textured); myTexture.bind(Shaders::Flat2D::TextureLayer); @endcode +For coloring the texture based on intensity you can use the @ref Vector shader. @see @ref Flat2D, @ref Flat3D */ template class MAGNUM_SHADERS_EXPORT Flat: public AbstractShaderProgram { diff --git a/src/Shaders/Vector.h b/src/Shaders/Vector.h index 45c800bab..4f0ab789d 100644 --- a/src/Shaders/Vector.h +++ b/src/Shaders/Vector.h @@ -25,7 +25,7 @@ */ /** @file - * @brief Class Magnum::Shaders::Vector, typedef Magnum::Shaders::Vector2D, Magnum::Shaders::Vector3D + * @brief Class @ref Magnum::Shaders::Vector, typedef @ref Magnum::Shaders::Vector2D, @ref Magnum::Shaders::Vector3D */ #include "Math/Matrix3.h" @@ -41,9 +41,10 @@ namespace Magnum { namespace Shaders { /** @brief %Vector shader -Renders vector art in plain grayscale form. See also DistanceFieldVector -for more advanced effects. -@see Vector2D, Vector3D +Renders vector art in plain grayscale form. See also @ref DistanceFieldVector +for more advanced effects. For rendering unchanged texture you can use the +@ref Flat shader. +@see @ref Vector2D, @ref Vector3D */ template class MAGNUM_SHADERS_EXPORT Vector: public AbstractVector { public: