Pcornat/window-glfw-wrapper
1
0
Fork 0
Code Issues Pull requests Activity

Documentation

Browse source
This commit is contained in:
Pcornat 2026-01-10 16:13:38 +01:00
commit 7ce7fe4889
Signed by: Pcornat
GPG key ID: E0326CC678A00BDD
4 changed files with 36 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
include/window.hpp
View file

@ -30,8 +30,10 @@ namespace gui {
static void window_pos_callback(GLFWwindow *window, int xpos, int ypos);
//! RAII window.
std::unique_ptr<GLFWwindow, decltype(&glfwDestroyWindow)> wwindow{ nullptr, glfwDestroyWindow };
//! Modules used in callbacks.
modulesType modules;
explicit Window(const bool debugOpengl,
@ -46,6 +48,14 @@ namespace gui {
Window(Window &&window) noexcept;
/*!
* \brief
* \param [in] framebufferCallback Self-explicit
* \param [in] debugOpengl Boolean to choose if it activates OpenGL's debug mode
* \param [in] shared Another window pointer that shares the OpenGL's context
* \param [in] initializer To initialize Window::modules
* \return Optional containing a Window object if it was successful.
*/
[[nodiscard]] static std::optional<Window> create_window(
GLFWframebuffersizefun framebufferCallback,
const bool debugOpengl,
@ -74,10 +84,21 @@ namespace gui {
Window &operator=(Window other) noexcept;
};
/*!
* \brief It has to be used **before** creating a Window to put color channels on 10 bits resolution.
*/
void color_10_bits() noexcept;
/*!
* \brief It is used to check the color depth for OpenGL's context.
* \param color_depth The color depth to check. Most of the time, 10 or 8 bits.
* \return True: color depth is the input one, else it is not.
*/
[[nodiscard]] bool check_color_depth(int color_depth) noexcept;
/*!
* \brief It can be used to activate OpenGL's debug mode before creating a window.
*/
void opengl_debug() noexcept;
}