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 import mnit::input
  20
  21 import display_linux is conditional(linux)
  22 import display_android is conditional(android)
  23
  24 # Should Gamnit be more verbose?
  25 fun debug_gamnit: Bool do return false
  26
  27 # General display class, is sized and drawable
  28 class GamnitDisplay
  29
  30         # Width of the display, in pixels
  31         fun width: Int is abstract
  32
  33         # Height of the display, in pixels
  34         fun height: Int is abstract
  35
  36         # Aspect ratio of the screen, `width / height`
  37         var aspect_ratio: Float is lazy do return width.to_f / height.to_f
  38
  39         # Is the cursor locked et the center of the screen?
  40         var lock_cursor = false is writable
  41
  42         # Is the cursor visible?
  43         #
  44         # Only affects the desktop implementations.
  45         var show_cursor: Bool = true is writable
  46
  47         # Prepare this display
  48         #
  49         # The implementation varies per platform.
  50         fun setup is abstract
  51
  52         # Close this display and free underlying resources
  53         #
  54         # The implementation varies per platform.
  55         fun close do end
  56
  57         # Flip the display buffers
  58         #
  59         # The implementation varies per platform.
  60         fun flip do end
  61
  62         # Loop on available events and feed them back to the app
  63         #
  64         # The implementation varies per platform.
  65         fun feed_events do end
  66 end