Add user sprite proxy functions to ProjectM class.

Author: kblaschke

src/libprojectM/ProjectM.cpp

@@ -33,6 +33,8 @@
 #include <Renderer/ShaderCache.hpp>
 #include <Renderer/TransitionShaderManager.hpp>
 
+#include <UserSprites/SpriteManager.hpp>
+
 namespace libprojectM {
 
 ProjectM::ProjectM()
@@ -178,6 +180,9 @@ void ProjectM::RenderFrame(uint32_t targetFramebufferObject /*= 0*/)
         m_textureCopier->Draw(m_activePreset->OutputTexture(), false, false);
     }
 
+    // Draw user sprites
+    m_spriteManager->Draw(audioData, renderContext, targetFramebufferObject, { m_activePreset, m_transitioningPreset });
+
     m_frameCount++;
     m_previousFrameVolume = audioData.vol;
 }
@@ -201,6 +206,8 @@ void ProjectM::Initialize()
 
     m_textureCopier = std::make_unique<Renderer::CopyTexture>();
 
+    m_spriteManager = std::make_unique<UserSprites::SpriteManager>();
+
     m_presetFactoryManager->initialize();
 
     /* Set the seed to the current time in seconds */
@@ -270,6 +277,41 @@ auto ProjectM::WindowHeight() -> int
     return m_windowHeight;
 }
 
+auto ProjectM::AddUserSprite(const std::string& type, const std::string& spriteData) -> uint32_t
+{
+    return m_spriteManager->Spawn(type, spriteData, GetRenderContext());
+}
+
+void ProjectM::DestroyUserSprite(uint32_t spriteIdentifier)
+{
+    m_spriteManager->Destroy(spriteIdentifier);
+}
+
+void ProjectM::DestroyAllUserSprites()
+{
+    m_spriteManager->DestroyAll();
+}
+
+auto ProjectM::UserSpriteCount() const -> uint32_t
+{
+    return m_spriteManager->ActiveSpriteCount();
+}
+
+void ProjectM::SetUserSpriteLimit(uint32_t maxSprites)
+{
+    m_spriteManager->SpriteSlots(maxSprites);
+}
+
+auto ProjectM::UserSpriteLimit() const -> uint32_t
+{
+    return m_spriteManager->SpriteSlots();
+}
+
+auto ProjectM::UserSpriteIdentifiers() const -> std::vector<uint32_t>
+{
+    return m_spriteManager->ActiveSpriteIdentifiers();
+}
+
 void ProjectM::SetPresetLocked(bool locked)
 {
     // ToDo: Add a preset switch timer separate from the display timer and reset to 0 when

src/libprojectM/ProjectM.hpp

@@ -27,6 +27,7 @@
 #include <Audio/PCM.hpp>
 
 #include <memory>
+#include <set>
 #include <string>
 #include <vector>
 
@@ -41,6 +42,10 @@ class ShaderCache;
 class TransitionShaderManager;
 } // namespace Renderer
 
+namespace UserSprites {
+class SpriteManager;
+} // namespace UserSprites
+
 class Preset;
 class PresetFactoryManager;
 class TimeKeeper;
@@ -192,6 +197,51 @@ class PROJECTM_EXPORT ProjectM
 
     auto WindowHeight() -> int;
 
+    /**
+     * @brief Creates a new user sprite.
+     * @param type The type of the sprite to create.
+     * @param spriteData The type-dependent sprite data.
+     * @return A unique, non-zero sprite identifier if the sprite was created successfully,
+     *         or zero if any error occurred or the sprite limit was reached.
+     */
+    auto AddUserSprite(const std::string& type, const std::string& spriteData) -> uint32_t;
+
+    /**
+     * @brief Destroys a single sprite using its identifier.
+     * @param spriteIdentifier The identifier of the sprite to destroy.
+     */
+    void DestroyUserSprite(uint32_t spriteIdentifier);
+
+    /**
+     * @brief Destroys all active user sprites.
+     */
+    void DestroyAllUserSprites();
+
+    /**
+     * @brief Returns the current user sprite count.
+     * @return The number of currently active user sprites.
+     */
+    auto UserSpriteCount() const -> uint32_t;
+
+    /**
+     * @brief Sets a new limit for user sprites.
+     * Any sprites above the new limit will be removed in order, oldest first.
+     * @param maxSprites The new sprite limit. 0 disables sprites, 16 is the default.
+     */
+    void SetUserSpriteLimit(uint32_t maxSprites);
+
+    /**
+     * @brief Returns the current user sprite display limit.
+     * @return The current user sprite limit.
+     */
+    auto UserSpriteLimit() const -> uint32_t;
+
+    /**
+     * @brief Returns a list of identifiers for all active user sprites.
+     * @return A list of all active user sprite identifiers, ordered by age (oldest first).
+     */
+    auto UserSpriteIdentifiers() const -> std::vector<uint32_t>;
+
 private:
     void Initialize();
 
@@ -235,6 +285,7 @@ class PROJECTM_EXPORT ProjectM
     std::unique_ptr<Preset> m_transitioningPreset;                                //!< Destination preset when smooth preset switching.
     std::unique_ptr<Renderer::PresetTransition> m_transition;                     //!< Transition effect used for blending.
     std::unique_ptr<TimeKeeper> m_timeKeeper;                                     //!< Keeps the different timers used to render and switch presets.
+    std::unique_ptr<UserSprites::SpriteManager> m_spriteManager;                  //!< Manages all types of user sprites.
 };
 
 } // namespace libprojectM