browser-window-ffi 0.0.5

FFI bindings for the browser-window crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

#ifndef BW_WINDOW_H
#define BW_WINDOW_H


#ifdef __cplusplus
extern "C" {
#endif

#include "application.h"
#include "string.h"
#ifdef BW_WIN32
#include "win32/window.h"
#else
#include "window/void.h"
#endif

#include <stdbool.h>



typedef struct bw_Window bw_Window;

typedef struct bw_WindowCallbacks {
	/// Fired just before the window gets destroyed and freed from memory.
	/// Should be implemented to free the user data provided to the window.
	void (*do_cleanup)( const bw_Window* );
	/// Fired when the window has been closed, either by the user or programmatically.
	void (*on_close)( const bw_Window* );
	/// Fired when a window has finished loading
	void (*on_loaded)( const bw_Window* );
	/// Fired when a window is resizing
	void (*on_resize)( const bw_Window*, unsigned int width, unsigned int height );
} bw_WindowCallbacks;

typedef struct bw_WindowInner bw_WindowInner; // struct bw_WindowInner should already be declared.

typedef struct bw_WindowOptions {
	bool maximizable;
	bool minimizable;
	bool resizable;
	bool closable;
	bool borders;
} bw_WindowOptions;

typedef void (*bw_WindowDispatchFn)( bw_Window* window, void* data );
typedef struct bw_WindowDispatchData bw_WindowDispatchData;



struct bw_Window {
	const bw_Application* app;	// The application handle that this window belongs to.
	const bw_Window* parent;	// An optional window that acts as the parent to this window. If the parent gets destroyed, children will get destroyed too.
	bw_WindowHandle handle;	/// The underlying handle to the window
	bool closed;	// Whether or not the window has been closed by the user
	bool destroy_on_close;	// Whether or not the window may be destroyed when the user actually closes it
	bw_WindowCallbacks callbacks;
	void* user_data;
};



/// Creates a new (empty) window
/// The returned pointer is a handler for the window.
/// bw_Window_drop needs to be called on it after it is done being used,
///     otherwise the window is never actually destroyed and memory leakes happen.
bw_Window* bw_Window_new(
	bw_Application* app,
	const bw_Window* parent,
	bw_CStrSlice _title,
	int width, int height,
	const bw_WindowOptions* options,
	void* user_data
);

/// Closes the window
/// Anything called for this window will still succeed after it is closed.
/// It will just not be visible anymore.
void bw_Window_close( bw_Window* window );

void bw_Window_drop( bw_Window* window );

/// Should be called when the window is not needed anymore within the code, otherwise memory leaks happen.
/// This makes sure the window is destroyed when window closes, or already ís closed.
void bw_Window_free( bw_Window* window );

/// Dispatches the given function on the GUI thread, and passes the given data along.
/// This function is thread-safe.
void bw_Window_dispatch( bw_Window* window, bw_WindowDispatchFn fn, void* data );

void _bw_Window_init( bw_Application* app );

/// Returns whether or not the window has been closed.
bool bw_Window_isClosed( const bw_Window* window );



#ifdef __cplusplus
}	// extern "C"
#endif

#endif//BW_WINDOW_H