GraphicsUpdater.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Graphics
File: GraphicsUpdater
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include "NDEVRGraphics/Headers/GraphicsPipeline.h"
#include "NDEVRGraphics/Headers/GraphicsUpdateArguments.h"
#include "Design/Headers/DesignObjectUpdateTarget.h"
#include "Base/Headers/ConcurrentOperation.h"
#include "Base/Headers/Thread.h"
namespace NDEVR
{
    class Exception;
    class CheckoutLock;
    class Renderer;
    class GraphicsSession;
    /**--------------------------------------------------------------------------------------------------
    \brief Responsible for updating resources or layouts of data in-between calls to render.
    **/
    class NDEVR_GRAPHICS_API GraphicsUpdater : public DesignObjectUpdateTarget
    {
        friend class CheckoutLock;
    public:
        GraphicsUpdater(DesignObjectLookup* lookup, const DynamicPointer<GraphicsDevice>& device, ProgressInfo* log = nullptr);
        ~GraphicsUpdater();
        void update(DesignObjectLookup* lookup, Time time) override;
        void setLog(ProgressInfo* log)
        {
            m_args.log = log;
        }
        void setLookup(DesignObjectLookup* lookup)
        {
            m_args.lookup = lookup;
        }
        Time lastUpdateTime() const
        {
            return m_last_update_time;
        }
        bool hasManager(const UUID& id);
        void addManager(const UUID& id, Renderer* renderer);
        void removeManager(const UUID& id);
        CheckoutLock tryCheckout(const UUID& id, bool wait_until_ready);
        CheckoutLock checkout(const UUID& id, bool wait_until_ready);
        const DynamicPointer<GraphicsDevice>& device() const { return m_device; };
        void addPipeline(GraphicsPipeline* pipline)
        {
            WLock lock(this);
            m_pipelines.add(pipline);
        }
        void removePipeline(GraphicsPipeline* pipline);
        GraphicsUpdateArguments& args() { return m_args; }
        void recreate();
        //void recoverFromDeviceLost();
        static GraphicsUpdater* DefaultUpdater(DesignObjectLookup* lookup, ProgressInfo* log, DynamicPointer<GraphicsDevice> device);
        void setExceptionCallback(const std::function<void(const Exception&)>& callback) { m_exception_callback = callback; };
        void setIsGrabSetup(bool grab_setup);
        void update();
        void update(GraphicsUpdateArguments& args);
    private:
        RLock _checkout(const UUID& id, bool wait_until_ready);
        void checkin(const UUID& id);
        bool renderNeedsUpdate() const;
        bool createPipeline(GraphicsUpdateArguments& args);
        void updateUniformBuffer(GraphicsUpdateArguments& args);
    protected:
        DynamicPointer<GraphicsDevice> m_device;
        std::function<void(const Exception&)> m_exception_callback;
        volatile uint04 m_total_checked_out_count;
        Dictionary<UUID, bool> needs_update;
        Dictionary<UUID, Renderer*> m_renderers;
        Time m_last_update_time;
        GraphicsUpdateArguments m_args;
        Buffer<GraphicsPipeline*> m_pipelines;
        std::mutex m_critical_section;//critical section for this object only
        bool m_grab_setup;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Used by Viewports to signal they are rendering and we should not be performing an Update
    **/
    class CheckoutLock
    {
    public:
        CheckoutLock(GraphicsUpdater* updater, bool wait_until_ready, UUID id = Constant<UUID>::Invalid)
            : m_updater(updater)
            , m_id(id)
            , m_lock(!IsInvalid(m_id) ? m_updater->_checkout(m_id, wait_until_ready) : RLock(&m_id))
        {}
        CheckoutLock(const CheckoutLock& checkout) = delete;
        CheckoutLock(CheckoutLock&& checkout)
            : m_updater(checkout.m_updater)
            , m_id(checkout.m_id)
            , m_lock(std::move(checkout.m_lock))
        {
            checkout.m_id = Constant<UUID>::Invalid;
        }
        ~CheckoutLock()
        {
            if(!IsInvalid(m_id))
                m_updater->checkin(m_id);
        }
        bool isCheckedOut()
        {
            return (!IsInvalid(m_id));
        }
    protected:
        GraphicsUpdater* m_updater;
        UUID m_id;
        RLock m_lock;
    };
}