Add Doxygen documentation, plus a few small fixes.

Author: kblaschke

src/libprojectM/MilkdropPreset/FinalComposite.hpp

@@ -87,15 +87,15 @@ class FinalComposite
     static constexpr int vertexCount{compositeGridWidth * compositeGridHeight};
     static constexpr int indexCount{(compositeGridWidth - 2) * (compositeGridHeight - 2) * 6};
 
-    Renderer::Mesh m_compositeMesh; //!< The composite shader mesh.
-    Renderer::VertexBuffer<Renderer::Point> m_radiusAngle; //!< Additional vertex attribute array for radius and angle.
+    Renderer::Mesh m_compositeMesh;                                                                 //!< The composite shader mesh.
+    Renderer::VertexBuffer<Renderer::Point> m_radiusAngle{Renderer::VertexBufferUsage::StreamDraw}; //!< Additional vertex attribute array for radius and angle.
 
     int m_viewportWidth{};  //!< Last known viewport width.
     int m_viewportHeight{}; //!< Last known viewport height.
 
     std::unique_ptr<MilkdropShader> m_compositeShader; //!< The composite shader. Either preset-defined or empty.
-    std::unique_ptr<VideoEcho> m_videoEcho; //!< Video echo effect. Used if no composite shader is loaded and video echo is enabled.
-    std::unique_ptr<Filters> m_filters; //!< Color post-processing filters. Used if no composite shader is loaded.
+    std::unique_ptr<VideoEcho> m_videoEcho;            //!< Video echo effect. Used if no composite shader is loaded and video echo is enabled.
+    std::unique_ptr<Filters> m_filters;                //!< Color post-processing filters. Used if no composite shader is loaded.
 };
 
 } // namespace MilkdropPreset

src/libprojectM/MilkdropPreset/PerPixelMesh.hpp

@@ -122,12 +122,12 @@ class PerPixelMesh
     int m_viewportWidth{};  //!< Last known viewport width.
     int m_viewportHeight{}; //!< Last known viewport height.
 
-    Renderer::Mesh m_warpMesh;                                //!< The Warp effect mesh
-    Renderer::VertexBuffer<RadiusAngle> m_radiusAngleBuffer;  //!< Vertex attribute buffer for radius and angle values.
-    Renderer::VertexBuffer<ZoomRotWarp> m_zoomRotWarpBuffer;  //!< Vertex attribute buffer for zoom, roation and warp values.
-    Renderer::VertexBuffer<Renderer::Point> m_centerBuffer;   //!< Vertex attribute buffer for center coordinate values.
-    Renderer::VertexBuffer<Renderer::Point> m_distanceBuffer; //!< Vertex attribute buffer for distance values.
-    Renderer::VertexBuffer<Renderer::Point> m_stretchBuffer;  //!< Vertex attribute buffer for stretch values.
+    Renderer::Mesh m_warpMesh;                                                                         //!< The Warp effect mesh
+    Renderer::VertexBuffer<RadiusAngle> m_radiusAngleBuffer{Renderer::VertexBufferUsage::StreamDraw};  //!< Vertex attribute buffer for radius and angle values.
+    Renderer::VertexBuffer<ZoomRotWarp> m_zoomRotWarpBuffer{Renderer::VertexBufferUsage::StreamDraw};  //!< Vertex attribute buffer for zoom, roation and warp values.
+    Renderer::VertexBuffer<Renderer::Point> m_centerBuffer{Renderer::VertexBufferUsage::StreamDraw};   //!< Vertex attribute buffer for center coordinate values.
+    Renderer::VertexBuffer<Renderer::Point> m_distanceBuffer{Renderer::VertexBufferUsage::StreamDraw}; //!< Vertex attribute buffer for distance values.
+    Renderer::VertexBuffer<Renderer::Point> m_stretchBuffer{Renderer::VertexBufferUsage::StreamDraw};  //!< Vertex attribute buffer for stretch values.
 
     std::weak_ptr<Renderer::Shader> m_perPixelMeshShader;             //!< Special shader which calculates the per-pixel UV coordinates.
     std::unique_ptr<MilkdropShader> m_warpShader;                     //!< The warp shader. Either preset-defined or a default shader.

src/libprojectM/Renderer/BlendMode.hpp

@@ -5,9 +5,16 @@
 namespace libprojectM {
 namespace Renderer {
 
+/**
+ * A simple wrapper class around OpenGL's blend mode functionality.
+ */
 class BlendMode
 {
 public:
+    /**
+     * Available blend functions.
+     * @see https://registry.khronos.org/OpenGL-Refpages/gl4/html/glBlendFunc.xhtml
+     */
     enum class Function : int
     {
         Zero,
@@ -33,67 +40,35 @@ class BlendMode
 
     BlendMode() = delete;
 
-    static void Set(bool enable, Function srcFunc, Function dstFunc)
-    {
-        SetBlendActive(enable);
-        SetBlendFunction(srcFunc, dstFunc);
-    }
+    /**
+     * @brief Enables or disables blending and sets the blend functions.
+     * A convenience wrapper around BlendMode::SetBlendActive() and BlendMode::SetBlendFunction().
+     * @param enable If true, blending is enabled, otherwise disabled.
+     * @param srcFunc The blend function to determine the source color.
+     * @param dstFunc the blend function to determine the destination color.
+     */
+    static void Set(bool enable, Function srcFunc, Function dstFunc);
 
-    static void SetBlendActive(bool enable)
-    {
-        if (enable)
-        {
-            glEnable(GL_BLEND);
-        }
-        else
-        {
-            glDisable(GL_BLEND);
-        }
-    }
+    /**
+     * Enables or disables blending.
+     * @param enable If true, blending is enabled, otherwise disabled.
+     */
+    static void SetBlendActive(bool enable);
 
-    static void SetBlendFunction(Function srcFunc, Function dstFunc)
-    {
-        glBlendFunc(FunctionToGL(srcFunc), FunctionToGL(dstFunc));
-    }
+    /**
+     * Sets the blend functions.
+     * @param srcFunc The blend function to determine the source color.
+     * @param dstFunc the blend function to determine the destination color.
+     */
+    static void SetBlendFunction(Function srcFunc, Function dstFunc);
 
 private:
-    static GLuint FunctionToGL(Function func)
-    {
-        switch (func)
-        {
-            case Function::Zero:
-                return GL_ZERO;
-            case Function::One:
-            default:
-                return GL_ONE;
-            case Function::SourceColor:
-                return GL_SRC_COLOR;
-            case Function::OneMinusSourceColor:
-                return GL_ONE_MINUS_SRC_COLOR;
-            case Function::DestinationColor:
-                return GL_DST_COLOR;
-            case Function::OneMinusDestinationColor:
-                return GL_ONE_MINUS_DST_COLOR;
-            case Function::SourceAlpha:
-                return GL_SRC_ALPHA;
-            case Function::OneMinusSourceAlpha:
-                return GL_ONE_MINUS_SRC_ALPHA;
-            case Function::DestinationAlpha:
-                return GL_DST_ALPHA;
-            case Function::OneMinusDestinationAlpha:
-                return GL_ONE_MINUS_DST_ALPHA;
-            case Function::ConstantColor:
-                return GL_CONSTANT_COLOR;
-            case Function::OneMinusConstantColor:
-                return GL_ONE_MINUS_CONSTANT_COLOR;
-            case Function::ConstantAlpha:
-                return GL_CONSTANT_ALPHA;
-            case Function::OneMinusConstantAlpha:
-                return GL_ONE_MINUS_CONSTANT_ALPHA;
-            case Function::SourceAlphaSaturate:
-                return GL_SRC_ALPHA_SATURATE;
-        }
-    }
+    /**
+     * Translates the Function enum values into OpenGL constants.
+     * @param func The blend function to translate.
+     * @return the OpenGL constant for the given blend function.
+     */
+    static GLuint FunctionToGL(Function func);
 };
 
 } // namespace Renderer

src/libprojectM/Renderer/Color.hpp

@@ -162,6 +162,10 @@ class Color
                      Modulo(col.A()));
     }
 
+    /**
+     * @brief Initializes the attribute array pointer for this storage type.
+     * @param attributeIndex the attribute index to use.
+     */
     static void InitializeAttributePointer(uint32_t attributeIndex)
     {
         glVertexAttribPointer(attributeIndex, sizeof(Color) / sizeof(float), GL_FLOAT, GL_FALSE, sizeof(Color), nullptr);

src/libprojectM/Renderer/Mesh.cpp

@@ -12,16 +12,18 @@ Mesh::Mesh(VertexBufferUsage usage)
     : m_vertices(usage)
     , m_colors(usage)
     , m_textureUVs(usage)
+    , m_indices(usage)
 {
     Initialize();
 }
 
 Mesh::Mesh(VertexBufferUsage usage, bool useColor, bool useTextureUVs)
-    : m_vertices(usage)
+    : m_useColorAttributes(useColor)
+    , m_useUVAttributes(useTextureUVs)
+    , m_vertices(usage)
     , m_colors(usage)
     , m_textureUVs(usage)
-    , m_useColorAttributes(useColor)
-    , m_useUVAttributes(useTextureUVs)
+    , m_indices(usage)
 {
     Initialize();
 }