From dd51ec0f1fadd719f5ee298c1c40890f6db1815b Mon Sep 17 00:00:00 2001 From: TravisBot <> Date: Thu, 12 Oct 2017 13:59:45 +0000 Subject: Rebuilding documentation --- window_8h_source.html | 128 ++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 103 insertions(+), 25 deletions(-) (limited to 'window_8h_source.html') diff --git a/window_8h_source.html b/window_8h_source.html index 2d013e41..d4fc17fe 100644 --- a/window_8h_source.html +++ b/window_8h_source.html @@ -3,22 +3,23 @@ - - + YAGE: yage/base/window.h Source File - - + @@ -27,7 +28,7 @@ -
+
YAGE  v0.1.1
@@ -38,19 +39,40 @@
- + - - - - + +
+ All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
@@ -85,20 +107,76 @@ $(document).ready(function(){initNavTree('window_8h_source.html','');});
window.h
-Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * window.h
3  *
4  * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> -- MIT License
5  * See file LICENSE for more details
6  * ----------------------------------------------------------------------------
7  */
8 
12 #ifndef WINDOW_H
13 #define WINDOW_H
14 
15 #include <glad/glad.h>
16 
17 #include <GLFW/glfw3.h>
18 
19 #include <string>
20 
21 namespace yage
22 {
23 
24 // window flags that can change it's appearance
25 enum WindowFlags : unsigned {
26  SHOWN = 0x1,
27  HIDDEN = 0x2,
28  FULLSCREEN = 0x4,
29  BORDERLESS = 0x8,
30 };
31 
32 // window wrapper around GLFWwindow pointer
33 class Window
34 {
35 private:
37  GLFWwindow *window_ = nullptr;
38 
39 public:
40  Window();
41  Window(const Window &) = delete;
42  Window(Window &&) = delete;
44  ~Window();
45 
46  Window &operator=(const Window &) = delete;
47  Window &operator=(Window &&) = delete;
48 
50  void create(const std::string &window_name, int width, int height,
51  unsigned flags = WindowFlags::SHOWN);
53  void swapBuffer();
55  void clearBuffer();
57  void hide();
59  void show();
60 };
61 
62 } // namespace yage
63 
64 #endif
yage::HIDDEN
Definition: window.h:27
+Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
+
2  * window.h
+
3  *
+
4  * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> -- MIT License
+
5  * See file LICENSE for more details
+
6  * ----------------------------------------------------------------------------
+
7  */
+
8 
+
12 #ifndef WINDOW_H
+
13 #define WINDOW_H
+
14 
+
15 #include <glad/glad.h>
+
16 
+
17 #include <GLFW/glfw3.h>
+
18 
+
19 #include <string>
+
20 
+
21 namespace yage
+
22 {
+
23 
+
24 // window flags that can change it's appearance
+
25 enum WindowFlags : unsigned {
+
26  SHOWN = 0x1,
+
27  HIDDEN = 0x2,
+
28  FULLSCREEN = 0x4,
+
29  BORDERLESS = 0x8,
+
30 };
+
31 
+
32 // window wrapper around GLFWwindow pointer
+
33 class Window
+
34 {
+
35 private:
+
37  GLFWwindow *window_ = nullptr;
+
38 
+
39 public:
+
40  Window();
+
41  Window(const Window &) = delete;
+
42  Window(Window &&) = delete;
+
44  ~Window();
+
45 
+
46  Window &operator=(const Window &) = delete;
+
47  Window &operator=(Window &&) = delete;
+
48 
+
50  void create(std::string window_name, int width, int height);
+
52  void swapBuffer();
+
54  void clearBuffer();
+
56  void hide();
+
58  void show();
+
59  bool shouldClose();
+
60  void pollEvents() const;
+
61 };
+
62 
+
63 } // namespace yage
+
64 
+
65 #endif
+
yage::HIDDEN
Definition: window.h:27
-
yage::Window::swapBuffer
void swapBuffer()
swap the buffer
Definition: window.cpp:51
-
yage::Window::hide
void hide()
hide windowProc
Definition: window.cpp:65
+
yage::Window::swapBuffer
void swapBuffer()
swap the buffer
Definition: window.cpp:57
+
yage::Window::hide
void hide()
hide windowProc
Definition: window.cpp:69
yage::Window::window_
GLFWwindow * window_
window handle
Definition: window.h:37
yage::Window
Definition: window.h:33
-
yage::Window::create
void create(const std::string &window_name, int width, int height, unsigned flags=WindowFlags::SHOWN)
create the window, initialize the handle and update the width and height
Definition: window.cpp:23
+
yage::Window::shouldClose
bool shouldClose()
Definition: window.cpp:79
yage::FULLSCREEN
Definition: window.h:28
yage::WindowFlags
WindowFlags
Definition: window.h:25
yage::Window::~Window
~Window()
destroys the window handle
Definition: window.cpp:18
-
yage::Window::show
void show()
show window
Definition: window.cpp:70
+
yage::Window::show
void show()
show window
Definition: window.cpp:74
+
yage::Window::create
void create(std::string window_name, int width, int height)
create the window, initialize the handle and update the width and height
Definition: window.cpp:24
yage::SHOWN
Definition: window.h:26
-
yage::Window::clearBuffer
void clearBuffer()
clear buffer
Definition: window.cpp:57
-
yage
Project namespace.
Definition: camera2d.cpp:13
+
yage::Window::clearBuffer
void clearBuffer()
clear buffer
Definition: window.cpp:63
+
yage::Window::pollEvents
void pollEvents() const
Definition: window.cpp:84
yage::Window::operator=
Window & operator=(const Window &)=delete
yage::BORDERLESS
Definition: window.h:29
@@ -107,9 +185,9 @@ $(document).ready(function(){initNavTree('window_8h_source.html','');}); -- cgit