Browse Source

Shaders: doc++

pull/518/head
Vladimír Vondruš 5 years ago
parent
commit
1506c926f5
  1. 4
      src/Magnum/Shaders/DistanceFieldVectorGL.h
  2. 5
      src/Magnum/Shaders/FlatGL.h
  3. 24
      src/Magnum/Shaders/MeshVisualizerGL.h
  4. 6
      src/Magnum/Shaders/VectorGL.h

4
src/Magnum/Shaders/DistanceFieldVectorGL.h

@ -204,8 +204,8 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT DistanceFieldVector
* outline starts. Initial value is @cpp 0.5f @ce, larger values will * outline starts. Initial value is @cpp 0.5f @ce, larger values will
* make the vector art look thinner, smaller will make it look thicker. * make the vector art look thinner, smaller will make it look thicker.
* *
* The @p end parameter describes where outline ends. If set to value * The @p end parameter describes where outline ends. If set to a value
* larger than @p start the outline is not drawn. Initial value is * larger than @p start, the outline is not drawn. Initial value is
* @cpp 1.0f @ce. * @cpp 1.0f @ce.
* *
* @see @ref setOutlineColor() * @see @ref setOutlineColor()

5
src/Magnum/Shaders/FlatGL.h

@ -443,9 +443,8 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT FlatGL: public GL::
* @brief Set color * @brief Set color
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* If @ref Flag::Textured is set, initial value is * Initial value is @cpp 0xffffffff_rgbaf @ce. If @ref Flag::Textured
* @cpp 0xffffffff_rgbaf @ce and the color will be multiplied with the * is set, the color will be multiplied with the texture.
* texture.
* @see @ref bindTexture() * @see @ref bindTexture()
*/ */
FlatGL<dimensions>& setColor(const Magnum::Color4& color); FlatGL<dimensions>& setColor(const Magnum::Color4& color);

24
src/Magnum/Shaders/MeshVisualizerGL.h

@ -277,9 +277,9 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua
* *
* Initial value is @cpp 0xffffffff_rgbaf @ce. Expects that either * Initial value is @cpp 0xffffffff_rgbaf @ce. Expects that either
* @ref Flag::Wireframe or @ref Flag::InstancedObjectId / * @ref Flag::Wireframe or @ref Flag::InstancedObjectId /
* @ref Flag::PrimitiveId is enabled. In case of the latter, the color * @ref Flag::PrimitiveId / @ref Flag::PrimitiveIdFromVertexId is
* is multiplied with the color map coming from * enabled. In case of the latter, the color is multiplied with the
* @ref bindColorMapTexture(). * color map coming from @ref bindColorMapTexture().
*/ */
MeshVisualizerGL2D& setColor(const Color4& color) { MeshVisualizerGL2D& setColor(const Color4& color) {
return static_cast<MeshVisualizerGL2D&>(Implementation::MeshVisualizerGLBase::setColor(color)); return static_cast<MeshVisualizerGL2D&>(Implementation::MeshVisualizerGLBase::setColor(color));
@ -300,7 +300,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D: public Implementation::MeshVisua
* @brief Set wireframe width * @brief Set wireframe width
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Value is in screen space (depending on @ref setViewportSize()), * The value is in screen space (depending on @ref setViewportSize()),
* initial value is @cpp 1.0f @ce. Expects that @ref Flag::Wireframe is * initial value is @cpp 1.0f @ce. Expects that @ref Flag::Wireframe is
* enabled. * enabled.
*/ */
@ -891,9 +891,9 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
* *
* Initial value is @cpp 0xffffffff_rgbaf @ce. Expects that either * Initial value is @cpp 0xffffffff_rgbaf @ce. Expects that either
* @ref Flag::Wireframe or @ref Flag::InstancedObjectId / * @ref Flag::Wireframe or @ref Flag::InstancedObjectId /
* @ref Flag::PrimitiveId is enabled. In case of the latter, the color * @ref Flag::PrimitiveId / @ref Flag::PrimitiveIdFromVertexId is
* is multiplied with the color map coming from * enabled. In case of the latter, the color is multiplied with the
* @ref bindColorMapTexture(). * color map coming from @ref bindColorMapTexture().
*/ */
MeshVisualizerGL3D& setColor(const Color4& color) { MeshVisualizerGL3D& setColor(const Color4& color) {
return static_cast<MeshVisualizerGL3D&>(Implementation::MeshVisualizerGLBase::setColor(color)); return static_cast<MeshVisualizerGL3D&>(Implementation::MeshVisualizerGLBase::setColor(color));
@ -914,7 +914,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
* @brief Set wireframe width * @brief Set wireframe width
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Value is in screen space (depending on @ref setViewportSize()), * The value is in screen space (depending on @ref setViewportSize()),
* initial value is @cpp 1.0f @ce. Expects that @ref Flag::Wireframe is * initial value is @cpp 1.0f @ce. Expects that @ref Flag::Wireframe is
* enabled. * enabled.
*/ */
@ -963,7 +963,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* @m_since{2020,06} * @m_since{2020,06}
* *
* Value is in screen space (depending on @ref setViewportSize()), * The value is in screen space (depending on @ref setViewportSize()),
* initial value is @cpp 1.0f @ce. Expects that * initial value is @cpp 1.0f @ce. Expects that
* @ref Flag::TangentDirection, * @ref Flag::TangentDirection,
* @ref Flag::BitangentFromTangentDirection, * @ref Flag::BitangentFromTangentDirection,
@ -982,8 +982,8 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* @m_since{2020,06} * @m_since{2020,06}
* *
* Value is in object space, initial value is @cpp 1.0f @ce. Expects * The value is in object space, initial value is @cpp 1.0f @ce.
* that @ref Flag::TangentDirection, * Expects that @ref Flag::TangentDirection,
* @ref Flag::BitangentFromTangentDirection, * @ref Flag::BitangentFromTangentDirection,
* @ref Flag::BitangentDirection or @ref Flag::NormalDirection is * @ref Flag::BitangentDirection or @ref Flag::NormalDirection is
* enabled. * enabled.
@ -1000,7 +1000,7 @@ class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D: public Implementation::MeshVisua
* @brief Set line smoothness * @brief Set line smoothness
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Value is in screen space (depending on @ref setViewportSize()), * The value is in screen space (depending on @ref setViewportSize()),
* initial value is @cpp 2.0f @ce. Expects that @ref Flag::Wireframe, * initial value is @cpp 2.0f @ce. Expects that @ref Flag::Wireframe,
* @ref Flag::TangentDirection, * @ref Flag::TangentDirection,
* @ref Flag::BitangentFromTangentDirection, * @ref Flag::BitangentFromTangentDirection,

6
src/Magnum/Shaders/VectorGL.h

@ -158,7 +158,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public Ab
* @brief Set transformation and projection matrix * @brief Set transformation and projection matrix
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is an identity matrix. * Initial value is an identity matrix.
*/ */
VectorGL<dimensions>& setTransformationProjectionMatrix(const MatrixTypeFor<dimensions, Float>& matrix); VectorGL<dimensions>& setTransformationProjectionMatrix(const MatrixTypeFor<dimensions, Float>& matrix);
@ -177,7 +177,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public Ab
* @brief Set background color * @brief Set background color
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is @cpp 0x00000000_rgbaf @ce. * Initial value is @cpp 0x00000000_rgbaf @ce.
* @see @ref setColor() * @see @ref setColor()
*/ */
VectorGL<dimensions>& setBackgroundColor(const Color4& color); VectorGL<dimensions>& setBackgroundColor(const Color4& color);
@ -186,7 +186,7 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VectorGL: public Ab
* @brief Set fill color * @brief Set fill color
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is @cpp 0xffffffff_rgbaf @ce. * Initial value is @cpp 0xffffffff_rgbaf @ce.
* @see @ref setBackgroundColor() * @see @ref setBackgroundColor()
*/ */
VectorGL<dimensions>& setColor(const Color4& color); VectorGL<dimensions>& setColor(const Color4& color);

Loading…
Cancel
Save