GLFWWindowUserPointer.ixx File

Helper storing user pointer data for GLFW windows. More...

Included Headers

#include <helios.window.Window> #include <helios.app.Application>

Namespaces Index

namespace	helios
namespace	ext
	Platform-specific extensions and backend implementations. More...
namespace	glfw
	GLFW-specific implementations. More...
namespace	window
	GLFW window management. More...

Classes Index

struct	GLFWWindowUserPointer
	A structure to hold user defined data associated with a GLFWwindow. More...

Description

Helper storing user pointer data for GLFW windows.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file GLFWWindowUserPointer.ixx

3 * @brief Helper storing user pointer data for GLFW windows.

4 */

5module;

6

7export module helios.ext.glfw.window.GLFWWindowUserPointer;

8

9import helios.app.Application;

10import helios.window.Window;

11

12export namespace helios::ext::glfw::window {

13

14 /**

15 * @brief A structure to hold user defined data associated with a GLFWwindow.

16 *

17 * This struct is intended to be used with `glfwSetWindowUserPointer` to allow

18 * GLFW callbacks access data held within this struct.

19 *

20 * @see https://www.glfw.org/docs/latest/group__window.html#ga3d2fc6026e690ab31a13f78bc9fd3651

21 */

22 struct GLFWWindowUserPointer {

23 /**

24 * @brief Non-owning pointer to the Application instance the window belongs to.

25 */

26 helios::app::Application* application = nullptr;

27

28 /**

29 * @brief A non-owning pointer to the Window instance owning this struct.

30 */

31 helios::window::Window* window = nullptr;

32 };

33

34}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.