Berserk
Window.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of Berserk Engine project */
3 /* https://github.com/EgorOrachyov/Berserk */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2018 - 2021 Egor Orachyov */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef BERSERK_WINDOW_HPP
29 #define BERSERK_WINDOW_HPP
30 
31 #include <core/Config.hpp>
32 #include <core/math/TVecN.hpp>
33 #include <core/string/String.hpp>
36 
38 
48 class Window : public RefCnt {
49 public:
50  BRK_API ~Window() override = default;
51 
53  BRK_API virtual Point2i GetPosition() const = 0;
54 
56  BRK_API virtual Size2i GetSize() const = 0;
57 
59  BRK_API virtual Size2i GetFramebufferSize() const = 0;
60 
62  BRK_API virtual Vec2f GetPixelRatio() const = 0;
63 
65  BRK_API virtual float GetAspectRatio() const {
66  auto s = GetSize();
67  return s[1] > 0 ? static_cast<float>(s[0]) / static_cast<float>(s[1]) : 1.0f;
68  }
69 
71  BRK_API virtual bool IsInFocus() const = 0;
72 
74  BRK_API virtual bool IsClosed() const = 0;
75 
77  BRK_API virtual String GetTitle() const = 0;
78 
80  BRK_API virtual StringName GetName() const = 0;
81 };
82 
88 
89 #endif//BERSERK_WINDOW_HPP
#define BRK_NS_END
Definition: Config.hpp:48
#define BRK_API
Definition: Config.hpp:32
Reference counted base object.
Definition: RefCnt.hpp:52
Cached shared utf-8 string id.
Definition: StringName.hpp:61
Utf-8 encoded std based default string class.
Platform specific OS window for rendering.
Definition: Window.hpp:48
virtual BRK_API float GetAspectRatio() const
Definition: Window.hpp:65
virtual BRK_API Point2i GetPosition() const =0
virtual BRK_API bool IsClosed() const =0
BRK_API ~Window() override=default
virtual BRK_API Size2i GetSize() const =0
virtual BRK_API bool IsInFocus() const =0
virtual BRK_API String GetTitle() const =0
virtual BRK_API Vec2f GetPixelRatio() const =0
virtual BRK_API Size2i GetFramebufferSize() const =0
virtual BRK_API StringName GetName() const =0
Definition: GLDevice.cpp:46