Rendering Engine 0.2.9
Modular Graphics Rendering Engine | v0.2.9
rendering_engine::IWindowSystem Class Referenceabstract

Abstract interface for platform-specific window management. More...

#include <i_window_system.hpp>

Inherited by rendering_engine::StandaloneDesktopWindow.

Public Member Functions

virtual void CreateAppWindow (unsigned int width, unsigned int height, const std::string &title)=0
 Creates the main application window. More...
 
virtual void PollEvents ()=0
 Polls and processes OS-level window events (input, resize, close, etc.). More...
 
virtual bool ShouldClose () const =0
 Checks whether the user has requested to close the window. More...
 
virtual void * GetNativeHandle () const =0
 Returns a pointer to the underlying native window handle. More...
 
virtual bool IsFramebufferResized () const =0
 Checks if the framebuffer has been resized since the last frame. More...
 
virtual void ResetFramebufferResizedFlag ()=0
 Resets the framebuffer resized flag after handling a resize event. More...
 
virtual void Shutdown ()=0
 Performs cleanup and releases window-related resources. More...
 
virtual const IApplicationGetApplication ()=0
 Retrieves a reference to the owning application instance. More...
 
virtual WindowResolution GetFullScreenResolution () const =0
 Queries the resolution of the full-screen display mode. More...
 
virtual ~IWindowSystem ()=default
 Virtual destructor for safe polymorphic cleanup. More...
 

Detailed Description

Abstract interface for platform-specific window management.

Provides a unified API for creating, managing, and querying window state. Platform-specific implementations (e.g., GLFW, SDL, Win32, X11) are expected to implement this interface to integrate with the rendering engine.

See also
IApplication

Definition at line 34 of file i_window_system.hpp.

Constructor & Destructor Documentation

◆ ~IWindowSystem()

virtual rendering_engine::IWindowSystem::~IWindowSystem ( )
virtualdefault

Virtual destructor for safe polymorphic cleanup.

Member Function Documentation

◆ CreateAppWindow()

virtual void rendering_engine::IWindowSystem::CreateAppWindow ( unsigned int  width,
unsigned int  height,
const std::string &  title 
)
pure virtual

Creates the main application window.

Parameters
widthWidth of the window in pixels.
heightHeight of the window in pixels.
titleTitle displayed in the window caption.

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ GetApplication()

virtual const IApplication & rendering_engine::IWindowSystem::GetApplication ( )
pure virtual

Retrieves a reference to the owning application instance.

Returns
Reference to the associated IApplication object.

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ GetFullScreenResolution()

virtual WindowResolution rendering_engine::IWindowSystem::GetFullScreenResolution ( ) const
pure virtual

Queries the resolution of the full-screen display mode.

Returns
The native screen resolution when running in full-screen mode.

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ GetNativeHandle()

virtual void * rendering_engine::IWindowSystem::GetNativeHandle ( ) const
pure virtual

Returns a pointer to the underlying native window handle.

Returns
Platform-specific native handle (e.g., HWND, GLFWwindow*, X11 Window).

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ IsFramebufferResized()

virtual bool rendering_engine::IWindowSystem::IsFramebufferResized ( ) const
pure virtual

Checks if the framebuffer has been resized since the last frame.

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ PollEvents()

virtual void rendering_engine::IWindowSystem::PollEvents ( )
pure virtual

Polls and processes OS-level window events (input, resize, close, etc.).

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ ResetFramebufferResizedFlag()

virtual void rendering_engine::IWindowSystem::ResetFramebufferResizedFlag ( )
pure virtual

Resets the framebuffer resized flag after handling a resize event.

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ ShouldClose()

virtual bool rendering_engine::IWindowSystem::ShouldClose ( ) const
pure virtual

Checks whether the user has requested to close the window.

Implemented in rendering_engine::StandaloneDesktopWindow.

◆ Shutdown()

virtual void rendering_engine::IWindowSystem::Shutdown ( )
pure virtual

Performs cleanup and releases window-related resources.

Implemented in rendering_engine::StandaloneDesktopWindow.


The documentation for this class was generated from the following file: