Class: LiteRGSS::DisplayWindow

Inherits:
Object
  • Object
show all
Defined in:
LiteRGSS.rb.yard.rb

Overview

Class that describe a Window holding the OpenGL context & all drawable

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#height ⇒ Integer (readonly)

Returns get the height of the window.

Returns:

  • (Integer) —

    get the height of the window



1003
1004
1005
 
# File 'LiteRGSS.rb.yard.rb', line 1003

def height
  @height
end

#icon=(value) ⇒ Image (writeonly)

Returns Set the icon of the window.

Returns:

  • (Image) —

    Set the icon of the window



1017
1018
1019
 
# File 'LiteRGSS.rb.yard.rb', line 1017

def icon=(value)
  @icon = value
end

#openGL_version ⇒ Array<Integer> (readonly)

Returns Major & Minor version number of the currently running OpenGL version.

Returns:

  • (Array<Integer>) —

    Major & Minor version number of the currently running OpenGL version



1032
1033
1034
 
# File 'LiteRGSS.rb.yard.rb', line 1032

def openGL_version
  @openGL_version
end

#settings ⇒ Array(title, width, height, scale, bpp, fps, vsync, fullscreen, visible_mouse)

Returns:

  • (Array(title, width, height, scale, bpp, fps, vsync, fullscreen, visible_mouse)) 


1026
1027
1028
 
# File 'LiteRGSS.rb.yard.rb', line 1026

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).

Returns:

  • (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)



1015
1016
1017
 
# File 'LiteRGSS.rb.yard.rb', line 1015

def shader
  @shader
end

#width ⇒ Integer (readonly)

Returns get the width of the window.

Returns:

  • (Integer) —

    get the width of the window



1001
1002
1003
 
# File 'LiteRGSS.rb.yard.rb', line 1001

def width
  @width
end

#x ⇒ Integer

Returns X coordinate of the window on the desktop.

Returns:

  • (Integer) —

    X coordinate of the window on the desktop



1028
1029
1030
 
# File 'LiteRGSS.rb.yard.rb', line 1028

def x
  @x
end

#y ⇒ Integer

Returns Y coordinate of the window on the desktop.

Returns:

  • (Integer) —

    Y coordinate of the window on the desktop



1030
1031
1032
 
# File 'LiteRGSS.rb.yard.rb', line 1030

def y
  @y
end

Class Method Details

.desktop_height ⇒ Integer

Get the desktop height

Returns:

  • (Integer) 


1219
1220
1221
 
# File 'LiteRGSS.rb.yard.rb', line 1219

def self.desktop_height

end

.desktop_width ⇒ Integer

Get the desktop width

Returns:

  • (Integer) 


1214
1215
1216
 
# File 'LiteRGSS.rb.yard.rb', line 1214

def self.desktop_width

end

.list_resolutions ⇒ Array

List all the resolution available on the current device

Returns:

  • (Array) —
    [width1, height1], [width2, height2], … 


1209
1210
1211
 
# File 'LiteRGSS.rb.yard.rb', line 1209

def self.list_resolutions

end

.max_texture_size ⇒ Integer

Maximum size of the texture for the device the OpenGL context are currently running over

Returns:

  • (Integer) 


966
967
 
# File 'LiteRGSS.rb.yard.rb', line 966

def self.max_texture_size
end

.new(title, width, height, scale, bpp = 32, frame_rate = 60, vsync = false, fullscreen = false, mouse_visible = false)

Create a new DisplayWindow

Parameters:

  • title (String) —

    title of the window

  • width (Integer) —

    width of the window content

  • height (Integer) —

    height of the window content

  • scale (Float) —

    scale of the window content (if width = 320 & scale = 2, window final width is 640 + frame)

  • bpp (Integer) (defaults to: 32) —

    number of bit per pixels

  • frame_rate (Integer) (defaults to: 60) —

    locked framerate of the window, 0 = unlimited fps

  • vsync (Boolean) (defaults to: false) —

    if vsync is on or off

  • fullscreen (Boolean) (defaults to: false) —

    if window should be in fullscreen mode

  • mouse_visible (Boolean) (defaults to: false) —

    if the mouse should be visible inside the window



978
979
980
 
# File 'LiteRGSS.rb.yard.rb', line 978

def self.new(title, width, height, scale, bpp = 32, frame_rate = 60, vsync = false, fullscreen = false, mouse_visible = false)

end

Instance Method Details

#dispose

Dispose the window and forcefully close it



982
983
984
 
# File 'LiteRGSS.rb.yard.rb', line 982

def dispose

end

#on_closed=(proc)

Define the event called when the on close event is detected

Examples:

Prevent the user from closing the window if $no_close is true

win.on_close = proc do
  next false if $no_close


1037
1038
1039
 
# File 'LiteRGSS.rb.yard.rb', line 1037

def on_closed=(proc)

end

#on_gained_focus=(proc)

Define the event called when the window gains focus

Examples:

Detect that the window gained focus

win.on_gained_focus = proc do
  puts "Focus gained"
end


1064
1065
1066
 
# File 'LiteRGSS.rb.yard.rb', line 1064

def on_gained_focus=(proc)

end

#on_joystick_button_pressed=(proc)

Define the event called when a button is pressed on a joystick

Examples:

Detect the button press of a joystick

win.on_joystick_button_pressed = proc do |joy_id, button|
  puts "Joystick button ##{button} on stick ##{joy_id} was pressed"
end


1140
1141
1142
 
# File 'LiteRGSS.rb.yard.rb', line 1140

def on_joystick_button_pressed=(proc)

end

#on_joystick_button_released=(proc)

Define the event called when a button is released on a joystick

Examples:

Detect a button release of a joystick

win.on_joystick_button_released = proc do |joy_id, button|
  puts "Joystick button ##{button} on stick ##{joy_id} was released"
end


1148
1149
1150
 
# File 'LiteRGSS.rb.yard.rb', line 1148

def on_joystick_button_released=(proc)

end

#on_joystick_connected=(proc)

Define the event called when a joystick gets plugged in

Examples:

Detect a joystick connection

win.on_joystick_connected = proc do |joy_id|
  puts "Joystick #{joy_id} connected!"
end


1164
1165
1166
 
# File 'LiteRGSS.rb.yard.rb', line 1164

def on_joystick_connected=(proc)

end

#on_joystick_disconnected=(proc)

Define the event called when a joystick gets unplugged

Examples:

Detect a joystick disconnection

win.on_joystick_disconnected = proc do |joy_id|
  puts "Joystick #{joy_id} disconnected!"
end


1172
1173
1174
 
# File 'LiteRGSS.rb.yard.rb', line 1172

def on_joystick_disconnected=(proc)

end

#on_joystick_moved=(proc)

Define the event called when a joystick axis is moved

Examples:

Detect a joystick axis movement

win.on_joystick_moved = proc do |joy_id, axis, position|
  puts "Axis #{axis} of joystick ##{joy_id} moved to #{position}"
end


1156
1157
1158
 
# File 'LiteRGSS.rb.yard.rb', line 1156

def on_joystick_moved=(proc)

end

#on_key_pressed=(proc)

Define the event called when a key is pressed

Examples:

Detect the key press

win.on_key_pressed = proc do |key, alt, control, shift, system|
  puts "User pressed #{key} with following state: a:#{alt}, c:#{control}, s:#{shift}, sys:#{system}"
end


1080
1081
1082
 
# File 'LiteRGSS.rb.yard.rb', line 1080

def on_key_pressed=(proc)

end

#on_key_released=(proc)

Define the event called when a key is released

Examples:

Detect the key release

win.on_key_released = proc do |key|
  puts "User released #{key}"
end


1088
1089
1090
 
# File 'LiteRGSS.rb.yard.rb', line 1088

def on_key_released=(proc)

end

#on_lost_focus=(proc)

Define the event called when the window lost focus

Examples:

Detect that the window lost focus

win.on_lost_focus = proc do
  puts "Lost focus"
end


1056
1057
1058
 
# File 'LiteRGSS.rb.yard.rb', line 1056

def on_lost_focus=(proc)

end

#on_mouse_button_pressed=(proc)

Define the event called when a mouse key is pressed

Examples:

Detect a mouse press event

win.on_mouse_button_pressed = proc do |button|
  puts "Mouse button pressed: #{button}"
end


1104
1105
1106
 
# File 'LiteRGSS.rb.yard.rb', line 1104

def on_mouse_button_pressed=(proc)

end

#on_mouse_button_released=(proc)

Define the event called when a mouse key is released

Examples:

Detect a mouse key released event

win.on_mouse_button_released = proc do |button|
  puts "Mouse button released: #{button}"
end


1112
1113
1114
 
# File 'LiteRGSS.rb.yard.rb', line 1112

def on_mouse_button_released=(proc)

end

#on_mouse_entered=(proc)

Define the event called when the mouse enters the window

Examples:

Detect a mouse enter event

win.on_mouse_entered = proc { puts "Mouse entered the screen" }


1126
1127
1128
 
# File 'LiteRGSS.rb.yard.rb', line 1126

def on_mouse_entered=(proc)

end

#on_mouse_left=(proc)

Define the event called when the mouse leaves the window

Examples:

Detect a move left event

win.on_mouse_left = proc { puts "Mouse left the screen" }


1132
1133
1134
 
# File 'LiteRGSS.rb.yard.rb', line 1132

def on_mouse_left=(proc)

end

#on_mouse_moved=(proc)

Define the event called when the mouse moves

Examples:

Detect a mouse moved event

win.on_mouse_moved = proc|x, y|
  puts "Mouse moved to: (#{x}, #{y})"
end


1120
1121
1122
 
# File 'LiteRGSS.rb.yard.rb', line 1120

def on_mouse_moved=(proc)

end

#on_mouse_wheel_scrolled=(proc)

Define the event called when the mouse wheel is scrolled

Examples:

Detect a mouse wheel event

win.on_mouse_wheel_scrolled = proc do |wheel, delta|
  puts "Mouse wheel ##{wheel} scrolled #{delta}"
end


1096
1097
1098
 
# File 'LiteRGSS.rb.yard.rb', line 1096

def on_mouse_wheel_scrolled=(proc)

end

#on_resized=(proc)

next true

end

Define the event called when the resize event is detected

Examples:

Detect that the window was resize

win.on_resized = proc do |width, height|
  puts "Resized to : (#{width}, #{height})"
end


1048
1049
1050
 
# File 'LiteRGSS.rb.yard.rb', line 1048

def on_resized=(proc)

end

#on_sensor_changed=(proc)

Define the event called when a sensor event was triggered

Examples:

Detect a sensor change

win.on_sensor_changed = proc do |sensor_type, x, y, z|
  puts "Sensor #{sensor_type} changed to: (#{x}, #{y}, #{z})"
end


1204
1205
1206
 
# File 'LiteRGSS.rb.yard.rb', line 1204

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)

Examples:

Detect the text entered

win.on_text_entered = proc do |text|
  puts "User entered : #{text}"
end


1072
1073
1074
 
# File 'LiteRGSS.rb.yard.rb', line 1072

def on_text_entered=(proc)

end

#on_touch_began=(proc)

Define the event called when a touch event has begun

Examples:

Detect a touch event that begins

win.on_touch_began = proc do |finger_id, x, y|
  puts "Touch ##{finger_id} started on: (#{x}, #{y})"
end


1180
1181
1182
 
# File 'LiteRGSS.rb.yard.rb', line 1180

def on_touch_began=(proc)

end

#on_touch_ended=(proc)

Define the event called when the touche ended

Examples:

Detect a touch end event

win.on_touch_ended = proc do |finger_id, x, y|
  puts "Touch ##{finger_id} ended on: (#{x}, #{y})"
end


1196
1197
1198
 
# File 'LiteRGSS.rb.yard.rb', line 1196

def on_touch_ended=(proc)

end

#on_touch_moved=(proc)

Define the event called when the touch moved

Examples:

Detect a touch moved example

win.on_touch_moved = proc do |finger_id, x, y|
  puts "Touch ##{finger_id} moved to: (#{x}, #{y})"
end


1188
1189
1190
 
# File 'LiteRGSS.rb.yard.rb', line 1188

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

Parameters:

  • width (Integer)
  • height (Integer)

Returns:

  • (self) 


1022
1023
1024
 
# File 'LiteRGSS.rb.yard.rb', line 1022

def resize_screen(width, height)

end

#snap_to_bitmap ⇒ Bitmap

Take a snapshot of the window content

Returns:



997
998
999
 
# File 'LiteRGSS.rb.yard.rb', line 997

def snap_to_bitmap

end

#sort_z ⇒ self

Update window internal order according to z of each entities

Returns:

  • (self) 


992
993
994
 
# File 'LiteRGSS.rb.yard.rb', line 992

def sort_z

end

#update ⇒ self

Update window content & events. This method might wait for vsync before updating events

Returns:

  • (self) 


987
988
989
 
# File 'LiteRGSS.rb.yard.rb', line 987

def update

end

#update_no_input ⇒ self

Update the window content. This method might wait for vsync before returning

Returns:

  • (self) 


1006
1007
1008
 
# File 'LiteRGSS.rb.yard.rb', line 1006

def update_no_input

end

#update_only_input ⇒ self

Update the window event without drawing anything.

Returns:

  • (self) 


1011
1012
1013
 
# File 'LiteRGSS.rb.yard.rb', line 1011

def update_only_input

end