Class: LiteRGSS::DisplayWindow
Overview
Class that describe a Window holding the OpenGL context & all drawable
Instance Attribute Summary collapse
-
#height ⇒ Integer
readonly
Get the height of the window.
-
#icon ⇒ Image
writeonly
Set the icon of the window.
-
#openGL_version ⇒ Array<Integer>
readonly
Major & Minor version number of the currently running OpenGL version.
- #settings ⇒ Array(title, width, height, scale, bpp, fps, vsync, fullscreen, visible_mouse)
-
#shader ⇒ Shader
Set the global shader applied to the final content of the window (shader is applied with total pixel size and not native pixel size).
-
#width ⇒ Integer
readonly
Get the width of the window.
-
#x ⇒ Integer
X coordinate of the window on the desktop.
-
#y ⇒ Integer
Y coordinate of the window on the desktop.
Class Method Summary collapse
-
.desktop_height ⇒ Integer
Get the desktop height.
-
.desktop_width ⇒ Integer
Get the desktop width.
-
.list_resolutions ⇒ Array
List all the resolution available on the current device.
-
.max_texture_size ⇒ Integer
Maximum size of the texture for the device the OpenGL context are currently running over.
Instance Method Summary collapse
-
#dispose
Dispose the window and forcefully close it.
-
#initialize(title, width, height, scale, bpp = 32, frame_rate = 60, vsync = false, fullscreen = false, mouse_visible = false) ⇒ DisplayWindow
constructor
Create a new DisplayWindow.
-
#on_closed=(proc)
Define the event called when the on close event is detected.
-
#on_gained_focus=(proc)
Define the event called when the window gains focus.
-
#on_joystick_button_pressed=(proc)
Define the event called when a button is pressed on a joystick.
-
#on_joystick_button_released=(proc)
Define the event called when a button is released on a joystick.
-
#on_joystick_connected=(proc)
Define the event called when a joystick gets plugged in.
-
#on_joystick_disconnected=(proc)
Define the event called when a joystick gets unplugged.
-
#on_joystick_moved=(proc)
Define the event called when a joystick axis is moved.
-
#on_key_pressed=(proc)
Define the event called when a key is pressed.
-
#on_key_released=(proc)
Define the event called when a key is released.
-
#on_lost_focus=(proc)
Define the event called when the window lost focus.
-
#on_mouse_button_pressed=(proc)
Define the event called when a mouse key is pressed.
-
#on_mouse_button_released=(proc)
Define the event called when a mouse key is released.
-
#on_mouse_entered=(proc)
Define the event called when the mouse enters the window.
-
#on_mouse_left=(proc)
Define the event called when the mouse leaves the window.
-
#on_mouse_moved=(proc)
Define the event called when the mouse moves.
-
#on_mouse_wheel_scrolled=(proc)
Define the event called when the mouse wheel is scrolled.
-
#on_resized=(proc)
next true end Define the event called when the resize event is detected.
-
#on_sensor_changed=(proc)
Define the event called when a sensor event was triggered.
-
#on_text_entered=(proc)
Define the event called when a text entry is detected on the window (usally a character representing the UTF-8 pressed key).
-
#on_touch_began=(proc)
Define the event called when a touch event has begun.
-
#on_touch_ended=(proc)
Define the event called when the touche ended.
-
#on_touch_moved=(proc)
Define the event called when the touch moved.
-
#resize_screen(width, height) ⇒ self
Change the window screen size but keep every other parameter in the same settings.
-
#snap_to_bitmap ⇒ Bitmap
Take a snapshot of the window content.
-
#sort_z ⇒ self
Update window internal order according to z of each entities.
-
#update ⇒ self
Update window content & events.
-
#update_no_input ⇒ self
Update the window content.
-
#update_only_input ⇒ self
Update the window event without drawing anything.
Constructor Details
#initialize(title, width, height, scale, bpp = 32, frame_rate = 60, vsync = false, fullscreen = false, mouse_visible = false) ⇒ DisplayWindow
Create a new DisplayWindow
985 986 987 |
# File 'LiteRGSS.rb.yard.rb', line 985 def initialize(title, width, height, scale, bpp = 32, frame_rate = 60, vsync = false, fullscreen = false, mouse_visible = false) end |
Instance Attribute Details
#height ⇒ Integer (readonly)
Returns get the height of the window.
1010 1011 1012 |
# File 'LiteRGSS.rb.yard.rb', line 1010 def height @height end |
#icon=(value) ⇒ Image (writeonly)
Returns Set the icon of the window.
1024 1025 1026 |
# File 'LiteRGSS.rb.yard.rb', line 1024 def icon=(value) @icon = value end |
#openGL_version ⇒ Array<Integer> (readonly)
Returns Major & Minor version number of the currently running OpenGL version.
1039 1040 1041 |
# File 'LiteRGSS.rb.yard.rb', line 1039 def openGL_version @openGL_version end |
#settings ⇒ Array(title, width, height, scale, bpp, fps, vsync, fullscreen, visible_mouse)
1033 1034 1035 |
# File 'LiteRGSS.rb.yard.rb', line 1033 def settings @settings end |
#shader ⇒ Shader
Returns Set the global shader applied to the final content of the window (shader is applied with total pixel size and not native pixel size).
1022 1023 1024 |
# File 'LiteRGSS.rb.yard.rb', line 1022 def shader @shader end |
#width ⇒ Integer (readonly)
Returns get the width of the window.
1008 1009 1010 |
# File 'LiteRGSS.rb.yard.rb', line 1008 def width @width end |
#x ⇒ Integer
Returns X coordinate of the window on the desktop.
1035 1036 1037 |
# File 'LiteRGSS.rb.yard.rb', line 1035 def x @x end |
#y ⇒ Integer
Returns Y coordinate of the window on the desktop.
1037 1038 1039 |
# File 'LiteRGSS.rb.yard.rb', line 1037 def y @y end |
Class Method Details
.desktop_height ⇒ Integer
Get the desktop height
1226 1227 1228 |
# File 'LiteRGSS.rb.yard.rb', line 1226 def self.desktop_height end |
.desktop_width ⇒ Integer
Get the desktop width
1221 1222 1223 |
# File 'LiteRGSS.rb.yard.rb', line 1221 def self.desktop_width end |
.list_resolutions ⇒ Array
List all the resolution available on the current device
1216 1217 1218 |
# File 'LiteRGSS.rb.yard.rb', line 1216 def self.list_resolutions end |
.max_texture_size ⇒ Integer
Maximum size of the texture for the device the OpenGL context are currently running over
973 974 |
# File 'LiteRGSS.rb.yard.rb', line 973 def self.max_texture_size end |
Instance Method Details
#dispose
Dispose the window and forcefully close it
989 990 991 |
# File 'LiteRGSS.rb.yard.rb', line 989 def dispose end |
#on_closed=(proc)
Define the event called when the on close event is detected
1044 1045 1046 |
# File 'LiteRGSS.rb.yard.rb', line 1044 def on_closed=(proc) end |
#on_gained_focus=(proc)
Define the event called when the window gains focus
1071 1072 1073 |
# File 'LiteRGSS.rb.yard.rb', line 1071 def on_gained_focus=(proc) end |
#on_joystick_button_pressed=(proc)
Define the event called when a button is pressed on a joystick
1147 1148 1149 |
# File 'LiteRGSS.rb.yard.rb', line 1147 def (proc) end |
#on_joystick_button_released=(proc)
Define the event called when a button is released on a joystick
1155 1156 1157 |
# File 'LiteRGSS.rb.yard.rb', line 1155 def (proc) end |
#on_joystick_connected=(proc)
Define the event called when a joystick gets plugged in
1171 1172 1173 |
# File 'LiteRGSS.rb.yard.rb', line 1171 def on_joystick_connected=(proc) end |
#on_joystick_disconnected=(proc)
Define the event called when a joystick gets unplugged
1179 1180 1181 |
# File 'LiteRGSS.rb.yard.rb', line 1179 def on_joystick_disconnected=(proc) end |
#on_joystick_moved=(proc)
Define the event called when a joystick axis is moved
1163 1164 1165 |
# File 'LiteRGSS.rb.yard.rb', line 1163 def on_joystick_moved=(proc) end |
#on_key_pressed=(proc)
Define the event called when a key is pressed
1087 1088 1089 |
# File 'LiteRGSS.rb.yard.rb', line 1087 def on_key_pressed=(proc) end |
#on_key_released=(proc)
Define the event called when a key is released
1095 1096 1097 |
# File 'LiteRGSS.rb.yard.rb', line 1095 def on_key_released=(proc) end |
#on_lost_focus=(proc)
Define the event called when the window lost focus
1063 1064 1065 |
# File 'LiteRGSS.rb.yard.rb', line 1063 def on_lost_focus=(proc) end |
#on_mouse_button_pressed=(proc)
Define the event called when a mouse key is pressed
1111 1112 1113 |
# File 'LiteRGSS.rb.yard.rb', line 1111 def (proc) end |
#on_mouse_button_released=(proc)
Define the event called when a mouse key is released
1119 1120 1121 |
# File 'LiteRGSS.rb.yard.rb', line 1119 def (proc) end |
#on_mouse_entered=(proc)
Define the event called when the mouse enters the window
1133 1134 1135 |
# File 'LiteRGSS.rb.yard.rb', line 1133 def on_mouse_entered=(proc) end |
#on_mouse_left=(proc)
Define the event called when the mouse leaves the window
1139 1140 1141 |
# File 'LiteRGSS.rb.yard.rb', line 1139 def on_mouse_left=(proc) end |
#on_mouse_moved=(proc)
Define the event called when the mouse moves
1127 1128 1129 |
# File 'LiteRGSS.rb.yard.rb', line 1127 def on_mouse_moved=(proc) end |
#on_mouse_wheel_scrolled=(proc)
Define the event called when the mouse wheel is scrolled
1103 1104 1105 |
# File 'LiteRGSS.rb.yard.rb', line 1103 def on_mouse_wheel_scrolled=(proc) end |
#on_resized=(proc)
next true end Define the event called when the resize event is detected
1055 1056 1057 |
# File 'LiteRGSS.rb.yard.rb', line 1055 def on_resized=(proc) end |
#on_sensor_changed=(proc)
Define the event called when a sensor event was triggered
1211 1212 1213 |
# File 'LiteRGSS.rb.yard.rb', line 1211 def on_sensor_changed=(proc) end |
#on_text_entered=(proc)
Define the event called when a text entry is detected on the window (usally a character representing the UTF-8 pressed key)
1079 1080 1081 |
# File 'LiteRGSS.rb.yard.rb', line 1079 def on_text_entered=(proc) end |
#on_touch_began=(proc)
Define the event called when a touch event has begun
1187 1188 1189 |
# File 'LiteRGSS.rb.yard.rb', line 1187 def on_touch_began=(proc) end |
#on_touch_ended=(proc)
Define the event called when the touche ended
1203 1204 1205 |
# File 'LiteRGSS.rb.yard.rb', line 1203 def on_touch_ended=(proc) end |
#on_touch_moved=(proc)
Define the event called when the touch moved
1195 1196 1197 |
# File 'LiteRGSS.rb.yard.rb', line 1195 def on_touch_moved=(proc) end |
#resize_screen(width, height) ⇒ self
Change the window screen size but keep every other parameter in the same settings
1029 1030 1031 |
# File 'LiteRGSS.rb.yard.rb', line 1029 def resize_screen(width, height) end |
#snap_to_bitmap ⇒ Bitmap
Take a snapshot of the window content
1004 1005 1006 |
# File 'LiteRGSS.rb.yard.rb', line 1004 def snap_to_bitmap end |
#sort_z ⇒ self
Update window internal order according to z of each entities
999 1000 1001 |
# File 'LiteRGSS.rb.yard.rb', line 999 def sort_z end |
#update ⇒ self
Update window content & events. This method might wait for vsync before updating events
994 995 996 |
# File 'LiteRGSS.rb.yard.rb', line 994 def update end |
#update_no_input ⇒ self
Update the window content. This method might wait for vsync before returning
1013 1014 1015 |
# File 'LiteRGSS.rb.yard.rb', line 1013 def update_no_input end |
#update_only_input ⇒ self
Update the window event without drawing anything.
1018 1019 1020 |
# File 'LiteRGSS.rb.yard.rb', line 1018 def update_only_input end |