// SPDX-License-Identifier: MIT // // EmulationStation Desktop Edition // Window.h // // Window management, screensaver management, help prompts and splash screen. // The input stack starts here as well, as this is the first instance called by InputManager. // #ifndef ES_CORE_WINDOW_H #define ES_CORE_WINDOW_H #include "HelpPrompt.h" #include "InputConfig.h" #include "Settings.h" #include "resources/TextureResource.h" #include #include #include class FileData; class Font; class GuiComponent; class GuiInfoPopup; class HelpComponent; class ImageComponent; class InputConfig; class TextCache; struct HelpStyle; class Window { public: class Screensaver { public: virtual bool isScreensaverActive() = 0; virtual bool isFallbackScreensaver() = 0; virtual void startScreensaver(bool generateMediaList) = 0; virtual void stopScreensaver() = 0; virtual void nextGame() = 0; virtual void launchGame() = 0; virtual void goToGame() = 0; virtual void renderScreensaver() = 0; virtual void update(int deltaTime) = 0; virtual FileData* getCurrentGame() = 0; virtual void triggerNextGame() = 0; }; class MediaViewer { public: virtual bool startMediaViewer(FileData* game) = 0; virtual void stopMediaViewer() = 0; virtual void launchPDFViewer() = 0; virtual void showNext() = 0; virtual void showPrevious() = 0; virtual void showFirst() = 0; virtual void showLast() = 0; virtual void update(int deltaTime) = 0; virtual void render(const glm::mat4& parentTrans) = 0; virtual std::vector getHelpPrompts() = 0; }; class PDFViewer { public: virtual bool startPDFViewer(FileData* game) = 0; virtual void stopPDFViewer() = 0; virtual void launchMediaViewer() = 0; virtual void navigateUp() = 0; virtual void navigateDown() = 0; virtual void navigateLeft() = 0; virtual void navigateRight() = 0; virtual void navigateLeftShoulder() = 0; virtual void navigateRightShoulder() = 0; virtual void navigateLeftTrigger() = 0; virtual void navigateRightTrigger() = 0; virtual void render(const glm::mat4& parentTrans) = 0; virtual std::vector getHelpPrompts() = 0; }; class GuiLaunchScreen { public: virtual void displayLaunchScreen(FileData* game) = 0; virtual void closeLaunchScreen() = 0; virtual void update(int deltaTime) = 0; virtual void render(const glm::mat4& parentTrans) = 0; }; static Window* getInstance(); void pushGui(GuiComponent* gui); void removeGui(GuiComponent* gui); GuiComponent* peekGui(); int getGuiStackSize() { return static_cast(mGuiStack.size()); } bool isBackgroundDimmed(); bool init(); void deinit(); void input(InputConfig* config, Input input); void textInput(const std::string& text); void logInput(InputConfig* config, Input input); void update(int deltaTime); void render(); void normalizeNextUpdate() { mNormalizeNextUpdate = true; } enum class SplashScreenState { SCANNING, POPULATING, RELOADING }; void renderSplashScreen(SplashScreenState state, float progress); // The list scroll overlay is triggered from IList when the highest scrolling tier is reached. void renderListScrollOverlay(const float opacity, const std::string& text); void renderHelpPromptsEarly(); // Used to render HelpPrompts before a fade. void setHelpPrompts(const std::vector& prompts, const HelpStyle& style); // GuiInfoPopup notifications. void queueInfoPopup(const std::string& message, const int& duration) { mInfoPopupQueue.emplace(std::make_pair(message, duration)); } void stopInfoPopup(); void startScreensaver(bool onTimer); bool stopScreensaver(); void renderScreensaver(); void screensaverTriggerNextGame() { mScreensaver->triggerNextGame(); } void setScreensaver(Screensaver* screensaver) { mScreensaver = screensaver; } bool isScreensaverActive() { return mRenderScreensaver; } void startMediaViewer(FileData* game); void stopMediaViewer(); void setMediaViewer(MediaViewer* mediaViewer) { mMediaViewer = mediaViewer; } bool isMediaViewerActive() { return mRenderMediaViewer; } void startPDFViewer(FileData* game); void stopPDFViewer(); void setPDFViewer(PDFViewer* pdfViewer) { mPDFViewer = pdfViewer; } bool isPDFViewerActive() { return mRenderPDFViewer; } void displayLaunchScreen(FileData* game); void closeLaunchScreen(); void setLaunchScreen(GuiLaunchScreen* launchScreen) { mLaunchScreen = launchScreen; } bool isLaunchScreenDisplayed() { return mRenderLaunchScreen; } void increaseVideoPlayerCount() { ++mVideoPlayerCount; } void decreaseVideoPlayerCount() { --mVideoPlayerCount; } int getVideoPlayerCount(); void setLaunchedGame(bool state) { mGameLaunchedState = state; } void invalidateCachedBackground(); bool isInvalidatingCachedBackground() { return mInvalidateCacheTimer > 0; } bool getGameLaunchedState() { return mGameLaunchedState; } void setAllowTextScrolling(bool value) { mAllowTextScrolling = value; } bool getAllowTextScrolling() { return mAllowTextScrolling; } // For GIF and Lottie animations. void setAllowFileAnimation(bool value) { mAllowFileAnimation = value; } bool getAllowFileAnimation() { return mAllowFileAnimation; } void setChangedThemeSet() { mChangedThemeSet = true; } bool getChangedThemeSet() { return mChangedThemeSet; } private: Window() noexcept; ~Window(); // Returns true if at least one component on the stack is processing. bool isProcessing(); struct ProgressBarRectangle { float barWidth; float barHeight; float barPosX; float barPosY; unsigned int color; }; Renderer* mRenderer; std::unique_ptr mHelp; std::unique_ptr mBackgroundOverlay; std::unique_ptr mSplash; std::unique_ptr mSplashTextScanning; std::unique_ptr mSplashTextPopulating; std::unique_ptr mSplashTextReloading; glm::vec4 mSplashTextPositions; std::vector mProgressBarRectangles; float mBackgroundOverlayOpacity; std::vector mGuiStack; std::vector> mDefaultFonts; std::unique_ptr mFrameDataText; Screensaver* mScreensaver; MediaViewer* mMediaViewer; PDFViewer* mPDFViewer; GuiLaunchScreen* mLaunchScreen; GuiInfoPopup* mInfoPopup; std::queue> mInfoPopupQueue; std::shared_ptr mPostprocessedBackground; std::string mListScrollText; std::shared_ptr mListScrollFont; float mListScrollOpacity; int mFrameTimeElapsed; int mFrameCountElapsed; int mAverageDeltaTime; unsigned int mTimeSinceLastInput; bool mNormalizeNextUpdate; bool mRenderScreensaver; bool mRenderMediaViewer; bool mRenderLaunchScreen; bool mRenderPDFViewer; bool mGameLaunchedState; bool mAllowTextScrolling; bool mAllowFileAnimation; bool mCachedBackground; bool mInvalidatedCachedBackground; bool mInitiateCacheTimer; int mInvalidateCacheTimer; std::atomic mVideoPlayerCount; float mTopScale; bool mRenderedHelpPrompts; bool mChangedThemeSet; }; #endif // ES_CORE_WINDOW_H