lib/gamnit: intro the abstract display
[nit.git] / lib / gamnit / display.nit
1 # This file is part of NIT (http://www.nitlanguage.org).
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 # Abstract display services
16 module display
17
18 import ::glesv2
19
20 # Should Gamnit be more verbose?
21 fun debug_gamnit: Bool do return false
22
23 # General display class, is sized and drawable
24 class GamnitDisplay
25
26 # Width of the display, in pixels
27 fun width: Int is abstract
28
29 # Height of the display, in pixels
30 fun height: Int is abstract
31
32 # Prepare this display
33 #
34 # The implementation varies per platform.
35 fun setup is abstract
36
37 # Close this display and free underlying resources
38 #
39 # The implementation varies per platform.
40 fun close do end
41
42 # Flip the display buffers
43 #
44 # The implementation varies per platform.
45 fun flip do end
46 end