Documentation of the MLV-2.0.2 library

MLV_window.h
1 /*
2  * This file is part of the MLV Library.
3  *
4  * Copyright (C) 2010,2011,2012 Adrien Boussicault, Marc Zipstein
5  *
6  *
7  * This Library is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This Library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this Library. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
32 #ifndef __MLV__MLV_WINDOW_H__
33 #define __MLV__MLV_WINDOW_H__
34 
35 #include "MLV_color.h"
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
80 void MLV_create_window(
81  const char* window_name, const char* icone_name,
82  unsigned int width, unsigned int height
83 );
84 
85 
100 void MLV_create_window_with_default_font(
101  const char* window_name, const char* icone_name,
102  unsigned int width, unsigned int height,
103  const char* path_to_font, unsigned int size_font
104 );
105 
122 void MLV_change_default_font( const char* path_to_font, unsigned int size_font );
123 
137 void MLV_create_full_screen_window(
138  const char* window_name, const char* icone_name,
139  unsigned int width, unsigned int height
140 );
141 
158 void MLV_create_full_screen_window_with_default_font(
159  const char* window_name, const char* icone_name,
160  unsigned int width, unsigned int height,
161  const char* path_to_font, unsigned int size_font
162 );
163 
164 
172 void MLV_enable_full_screen();
173 
177 void MLV_disable_full_screen();
178 
184 int MLV_is_full_screen();
185 
199 void MLV_change_window_size( unsigned int width, unsigned int height );
200 
207 void MLV_change_window_caption(
208  const char* window_name, const char* icone_name
209 );
210 
217 void MLV_get_window_size( unsigned int* width, unsigned int* height );
218 
222 int MLV_get_window_height( );
223 
227 int MLV_get_window_width( );
228 
235 void MLV_clear_window( MLV_Color color );
236 
244 void MLV_free_window();
245 
255 void MLV_actualise_window();
256 
264 void MLV_update_window();
265 
280 void MLV_execute_at_exit( void (*function)(void*), void* data );
281 
289 void MLV_get_desktop_size( unsigned int* width, unsigned int* height );
290 
294 int MLV_get_desktop_height( );
295 
299 int MLV_get_desktop_width( );
300 
301 
302 #ifdef __cplusplus
303 }
304 #endif
305 
306 #endif