Skip to content
Snippets Groups Projects
Commit 9978a703 authored by Sebastian Gaida's avatar Sebastian Gaida
Browse files

[#20][Doku] add comments to Window.hpp

parent 3ae2723e
No related branches found
No related tags found
1 merge request!11Resolve "Add Doxygen comments to existing code"
......@@ -12,19 +12,47 @@ namespace vkcv {
GLFWwindow *m_window;
public:
/**
* creates a GLFWwindow with the parameters in the function
* @param windowTitle
* @param width
* @param height
* @param resizable
* @return Window class
*/
static Window create(const char *windowTitle, int width = -1, int height = -1, bool resizable = false);
/**
* checks if the window is still open, or the close event was called
* This function should be changed/removed later on
* @return bool if the window is still open
*/
[[nodiscard]]
bool isWindowOpen() const;
/**
* polls all events on the GLFWwindow
*/
static void pollEvents();
/**
* returns the current window
* @return window handle
*/
[[nodiscard]]
GLFWwindow *getWindow() const;
/**
* gets the current window width
* @return int with window width
*/
[[nodiscard]]
int getWidth() const;
/**
* gets the current window height
* @return int with window height
*/
[[nodiscard]]
int getHeight() const;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment