sbgl_platform.h File Reference

Internal Platform Abstraction Layer (HAL). More...

#include "sbgl_types.h"
#include "sbgl_input.h"
#include <stdbool.h>
#include <stdint.h>

Include dependency graph for sbgl_platform.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
sbgl_platform_Result	sbgl_os_CreateWindow (struct SblArena *arena, sbgl_InputState *input, int width, int height, const char *title, sbgl_Window **outWindow)
	Creates a native OS window.
void	sbgl_os_DestroyWindow (sbgl_Window *window)
	Destroys a native window.
bool	sbgl_os_WindowShouldClose (sbgl_Window *window)
	Checks the window's close flag.
void	sbgl_os_GetWindowSize (sbgl_Window *window, int *w, int *h)
	Retrieves the current client area size.
bool	sbgl_os_WasWindowResized (sbgl_Window *window)
	Checks if the window has been resized since the last check.
void	sbgl_os_SetCursorVisible (sbgl_Window *window, bool visible)
	Sets the visibility of the OS cursor for the given window.
void	sbgl_os_SetCursorLocked (sbgl_Window *window, bool locked)
	Locks or unlocks the cursor within the window bounds.
bool	sbgl_os_IsWindowFocused (sbgl_Window *window)
	Checks if the window currently has input focus.
void	sbgl_os_PollEvents (sbgl_Window *window)
	Dispatches OS events (messages/protocol requests).
uint64_t	sbgl_os_GetPerfCount (sbgl_Window *window)
	Gets the high-resolution performance counter.
uint64_t	sbgl_os_GetPerfFreq (sbgl_Window *window)
	Gets the performance counter frequency.
void *	sbgl_os_GetNativeWindowHandle (sbgl_Window *window)
	Retrieves the raw window handle for Vulkan surface creation.
void *	sbgl_os_GetNativeInstanceHandle (sbgl_Window *window)
	Retrieves the native instance handle (Win32 specific).
void *	sbgl_os_GetNativeDisplayHandle (sbgl_Window *window)
	Retrieves the native display handle (Linux specific).

Detailed Description

Internal Platform Abstraction Layer (HAL).

Defines the strict interface that OS-specific implementations must follow. Prevents OS headers (windows.h, wayland-client.h) from leaking into the core.

Definition in file sbgl_platform.h.

Function Documentation

sbgl_os_CreateWindow()

sbgl_platform_Result sbgl_os_CreateWindow	(	struct SblArena *	arena,
		sbgl_InputState *	input,
		int	width,
		int	height,
		const char *	title,
		sbgl_Window **	outWindow )

Creates a native OS window.

Parameters

arena	Arena to allocate the window state from.
input	Pointer to input state.
width	Initial width.
height	Initial height.
title	Window title.
outWindow	Pointer to store the created window.

Returns

Platform result code.

Definition at line 68 of file window_wayland.c.

                                                                                                                                                             {
    if (!outWindow) {
        return SBGL_PLATFORM_ERROR_INIT_FAILED;
    }
    *outWindow = NULL;
 
    if (!arena) {
        return SBGL_PLATFORM_ERROR_INIT_FAILED;
    }
 
    sbgl_Window* window = SBL_ARENA_PUSH_STRUCT_ZERO(arena, sbgl_Window);
    if (!window) return SBGL_PLATFORM_ERROR_INIT_FAILED;
 
    window->width = width; window->height = height;
    window->shouldClose = false;
    window->resized = false;
    window->focused = false;
    window->cursor_visible = true;
    window->input = input;
 
    window->display = wl_display_connect(NULL);
    if (!window->display) return SBGL_PLATFORM_ERROR_NO_DISPLAY;
 
    struct wl_registry* reg = wl_display_get_registry(window->display);
    wl_registry_add_listener(reg, &registry_listener, window);
    wl_display_roundtrip(window->display);
 
    window->surface = wl_compositor_create_surface(window->compositor);
    if (!window->surface) return SBGL_PLATFORM_ERROR_WINDOW_FAILED;
 
    window->xdg_surface = xdg_wm_base_get_xdg_surface(window->wm_base, window->surface);
    if (!window->xdg_surface) return SBGL_PLATFORM_ERROR_WINDOW_FAILED;
 
    xdg_surface_add_listener(window->xdg_surface, &xdg_surface_listener, window);
    window->xdg_toplevel = xdg_surface_get_toplevel(window->xdg_surface);
    if (!window->xdg_toplevel) return SBGL_PLATFORM_ERROR_WINDOW_FAILED;
 
    xdg_toplevel_add_listener(window->xdg_toplevel, &toplevel_listener, window);
    xdg_toplevel_set_title(window->xdg_toplevel, title);
 
    if (window->seat) {
        struct wl_keyboard* k = wl_seat_get_keyboard(window->seat);
        if (k) wl_keyboard_add_listener(k, &keyboard_listener, window);
        struct wl_pointer* p = wl_seat_get_pointer(window->seat);
        if (p) wl_pointer_add_listener(p, &pointer_listener, window);
    }
 
    wl_surface_commit(window->surface);
    wl_display_roundtrip(window->display);
 
    *outWindow = window;
    return SBGL_PLATFORM_SUCCESS;
}

sbgl_os_DestroyWindow()

void sbgl_os_DestroyWindow

(

sbgl_Window *

window

)

Destroys a native window.

Parameters

window

The window to destroy.

Definition at line 205 of file window_wayland.c.

                                                { 
    if (!window) return;
    if (window->relative_pointer) zwp_relative_pointer_v1_destroy(window->relative_pointer);
    if (window->locked_pointer) zwp_locked_pointer_v1_destroy(window->locked_pointer);
    if (window->relative_pointer_manager) zwp_relative_pointer_manager_v1_destroy(window->relative_pointer_manager);
    if (window->pointer_constraints) zwp_pointer_constraints_v1_destroy(window->pointer_constraints);
    xdg_toplevel_destroy(window->xdg_toplevel); 
    xdg_surface_destroy(window->xdg_surface); 
    wl_surface_destroy(window->surface); 
    wl_display_disconnect(window->display);
}

sbgl_os_GetNativeDisplayHandle()

void * sbgl_os_GetNativeDisplayHandle

(

sbgl_Window *

window

)

Retrieves the native display handle (Linux specific).

Parameters

window

The window handle.

Returns

Display* or wl_display*.

Definition at line 204 of file window_wayland.c.

{ return (void*)window->display; }

sbgl_os_GetNativeInstanceHandle()

void * sbgl_os_GetNativeInstanceHandle

(

sbgl_Window *

window

)

Retrieves the native instance handle (Win32 specific).

Parameters

window

The window handle.

Returns

HINSTANCE on Windows, NULL otherwise.

Definition at line 152 of file window_x11.c.

                                                           {
    (void)window;
    return NULL;
}

sbgl_os_GetNativeWindowHandle()

void * sbgl_os_GetNativeWindowHandle

(

sbgl_Window *

window

)

Retrieves the raw window handle for Vulkan surface creation.

Parameters

window

The window handle.

Returns

Native handle (e.g., HWND or wl_surface*).

Definition at line 203 of file window_wayland.c.

{ return (void*)window->surface; }

sbgl_os_GetPerfCount()

uint64_t sbgl_os_GetPerfCount

(

sbgl_Window *

window

)

Gets the high-resolution performance counter.

Parameters

window

The window handle.

Returns

Absolute ticks.

Definition at line 201 of file window_wayland.c.

{ (void)window; struct timespec ts; clock_gettime(CLOCK_MONOTONIC, &ts); return (uint64_t)ts.tv_sec * 1000000000ULL + ts.tv_nsec; }

sbgl_os_GetPerfFreq()

uint64_t sbgl_os_GetPerfFreq

(

sbgl_Window *

window

)

Gets the performance counter frequency.

Parameters

window

The window handle.

Returns

Ticks per second.

Definition at line 202 of file window_wayland.c.

{ (void)window; return 1000000000ULL; }

sbgl_os_GetWindowSize()

void sbgl_os_GetWindowSize	(	sbgl_Window *	window,
		int *	w,
		int *	h )

Retrieves the current client area size.

Parameters

window	The window handle.
w	Pointer to store width.
h	Pointer to store height.

Definition at line 150 of file window_wayland.c.

{ *w = window->width; *h = window->height; }

sbgl_os_IsWindowFocused()

bool sbgl_os_IsWindowFocused

(

sbgl_Window *

window

)

Checks if the window currently has input focus.

Parameters

window

The native window handle.

Returns

True if focused.

Definition at line 158 of file window_wayland.c.

{ return window->focused; }

sbgl_os_PollEvents()

void sbgl_os_PollEvents

(

sbgl_Window *

window

)

Dispatches OS events (messages/protocol requests).

Parameters

window

The window to process events for.

Definition at line 122 of file window_wayland.c.

                                             {
    if (!window) return;
    
    // Clear deltas if relative pointer is active to allow accumulation in listeners
    if (window->relative_pointer && window->input) {
        window->input->mouseDeltaX = 0;
        window->input->mouseDeltaY = 0;
    }
 
    /* The system ensures that pending events are dispatched and new events are read 
       from the display in a non-blocking manner to prevent main loop stalls. */
    while (wl_display_prepare_read(window->display) != 0) {
        wl_display_dispatch_pending(window->display);
    }
    wl_display_flush(window->display);
 
    struct pollfd pfd = { .fd = wl_display_get_fd(window->display), .events = POLLIN };
    if (poll(&pfd, 1, 0) > 0) {
        wl_display_read_events(window->display);
    } else {
        wl_display_cancel_read(window->display);
    }
 
    wl_display_dispatch_pending(window->display);
    linux_internal_update_input_states(window);
}

sbgl_os_SetCursorLocked()

void sbgl_os_SetCursorLocked	(	sbgl_Window *	window,
		bool	locked )

Locks or unlocks the cursor within the window bounds.

When locked, the cursor is typically constrained to the window center to support relative motion for 3D navigation.

Parameters

window	The native window handle.
locked	True to capture the cursor, false to release it.

Definition at line 175 of file window_wayland.c.

                                                               {
    if (!window || !window->seat || !window->pointer_constraints) return;
    struct wl_pointer* pointer = wl_seat_get_pointer(window->seat);
    if (!pointer) return;
 
    if (locked && !window->locked_pointer) {
        window->locked_pointer = zwp_pointer_constraints_v1_lock_pointer(
            window->pointer_constraints, window->surface, pointer, NULL,
            ZWP_POINTER_CONSTRAINTS_V1_LIFETIME_PERSISTENT);
        zwp_locked_pointer_v1_add_listener(window->locked_pointer, &locked_pointer_listener, window);
 
        if (window->relative_pointer_manager) {
            window->relative_pointer = zwp_relative_pointer_manager_v1_get_relative_pointer(
                window->relative_pointer_manager, pointer);
            zwp_relative_pointer_v1_add_listener(window->relative_pointer, &relative_pointer_listener, window);
        }
    } else if (!locked && window->locked_pointer) {
        zwp_locked_pointer_v1_destroy(window->locked_pointer);
        window->locked_pointer = NULL;
        if (window->relative_pointer) {
            zwp_relative_pointer_v1_destroy(window->relative_pointer);
            window->relative_pointer = NULL;
        }
    }
}

sbgl_os_SetCursorVisible()

void sbgl_os_SetCursorVisible	(	sbgl_Window *	window,
		bool	visible )

Sets the visibility of the OS cursor for the given window.

Provides a platform-agnostic way to show or hide the mouse pointer.

Parameters

window	The native window handle.
visible	True to show the cursor, false to hide it.

Definition at line 160 of file window_wayland.c.

                                                                 {
    if (!window) return;
    window->cursor_visible = visible;
    
    if (!visible && window->seat) {
        struct wl_pointer* pointer = wl_seat_get_pointer(window->seat);
        if (pointer) {
            // Setting the cursor surface to NULL hides the cursor for this surface.
            wl_pointer_set_cursor(pointer, window->pointer_serial, NULL, 0, 0);
        }
    }
}

sbgl_os_WasWindowResized()

bool sbgl_os_WasWindowResized

(

sbgl_Window *

window

)

Checks if the window has been resized since the last check.

Resets the internal resize flag to false upon returning.

Parameters

window

The window handle.

Returns

True if a resize event occurred.

Definition at line 152 of file window_wayland.c.

                                                   {
    bool r = window->resized;
    window->resized = false;
    return r;
}

sbgl_os_WindowShouldClose()

bool sbgl_os_WindowShouldClose

(

sbgl_Window *

window

)

Checks the window's close flag.

Parameters

window

The window to check.

Returns

True if closing.

Definition at line 149 of file window_wayland.c.

{ return window->shouldClose; }