Mercurial > molko
view libcore/core/window.h @ 147:b386d25832c8
doc: use new nomenclature, closes #2497
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 15 Oct 2020 09:21:04 +0200 |
parents | 789b23e01f52 |
children | c3a40062acc2 |
line wrap: on
line source
/* * window.h -- basic window management * * Copyright (c) 2020 David Demelier <markand@malikania.fr> * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef MOLKO_WINDOW_H #define MOLKO_WINDOW_H /** * \file window.h * \brief Basic window management. * \ingroup drawing */ #include <stdbool.h> /** * \brief Global exposed window structure. */ struct window { unsigned int w; /*!< (-) Window width. */ unsigned int h; /*!< (-) Window height. */ void *handle; /*!< (*) Native handle. */ }; /** * \brief Access to global window structure. */ extern struct window window; /** * Initialize window. * * \pre title != NULL * \param title the window title * \param width the desired width * \param height the desired height * \return true on success */ bool window_init(const char *title, unsigned int width, unsigned int height); /** * Close the window and destroy associated resources. */ void window_finish(void); #endif /* !MOLKO_WINDOW_H */