FrameListener.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   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.
 
 */
 
#pragma once
#ifndef DVD_FRAME_LISTENER_H_
#define DVD_FRAME_LISTENER_H_
 
 
namespace Divide {
 
enum class FrameEventType : U8 {
    FRAME_EVENT_ANY = 0,
    FRAME_EVENT_STARTED,
    FRAME_PRERENDER,
    FRAME_SCENERENDER_START,
    FRAME_SCENERENDER_END,
    FRAME_POSTRENDER,
    FRAME_EVENT_PROCESS,
    FRAME_EVENT_ENDED,
};
 
struct FrameEvent {
    struct Time {
        struct Impl {
            U64 _deltaTimeUS;
            U64 _currentTimeUS;
        } _app, _game;
    } _time; 
 
    FrameEventType _type;
};
 
class FrameListenerManager;
class FrameListener : public GUIDWrapper {
   public:
    explicit FrameListener(const Str<64>& name, FrameListenerManager& parent, U32 callOrder);
    virtual ~FrameListener() override;
 
    bool operator<(FrameListener& that) const noexcept {
        return this->_callOrder < that._callOrder;
    }
 
   protected:
    friend class FrameListenerManager;
    void setCallOrder(const U32 order) noexcept { _callOrder = order; }
    [[nodiscard]] virtual bool frameStarted([[maybe_unused]] const FrameEvent& evt) { return true; }
    [[nodiscard]] virtual bool framePreRender([[maybe_unused]] const FrameEvent& evt) { return true; }
    [[nodiscard]] virtual bool frameSceneRenderStarted([[maybe_unused]] const FrameEvent& evt) { return true; }
    [[nodiscard]] virtual bool frameSceneRenderEnded([[maybe_unused]] const FrameEvent& evt) { return true; }
    [[nodiscard]] virtual bool frameRenderingQueued([[maybe_unused]] const FrameEvent& evt) { return true; }
    [[nodiscard]] virtual bool framePostRender([[maybe_unused]] const FrameEvent& evt) { return true; }
    [[nodiscard]] virtual bool frameEnded([[maybe_unused]] const FrameEvent& evt) { return true; }
 
    PROPERTY_R_IW(bool, enabled, false);
    PROPERTY_RW(Str<64>, name);
 
   private:
    FrameListenerManager& _mgr;
    U32 _callOrder{0u};
};
 
}  // namespace Divide
#endif //DVD_FRAME_LISTENER_H_