From c7dad1e929c0101386fbcdaa194e402d68f74752 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Wed, 23 Aug 2017 22:56:53 +0100 Subject: Updating docs --- window_8hpp_source.html | 56 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 45 insertions(+), 11 deletions(-) (limited to 'window_8hpp_source.html') diff --git a/window_8hpp_source.html b/window_8hpp_source.html index f437dfce..9351d22d 100644 --- a/window_8hpp_source.html +++ b/window_8hpp_source.html @@ -9,6 +9,13 @@ + + + + + @@ -44,6 +51,21 @@ $(function() { }); + +
+ +
+
+
+ +
- -
window.hpp
-
1 /* ----------------------------------------------------------------------------
2  * window.hpp
3  *
4  * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> -- MIT License
5  * See file LICENSE for more details
6  * ----------------------------------------------------------------------------
7  */
8 
9 #ifndef WINDOW_HPP
10 #define WINDOW_HPP
11 
12 #include <SDL2/SDL.h>
13 
14 #include <string>
15 
16 namespace yage {
17 
18 // window flags that can change it's appearance
19 enum WindowFlags : unsigned {
20  SHOWN = 0x1,
21  HIDDEN = 0x2,
22  FULLSCREEN = 0x4,
23  BORDERLESS = 0x8,
24 };
25 
26 // window wrapper around SDL_Window pointer
27 class Window {
28 private:
30  SDL_Window* window_ = nullptr;
31 
32 public:
33  Window();
34  Window(const Window&) = delete;
35  Window(Window&&) = delete;
37  ~Window();
38 
39  Window& operator=(const Window&) = delete;
40  Window& operator=(Window&&) = delete;
41 
43  void create(const std::string& window_name, int width, int height,
44  unsigned flags = WindowFlags::SHOWN);
46  void swapBuffer();
48  void clearBuffer();
49 };
50 
51 } // namespace yage
52 
53 #endif
yage
Definition: camera2d.hpp:17
+Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * window.hpp
3  *
4  * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> -- MIT License
5  * See file LICENSE for more details
6  * ----------------------------------------------------------------------------
7  */
8 
9 #ifndef WINDOW_HPP
10 #define WINDOW_HPP
11 
12 #include <SDL2/SDL.h>
13 
14 #include <string>
15 
16 namespace yage {
17 
18 // window flags that can change it's appearance
19 enum WindowFlags : unsigned {
20  SHOWN = 0x1,
21  HIDDEN = 0x2,
22  FULLSCREEN = 0x4,
23  BORDERLESS = 0x8,
24 };
25 
26 // window wrapper around SDL_Window pointer
27 class Window {
28 private:
30  SDL_Window* window_ = nullptr;
31 
32 public:
33  Window();
34  Window(const Window&) = delete;
35  Window(Window&&) = delete;
37  ~Window();
38 
39  Window& operator=(const Window&) = delete;
40  Window& operator=(Window&&) = delete;
41 
43  void create(const std::string& window_name, int width, int height,
44  unsigned flags = WindowFlags::SHOWN);
46  void swapBuffer();
48  void clearBuffer();
49 };
50 
51 } // namespace yage
52 
53 #endif
yage::HIDDEN
Definition: window.hpp:21
+ +
yage::Window::swapBuffer
void swapBuffer()
swap the buffer
Definition: window.cpp:68
+
yage::Window
Definition: window.hpp:27
+
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:22
+
yage::FULLSCREEN
Definition: window.hpp:22
+
yage::WindowFlags
WindowFlags
Definition: window.hpp:19
+
yage::Window::window_
SDL_Window * window_
window handle
Definition: window.hpp:30
+
yage::Window::~Window
~Window()
destroys the window handle
Definition: window.cpp:20
+
yage::SHOWN
Definition: window.hpp:20
+
yage::Window::clearBuffer
void clearBuffer()
clear buffer
Definition: window.cpp:73
+
yage
Templated matrix class.
Definition: camera2d.hpp:17
+
yage::Window::operator=
Window & operator=(const Window &)=delete
+
yage::BORDERLESS
Definition: window.hpp:23
+
-
-Generated on Mon Aug 21 2017 20:54:26 for YAGE by   -doxygen - 1.8.13 -
+ -- cgit