Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
VkCV Framework
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Vulkan2021
VkCV Framework
Commits
9978a703
Commit
9978a703
authored
4 years ago
by
Sebastian Gaida
Browse files
Options
Downloads
Patches
Plain Diff
[
#20
][Doku] add comments to Window.hpp
parent
3ae2723e
No related branches found
No related tags found
1 merge request
!11
Resolve "Add Doxygen comments to existing code"
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/vkcv/Window.hpp
+28
-0
28 additions, 0 deletions
src/vkcv/Window.hpp
with
28 additions
and
0 deletions
src/vkcv/Window.hpp
+
28
−
0
View file @
9978a703
...
...
@@ -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
;
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment