Graphic-Window

Wraps the OS specific window and its OpenGL specific extension into a thin layer to make other modules OS independent.

Supports OpenGL / GLES for drawing operations.

Summary

Graphic-Window	Wraps the OS specific window and its OpenGL specific extension into a thin layer to make other modules OS independent.
Copyright	This program is free software.
Files
C-kern/api/graphic/window.h	Header file Graphic-Window.
C-kern/graphic/window.c	Implementation file Graphic-Window impl.
Types
struct window_t	Export window_t into global namespace.
struct window_evh_t	Export window_evh_t into global namespace.
Functions
test
unittest_graphic_window	Test window_t functionality.
window_evh_t	Callback interface for handling generic window events.
onclose	The event handler is called if the user requested to close the window.
ondestroy	The event handler is called if the window was destroyed by another process.
onredraw	The event handler is called if the window was (partially) obscured and the obscured content has to be redrawn.
onreshape	The event handler is called whenever the geometry of the window changes.
onvisible	The event handler is called whenever the window changes from hidden to shown state or vice versa.
generic
window_evh_INIT	Static initializer.
generic
genericcast_windowevh	Casts parameter evhimpl into pointer to interface window_evh_t.
window_evh_DECLARE	Declares an interface to handle window events.
window_t	Wraps a native window and its OpenGL specific wrapper (if needed).
lifetime
window_FREE	Static initializer.
init_window	Creates a new native window and its OpenGL extension/wrapper type.
free_window	Frees win and its associated resources like native windows.
query
gl_window	Returns a pointer to a native opengl window.
os_window	Returns a pointer to a native window.
display_window	Returns a pointer to the display_t the window is associated with.
isvisible_window	Returns true if window is visible on the screen.
pos_window	Returns the position of the window in screen coordinates.
size_window	Returns the width and height of win in pixels.
update
show_window	Makes window visible to the user.
hide_window	Hides win and removes it from the screen.
setpos_window	Changes the position of the window on the screen.
resize_window	Changes the size of the window.
sendclose_window	Sends a close request to win.
sendredraw_window	Sends a redraw event to win.
OpenGL
swapbuffer_window	Swaps the content of the fron buffer with the back buffer.
inline implementation
window_t
gl_window	Implements window_t.gl_window.
os_window	Implements window_t.os_window.
display_window	Implements window_t.display_window.
hide_window	Implements window_t.hide_window.
isvisible_window	Implements window_t.isvisible_window.
pos_window	Implements window_t.pos_window.
resize_window	Implements window_t.resize_window.
sendclose_window	Implements window_t.sendclose_window.
sendredraw_window	Implements window_t.sendredraw_window.
setpos_window	Implements window_t.setpos_window.
show_window	Implements window_t.show_window.
size_window	Implements window_t.size_window.
window_evh_t
genericcast_windowevh	Implements window_evh_t.genericcast_windowevh.
window_evh_DECLARE	Implements window_evh_t.window_evh_DECLARE.

Copyright

This program is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Author

Files

C-kern/api/graphic/window.h

Header file Graphic-Window.

C-kern/graphic/window.c

Implementation file Graphic-Window impl.

Types

struct window_t

typedef struct window_t window_t

Export window_t into global namespace.

struct window_evh_t

typedef struct window_evh_t window_evh_t

Export window_evh_t into global namespace.

Functions

Summary

test
unittest_graphic_window	Test window_t functionality.

test

unittest_graphic_window

int unittest_graphic_window( void )

Test window_t functionality.

window_evh_t

struct window_evh_t

Callback interface for handling generic window events.

Summary

onclose	The event handler is called if the user requested to close the window.
ondestroy	The event handler is called if the window was destroyed by another process.
onredraw	The event handler is called if the window was (partially) obscured and the obscured content has to be redrawn.
onreshape	The event handler is called whenever the geometry of the window changes.
onvisible	The event handler is called whenever the window changes from hidden to shown state or vice versa.
generic
window_evh_INIT	Static initializer.
generic
genericcast_windowevh	Casts parameter evhimpl into pointer to interface window_evh_t.
window_evh_DECLARE	Declares an interface to handle window events.

onclose

void ( * onclose ) (window_t * win)

The event handler is called if the user requested to close the window. You can save state information before calling <free_window>.

ondestroy

void ( * ondestroy ) (window_t * win)

The event handler is called if the window was destroyed by another process. You must call <free_window> - any other function which uses window_t as parameter would cause an error which would cause the process to abort in case of X11. Not calling <free_window> results in a memory leak. Calling <free_window> in response to an onclose event does not trigger an ondestroy callback.

onredraw

void ( * onredraw ) (window_t * win)

The event handler is called if the window was (partially) obscured and the obscured content has to be redrawn.

onreshape

void ( * onreshape ) (window_t * win, uint32_t width, uint32_t height)

The event handler is called whenever the geometry of the window changes. The x and y coordinates can be queried for with a call to pos_window.

onvisible

void ( * onvisible ) (window_t * win, bool isVisible)

The event handler is called whenever the window changes from hidden to shown state or vice versa. If isVisible is set the window is in a shown state else it is in a hidden state and not visible.

generic

window_evh_INIT

#define window_evh_INIT(
subwindow_fct_suffix
) { & onclose ## subwindow_fct_suffix, & ondestroy ## subwindow_fct_suffix, & onredraw ## subwindow_fct_suffix, & onreshape ## subwindow_fct_suffix, & onvisible ## subwindow_fct_suffix }

Static initializer.

generic

genericcast_windowevh

const window_evh_t * genericcast_windowevh( const void * evhimpl,
TYPENAME subwindow_t )

Casts parameter evhimpl into pointer to interface window_evh_t. The parameter evhimpl has to be of type pointer to type declared with window_evh_DECLARE. The other parameters must be the same as in window_evh_DECLARE without the first.

window_evh_DECLARE

void window_evh_DECLARE( TYPENAME declared_evh_t,
TYPENAME subwindow_t )

Declares an interface to handle window events. The interface is structural compatible with window_evh_t. See window_evh_t for a list of declared functions.

Parameter

declared_evh_t	The name of the structure which is declared as the interface. The name should have the suffix “_evh_t”.
subwindow_t	The window subtype for which declared_evh_t implements the callback functions.

window_t

struct window_t

Wraps a native window and its OpenGL specific wrapper (if needed).

Summary

lifetime
window_FREE	Static initializer.
init_window	Creates a new native window and its OpenGL extension/wrapper type.
free_window	Frees win and its associated resources like native windows.
query
gl_window	Returns a pointer to a native opengl window.
os_window	Returns a pointer to a native window.
display_window	Returns a pointer to the display_t the window is associated with.
isvisible_window	Returns true if window is visible on the screen.
pos_window	Returns the position of the window in screen coordinates.
size_window	Returns the width and height of win in pixels.
update
show_window	Makes window visible to the user.
hide_window	Hides win and removes it from the screen.
setpos_window	Changes the position of the window on the screen.
resize_window	Changes the size of the window.
sendclose_window	Sends a close request to win.
sendredraw_window	Sends a redraw event to win.
OpenGL
swapbuffer_window	Swaps the content of the fron buffer with the back buffer.

lifetime

window_FREE

#define window_FREE { x11window_FREE, surface_FREE_EMBEDDED }

Static initializer.

init_window

int init_window( /*out*/window_t * win,
struct display_t * disp,
uint32_t screennr,
const struct window_evh_t * eventhandler,
struct gconfig_t * gconf,
struct windowconfig_t * winattr )

Creates a new native window and its OpenGL extension/wrapper type. A copy of the pointer disp is stored internally so do not free display_t disp until win has been freed.

free_window

int free_window( window_t * win )

Frees win and its associated resources like native windows. Before you call this function make sure that every other resource which depends on win is freed.

query

gl_window

struct opengl_surface_t * gl_window( const window_t * win )

Returns a pointer to a native opengl window.

os_window

void * os_window( const window_t * win )

Returns a pointer to a native window. This function is implemented as a macro and therefore returns a pointer to the real native type and not void. It is possible that gl_window returns the same pointer except for the type. In case of EGL as OpenGL adaption layer both pointers differ.

display_window

struct display_t * display_window( const window_t * win )

Returns a pointer to the display_t the window is associated with.

isvisible_window

bool isvisible_window( const window_t * win )

Returns true if window is visible on the screen. In case of true it may be obscured by another window nonetheless.

pos_window

int pos_window( const window_t * win,
/*out*/int32_t * screen_x,
/*out*/int32_t * screen_y )

Returns the position of the window in screen coordinates. The value (screen_x == 0, screen_y == 0) denotes the top left corner of the screen.

size_window

int size_window( const window_t * win,
/*out*/uint32_t * width,
/*out*/uint32_t * height )

Returns the width and height of win in pixels.

update

show_window

int show_window( window_t * win )

Makes window visible to the user. After the event received from the windowing system has been processed the window state is changed to visible - see isvisible_window.

hide_window

int hide_window( window_t * win )

Hides win and removes it from the screen. After the event received from the windowing system has been processed the window state is changed to hidden - see isvisible_window.

setpos_window

int setpos_window( window_t * win,
int32_t screen_x,
int32_t screen_y )

Changes the position of the window on the screen. Coordinates are in screen coordinates. The coordinate (0,0) is top left.

resize_window

int resize_window( window_t * win,
uint32_t width,
uint32_t height )

Changes the size of the window. Parameter width and height must be > 0 else result is undefined.

sendclose_window

int sendclose_window( window_t * win )

Sends a close request to win. The registered eventhandler receives an window_evh_t.onclose event. If no event handler is registered the event is ignored.

sendredraw_window

int sendredraw_window( window_t * win )

Sends a redraw event to win. The registered eventhandler receives an window_evh_t.onredraw event. If no event handler is registered the event is ignored.

OpenGL

swapbuffer_window

int swapbuffer_window( window_t * win,
struct display_t * disp )

Swaps the content of the fron buffer with the back buffer. Draw operations go to the back buffer. The front is shown on the screen. After return the content of the back buffer is undefined.

inline implementation

Summary

window_t
gl_window	Implements window_t.gl_window.
os_window	Implements window_t.os_window.
display_window	Implements window_t.display_window.
hide_window	Implements window_t.hide_window.
isvisible_window	Implements window_t.isvisible_window.
pos_window	Implements window_t.pos_window.
resize_window	Implements window_t.resize_window.
sendclose_window	Implements window_t.sendclose_window.
sendredraw_window	Implements window_t.sendredraw_window.
setpos_window	Implements window_t.setpos_window.
show_window	Implements window_t.show_window.
size_window	Implements window_t.size_window.
window_evh_t
genericcast_windowevh	Implements window_evh_t.genericcast_windowevh.
window_evh_DECLARE	Implements window_evh_t.window_evh_DECLARE.

window_t

gl_window

#define gl_window( win ) gl_surface(win)

Implements window_t.gl_window.

os_window

#define os_window( win ) (&(win)->oswindow)

Implements window_t.os_window.

display_window

#define display_window(
win
) (castfromos_display(display_x11window(os_window(win))))

Implements window_t.display_window.

hide_window

#define hide_window( win ) hide_x11window(os_window(win))

Implements window_t.hide_window.

isvisible_window

#define isvisible_window(
win
) (x11window_state_SHOWN == state_x11window(os_window(win)))

Implements window_t.isvisible_window.

pos_window

#define pos_window( win,
screen_x,
screen_y ) pos_x11window(os_window(win), screen_x, screen_y)

Implements window_t.pos_window.

resize_window

#define resize_window( win,
width,
height ) resize_x11window(os_window(win), width, height)

Implements window_t.resize_window.

sendclose_window

#define sendclose_window( win ) sendclose_x11window(os_window(win))

Implements window_t.sendclose_window.

sendredraw_window

#define sendredraw_window( win ) sendredraw_x11window(os_window(win))

Implements window_t.sendredraw_window.

setpos_window

#define setpos_window(
    win,
    screen_x,
    screen_y
) setpos_x11window(os_window(win), screen_x, screen_y)

Implements window_t.setpos_window.

show_window

#define show_window( win ) show_x11window(os_window(win))

Implements window_t.show_window.

size_window

#define size_window( win,
width,
height ) size_x11window(os_window(win), width, height)

Implements window_t.size_window.

window_evh_t

genericcast_windowevh

#define genericcast_windowevh(
evhimpl,
subwindow_t
) ( __extension__ ({ static_assert( offsetof(typeof(*(evhimpl)), onclose) == offsetof(window_evh_t, onclose) && offsetof(typeof(*(evhimpl)),ondestroy) == offsetof(window_evh_t, ondestroy) && offsetof(typeof(*(evhimpl)), onredraw) == offsetof(window_evh_t, onredraw) && offsetof(typeof(*(evhimpl)),onreshape) == offsetof(window_evh_t, onreshape) && offsetof(typeof(*(evhimpl)),onvisible) == offsetof(window_evh_t, onvisible), "ensure same structure"); if (0) { (evhimpl)->onclose((subwindow_t*)0); (evhimpl)->ondestroy((subwindow_t*)0); (evhimpl)->onredraw((subwindow_t*)0); (evhimpl)->onreshape((subwindow_t*)0, (uint32_t)0, (uint32_t)0); (evhimpl)->onvisible((subwindow_t*)0, (bool)0); } (const window_evh_t*) (evhimpl); }))

Implements window_evh_t.genericcast_windowevh.

window_evh_DECLARE

#define window_evh_DECLARE(
declared_evh_t,
subwindow_t
) typedef struct declared_evh_t declared_evh_t; struct declared_evh_t { void (* onclose) (subwindow_t * win); void (* ondestroy) (subwindow_t * win); void (* onredraw) (subwindow_t * win); void (* onreshape) (subwindow_t * win, uint32_t width, uint32_t height); void (* onvisible) (subwindow_t * win, bool isVisible); }

Implements window_evh_t.window_evh_DECLARE.