Gamedev Framework (gf)  0.6.0
A C++11 framework for 2D games
Region.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2017 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  *
21  * Part of this file comes from SFML, with the same license:
22  * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
23  */
24 #ifndef GF_REGION_H
25 #define GF_REGION_H
26 
27 #include "Portability.h"
28 
29 namespace gf {
30 #ifndef DOXYGEN_SHOULD_SKIP_THIS
31 inline namespace v1 {
32 #endif
33 
34  /**
35  * @ingroup window
36  * @brief A region of a window
37  *
38  * A region is defined by its bottom-left point and its size. It is used to
39  * define viewports and scissor boxes (see gf::RenderTarget).
40  *
41  * @sa gf::RectI, gf::RenderTarget
42  */
43  struct GF_API Region {
44  int left; ///< Left coordinate of the region
45  int bottom; ///< Bottom coordinate of the region
46  int width; ///< Width of the region
47  int height; ///< Height of the region
48  };
49 
50 #ifndef DOXYGEN_SHOULD_SKIP_THIS
51 }
52 #endif
53 }
54 
55 #endif // GF_REGION_H
int left
Left coordinate of the region.
Definition: Region.h:44
int bottom
Bottom coordinate of the region.
Definition: Region.h:45
The namespace for gf classes.
Definition: Action.h:34
int width
Width of the region.
Definition: Region.h:46
A region of a window.
Definition: Region.h:43
#define GF_API
Definition: Portability.h:35
int height
Height of the region.
Definition: Region.h:47