ofFunctions to retrieve information about internal render state (#7757)

Author: artificiel

libs/openFrameworks/app/ofAppRunner.h

@@ -1,8 +1,8 @@
 #pragma once
 
-#include "ofWindowSettings.h"
 #include "ofConstants.h"
 #include "ofMainLoop.h"
+#include "ofWindowSettings.h"
 
 class ofRectangle;
 class ofAppBaseWindow;
@@ -11,15 +11,14 @@ class ofBaseApp;
 class ofBaseRenderer;
 class ofCoreEvents;
 
-
 void ofInit();
-void ofSetupOpenGL(int w, int h, ofWindowMode screenMode);	// sets up the opengl context!
-std::shared_ptr<ofAppBaseWindow> ofCreateWindow(const ofWindowSettings & settings);	// sets up the opengl context!
+void ofSetupOpenGL(int w, int h, ofWindowMode screenMode); // sets up the opengl context!
+std::shared_ptr<ofAppBaseWindow> ofCreateWindow(const ofWindowSettings & settings); // sets up the opengl context!
 std::shared_ptr<ofMainLoop> ofGetMainLoop();
 void ofSetMainLoop(const std::shared_ptr<ofMainLoop> & mainLoop);
 
-template<typename Window>
-void ofSetupOpenGL(const std::shared_ptr<Window> & windowPtr, int w, int h, ofWindowMode screenMode){
+template <typename Window>
+void ofSetupOpenGL(const std::shared_ptr<Window> & windowPtr, int w, int h, ofWindowMode screenMode) {
 	ofInit();
 	ofWindowSettings settings;
 	settings.setSize(w, h);
@@ -32,83 +31,83 @@ void ofSetupOpenGL(const std::shared_ptr<Window> & windowPtr, int w, int h, ofWi
 //TODO: remove me when we remove the ofSetupOpenGL legacy approach.
 void ofSetupOpenGL(const std::shared_ptr<ofAppGLFWWindow> & windowPtr, int w, int h, ofWindowMode screenMode);
 
-template<typename Window>
-static void noopDeleter(Window*){}
+template <typename Window>
+static void noopDeleter(Window *) { }
 
-template<typename Window>
-void ofSetupOpenGL(Window * windowPtr, int w, int h, ofWindowMode screenMode){
+template <typename Window>
+void ofSetupOpenGL(Window * windowPtr, int w, int h, ofWindowMode screenMode) {
 	std::shared_ptr<Window> window = std::shared_ptr<Window>(windowPtr, std::function<void(Window *)>(noopDeleter<Window>));
-	ofSetupOpenGL(window,w,h,screenMode);
+	ofSetupOpenGL(window, w, h, screenMode);
 }
 
-
 int ofRunApp(std::shared_ptr<ofBaseApp> && OFSA);
 int ofRunApp(ofBaseApp * OFSA = nullptr); // will be deprecated
 void ofRunApp(const std::shared_ptr<ofAppBaseWindow> & window, std::shared_ptr<ofBaseApp> && app);
 int ofRunMainLoop();
 
-
 ofBaseApp * ofGetAppPtr();
 
-void		ofExit(int status=0);
+void ofExit(int status = 0);
 
-bool 		ofIsCurrentThreadTheMainThread();
+bool ofIsCurrentThreadTheMainThread();
 std::thread::id ofGetMainThreadId();
 
 //-------------------------- time
-float 		ofGetFrameRate();
-float 		ofGetTargetFrameRate();
-uint64_t	ofGetFrameNum();
-void 		ofSetFrameRate(int targetRate);
-double		ofGetLastFrameTime();
-void		ofSetTimeModeSystem();
-uint64_t	ofGetFixedStepForFps(double fps);
-void		ofSetTimeModeFixedRate(uint64_t stepNanos = ofGetFixedStepForFps(60)); //default nanos for 1 frame at 60fps
-void		ofSetTimeModeFiltered(float alpha = 0.9);
-
-void		ofSetOrientation(ofOrientation orientation, bool vFlip=true);
-ofOrientation			ofGetOrientation();
+float ofGetFrameRate();
+float ofGetTargetFrameRate();
+bool ofGetTargetFrameRateEnabled();
+uint64_t ofGetFrameNum();
+void ofSetFrameRate(int targetRate);
+double ofGetLastFrameTime();
+void ofSetTimeModeSystem();
+ofTimeMode ofGetTimeMode();
+uint64_t ofGetFixedStepForFps(double fps);
+void ofSetTimeModeFixedRate(uint64_t stepNanos = ofGetFixedStepForFps(60)); //default nanos for 1 frame at 60fps
+void ofSetTimeModeFiltered(float alpha = 0.9);
+
+void ofSetOrientation(ofOrientation orientation, bool vFlip = true);
+ofOrientation ofGetOrientation();
 
 //-------------------------- cursor
-void 		ofHideCursor();
-void 		ofShowCursor();
+void ofHideCursor();
+void ofShowCursor();
 //-------------------------- window / screen
-int 		ofGetWindowPositionX();
-int 		ofGetWindowPositionY();
-int 		ofGetScreenWidth();
-int 		ofGetScreenHeight();
-int			ofGetWindowMode();
-int 		ofGetWidth();			// ofGetWidth is correct for orientation
-int 		ofGetHeight();
-int 		ofGetWindowWidth();			// ofGetWindowWidth is correct for actual window coordinates - so doesn't change with orientation.
-int 		ofGetWindowHeight();
+int ofGetWindowPositionX();
+int ofGetWindowPositionY();
+int ofGetScreenWidth();
+int ofGetScreenHeight();
+int ofGetWindowMode();
+int ofGetWidth(); // ofGetWidth is correct for orientation
+int ofGetHeight();
+int ofGetWindowWidth(); // ofGetWindowWidth is correct for actual window coordinates - so doesn't change with orientation.
+int ofGetWindowHeight();
 
 std::string ofGetClipboardString();
-void		ofSetClipboardString(const std::string & str);
+void ofSetClipboardString(const std::string & str);
 
 /// \returns a random number between 0 and the width of the window.
 float ofRandomWidth();
 
 /// \returns a random number between 0 and the height of the window.
 float ofRandomHeight();
-bool		ofDoesHWOrientation();
-glm::vec2	ofGetWindowSize();
-ofRectangle	ofGetWindowRect();
+bool ofDoesHWOrientation();
+glm::vec2 ofGetWindowSize();
+ofRectangle ofGetWindowRect();
 ofAppBaseWindow * ofGetWindowPtr();
 std::shared_ptr<ofAppBaseWindow> ofGetCurrentWindow();
 
-void 		ofSetWindowPosition(int x, int y);
-void 		ofSetWindowShape(int width, int height);
-void 		ofSetWindowTitle(std::string title);
-void		ofEnableSetupScreen();
-void		ofDisableSetupScreen();
-void		ofSetFullscreen(bool fullscreen);
-void		ofToggleFullscreen();
+void ofSetWindowPosition(int x, int y);
+void ofSetWindowShape(int width, int height);
+void ofSetWindowTitle(std::string title);
+void ofEnableSetupScreen();
+void ofDisableSetupScreen();
+void ofSetFullscreen(bool fullscreen);
+void ofToggleFullscreen();
 //-------------------------- sync
-void 		ofSetVerticalSync(bool bSync);
+void ofSetVerticalSync(bool bSync);
 
 ofCoreEvents & ofEvents();
-void ofSetCurrentRenderer(std::shared_ptr<ofBaseRenderer> renderer,bool setDefaults=false);
+void ofSetCurrentRenderer(std::shared_ptr<ofBaseRenderer> renderer, bool setDefaults = false);
 std::shared_ptr<ofBaseRenderer> & ofGetCurrentRenderer();
 void ofSetEscapeQuitsApp(bool bQuitOnEsc);
 
@@ -117,8 +116,8 @@ void ofSetEscapeQuitsApp(bool bQuitOnEsc);
 typedef unsigned long Window;
 struct _XDisplay;
 typedef struct _XDisplay Display;
-Display* ofGetX11Display();
-Window  ofGetX11Window();
+Display * ofGetX11Display();
+Window ofGetX11Window();
 #endif
 
 #if defined(TARGET_LINUX) && !defined(TARGET_OPENGLES)
@@ -134,11 +133,11 @@ EGLSurface ofGetEGLSurface();
 #endif
 
 #if defined(TARGET_OSX)
-	void * ofGetNSGLContext();
-	void * ofGetCocoaWindow();
+void * ofGetNSGLContext();
+void * ofGetCocoaWindow();
 #endif
 
 #if defined(TARGET_WIN32)
-	HGLRC ofGetWGLContext();
-	HWND ofGetWin32Window();
+HGLRC ofGetWGLContext();
+HWND ofGetWin32Window();
 #endif