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 import display_linux is conditional(linux)
  21 import display_android is conditional(android)
  22
  23 # Should Gamnit be more verbose?
  24 fun debug_gamnit: Bool do return false
  25
  26 # General display class, is sized and drawable
  27 class GamnitDisplay
  28
  29         # Width of the display, in pixels
  30         fun width: Int is abstract
  31
  32         # Height of the display, in pixels
  33         fun height: Int is abstract
  34
  35         # Aspect ratio of the screen, `width / height`
  36         var aspect_ratio: Float is lazy do return width.to_f / height.to_f
  37
  38         # Prepare this display
  39         #
  40         # The implementation varies per platform.
  41         fun setup is abstract
  42
  43         # Close this display and free underlying resources
  44         #
  45         # The implementation varies per platform.
  46         fun close do end
  47
  48         # Flip the display buffers
  49         #
  50         # The implementation varies per platform.
  51         fun flip do end
  52 end