From 01b0f37451084c9a12e7e7b144c06ccf2c6f7d41 Mon Sep 17 00:00:00 2001 From: groogy Date: Tue, 16 Nov 2010 16:41:16 +0000 Subject: [PATCH] I forgot to actually include the documentation to the commit. git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1659 4e206d99-4929-0410-ac5d-dfc041789085 --- .../ruby/sfml-system/doc/classes/SFML.html | 145 ++ .../sfml-system/doc/classes/SFML/Clock.html | 227 +++ .../doc/classes/SFML/Clock.src/M000001.html | 26 + .../doc/classes/SFML/Clock.src/M000002.html | 26 + .../doc/classes/SFML/Clock.src/M000003.html | 26 + .../sfml-system/doc/classes/SFML/Vector2.html | 295 ++++ .../doc/classes/SFML/Vector2.src/M000006.html | 49 + .../doc/classes/SFML/Vector2.src/M000007.html | 33 + .../doc/classes/SFML/Vector2.src/M000008.html | 23 + .../doc/classes/SFML/Vector2.src/M000009.html | 30 + .../doc/classes/SFML/Vector2.src/M000010.html | 30 + .../doc/classes/SFML/Vector2.src/M000011.html | 30 + .../doc/classes/SFML/Vector2.src/M000012.html | 30 + .../doc/classes/SFML/Vector2.src/M000013.html | 33 + .../sfml-system/doc/classes/SFML/Vector3.html | 300 ++++ .../doc/classes/SFML/Vector3.src/M000014.html | 52 + .../doc/classes/SFML/Vector3.src/M000015.html | 36 + .../doc/classes/SFML/Vector3.src/M000016.html | 25 + .../doc/classes/SFML/Vector3.src/M000017.html | 33 + .../doc/classes/SFML/Vector3.src/M000018.html | 33 + .../doc/classes/SFML/Vector3.src/M000019.html | 33 + .../doc/classes/SFML/Vector3.src/M000020.html | 33 + .../doc/classes/SFML/Vector3.src/M000021.html | 36 + bindings/ruby/sfml-system/doc/created.rid | 1 + .../sfml-system/doc/files/extconf_rb.html | 137 ++ .../doc/files/system/Clock_cpp.html | 101 ++ .../doc/files/system/Vector2_cpp.html | 101 ++ .../doc/files/system/Vector3_cpp.html | 101 ++ .../doc/files/system/main_cpp.html | 101 ++ .../ruby/sfml-system/doc/fr_class_index.html | 30 + .../ruby/sfml-system/doc/fr_file_index.html | 31 + .../ruby/sfml-system/doc/fr_method_index.html | 47 + bindings/ruby/sfml-system/doc/index.html | 24 + bindings/ruby/sfml-system/doc/rdoc-style.css | 208 +++ .../ruby/sfml-window/doc/classes/SFML.html | 164 +++ .../sfml-window/doc/classes/SFML/Context.html | 236 ++++ .../doc/classes/SFML/Context.src/M000033.html | 26 + .../doc/classes/SFML/Context.src/M000034.html | 32 + .../doc/classes/SFML/Context.src/M000035.html | 36 + .../doc/classes/SFML/ContextSettings.html | 670 +++++++++ .../SFML/ContextSettings.src/M000113.html | 73 + .../SFML/ContextSettings.src/M000114.html | 25 + .../SFML/ContextSettings.src/M000115.html | 25 + .../SFML/ContextSettings.src/M000116.html | 25 + .../SFML/ContextSettings.src/M000117.html | 25 + .../SFML/ContextSettings.src/M000118.html | 25 + .../SFML/ContextSettings.src/M000119.html | 25 + .../SFML/ContextSettings.src/M000120.html | 25 + .../SFML/ContextSettings.src/M000121.html | 25 + .../SFML/ContextSettings.src/M000122.html | 25 + .../SFML/ContextSettings.src/M000123.html | 25 + .../sfml-window/doc/classes/SFML/Event.html | 371 +++++ .../doc/classes/SFML/Event.src/M000091.html | 29 + .../doc/classes/SFML/Event.src/M000092.html | 82 ++ .../doc/classes/SFML/Event/JoyButton.html | 209 +++ .../SFML/Event/JoyButton.src/M000104.html | 17 + .../SFML/Event/JoyButton.src/M000105.html | 17 + .../doc/classes/SFML/Event/JoyMove.html | 227 +++ .../SFML/Event/JoyMove.src/M000110.html | 17 + .../SFML/Event/JoyMove.src/M000111.html | 17 + .../SFML/Event/JoyMove.src/M000112.html | 17 + .../doc/classes/SFML/Event/Key.html | 244 ++++ .../classes/SFML/Event/Key.src/M000106.html | 17 + .../classes/SFML/Event/Key.src/M000107.html | 17 + .../classes/SFML/Event/Key.src/M000108.html | 17 + .../classes/SFML/Event/Key.src/M000109.html | 17 + .../doc/classes/SFML/Event/MouseButton.html | 227 +++ .../SFML/Event/MouseButton.src/M000095.html | 17 + .../SFML/Event/MouseButton.src/M000096.html | 17 + .../SFML/Event/MouseButton.src/M000097.html | 17 + .../doc/classes/SFML/Event/MouseMove.html | 208 +++ .../SFML/Event/MouseMove.src/M000093.html | 17 + .../SFML/Event/MouseMove.src/M000094.html | 17 + .../doc/classes/SFML/Event/MouseWheel.html | 226 +++ .../SFML/Event/MouseWheel.src/M000098.html | 17 + .../SFML/Event/MouseWheel.src/M000099.html | 17 + .../SFML/Event/MouseWheel.src/M000100.html | 17 + .../doc/classes/SFML/Event/Size.html | 208 +++ .../classes/SFML/Event/Size.src/M000101.html | 17 + .../classes/SFML/Event/Size.src/M000102.html | 17 + .../doc/classes/SFML/Event/Text.html | 190 +++ .../classes/SFML/Event/Text.src/M000103.html | 17 + .../sfml-window/doc/classes/SFML/Input.html | 484 +++++++ .../doc/classes/SFML/Input.src/M000001.html | 27 + .../doc/classes/SFML/Input.src/M000002.html | 33 + .../doc/classes/SFML/Input.src/M000003.html | 33 + .../doc/classes/SFML/Input.src/M000004.html | 34 + .../doc/classes/SFML/Input.src/M000005.html | 25 + .../doc/classes/SFML/Input.src/M000006.html | 25 + .../doc/classes/SFML/Input.src/M000007.html | 27 + .../sfml-window/doc/classes/SFML/Joy.html | 159 +++ .../sfml-window/doc/classes/SFML/Key.html | 298 ++++ .../sfml-window/doc/classes/SFML/Mouse.html | 149 ++ .../sfml-window/doc/classes/SFML/Style.html | 149 ++ .../doc/classes/SFML/VideoMode.html | 414 ++++++ .../classes/SFML/VideoMode.src/M000020.html | 42 + .../classes/SFML/VideoMode.src/M000021.html | 26 + .../classes/SFML/VideoMode.src/M000022.html | 37 + .../classes/SFML/VideoMode.src/M000023.html | 25 + .../classes/SFML/VideoMode.src/M000024.html | 25 + .../classes/SFML/VideoMode.src/M000025.html | 25 + .../classes/SFML/VideoMode.src/M000026.html | 25 + .../classes/SFML/VideoMode.src/M000027.html | 25 + .../classes/SFML/VideoMode.src/M000028.html | 25 + .../sfml-window/doc/classes/SFML/Window.html | 1222 +++++++++++++++++ .../doc/classes/SFML/Window.src/M000038.html | 30 + .../doc/classes/SFML/Window.src/M000039.html | 63 + .../doc/classes/SFML/Window.src/M000040.html | 29 + .../doc/classes/SFML/Window.src/M000041.html | 42 + .../doc/classes/SFML/Window.src/M000042.html | 41 + .../doc/classes/SFML/Window.src/M000043.html | 27 + .../doc/classes/SFML/Window.src/M000044.html | 27 + .../doc/classes/SFML/Window.src/M000045.html | 30 + .../doc/classes/SFML/Window.src/M000046.html | 27 + .../doc/classes/SFML/Window.src/M000047.html | 32 + .../doc/classes/SFML/Window.src/M000048.html | 41 + .../doc/classes/SFML/Window.src/M000049.html | 26 + .../doc/classes/SFML/Window.src/M000050.html | 29 + .../doc/classes/SFML/Window.src/M000051.html | 29 + .../doc/classes/SFML/Window.src/M000052.html | 53 + .../doc/classes/SFML/Window.src/M000053.html | 30 + .../doc/classes/SFML/Window.src/M000054.html | 29 + .../doc/classes/SFML/Window.src/M000055.html | 32 + .../doc/classes/SFML/Window.src/M000056.html | 26 + .../doc/classes/SFML/Window.src/M000057.html | 29 + .../doc/classes/SFML/Window.src/M000058.html | 26 + .../doc/classes/SFML/Window.src/M000059.html | 39 + .../doc/classes/SFML/Window.src/M000060.html | 39 + .../doc/classes/SFML/Window.src/M000061.html | 43 + .../doc/classes/SFML/Window.src/M000062.html | 42 + bindings/ruby/sfml-window/doc/created.rid | 1 + .../sfml-window/doc/files/extconf_rb.html | 137 ++ .../doc/files/window/ContextSettings_cpp.html | 101 ++ .../doc/files/window/Context_cpp.html | 101 ++ .../doc/files/window/Event_cpp.html | 101 ++ .../doc/files/window/Input_cpp.html | 101 ++ .../doc/files/window/VideoMode_cpp.html | 101 ++ .../doc/files/window/Window_cpp.html | 101 ++ .../doc/files/window/main_cpp.html | 101 ++ .../ruby/sfml-window/doc/fr_class_index.html | 45 + .../ruby/sfml-window/doc/fr_file_index.html | 34 + .../ruby/sfml-window/doc/fr_method_index.html | 169 +++ bindings/ruby/sfml-window/doc/index.html | 24 + bindings/ruby/sfml-window/doc/rdoc-style.css | 208 +++ 144 files changed, 12034 insertions(+) create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Clock.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000001.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000002.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000003.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000006.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000007.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000008.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000009.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000010.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000011.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000012.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000013.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000014.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000015.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000016.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000017.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000018.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000019.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000020.html create mode 100644 bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000021.html create mode 100644 bindings/ruby/sfml-system/doc/created.rid create mode 100644 bindings/ruby/sfml-system/doc/files/extconf_rb.html create mode 100644 bindings/ruby/sfml-system/doc/files/system/Clock_cpp.html create mode 100644 bindings/ruby/sfml-system/doc/files/system/Vector2_cpp.html create mode 100644 bindings/ruby/sfml-system/doc/files/system/Vector3_cpp.html create mode 100644 bindings/ruby/sfml-system/doc/files/system/main_cpp.html create mode 100644 bindings/ruby/sfml-system/doc/fr_class_index.html create mode 100644 bindings/ruby/sfml-system/doc/fr_file_index.html create mode 100644 bindings/ruby/sfml-system/doc/fr_method_index.html create mode 100644 bindings/ruby/sfml-system/doc/index.html create mode 100644 bindings/ruby/sfml-system/doc/rdoc-style.css create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Context.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000033.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000034.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000035.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000113.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000114.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000115.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000116.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000117.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000118.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000119.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000120.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000121.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000122.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000123.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000091.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000092.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000104.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000105.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000110.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000111.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000112.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000106.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000107.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000108.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000109.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000095.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000096.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000097.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000093.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000094.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000098.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000099.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000100.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000101.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000102.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.src/M000103.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000001.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000002.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000003.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000004.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000005.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000006.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000007.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Joy.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Key.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Mouse.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Style.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000020.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000021.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000022.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000023.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000024.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000025.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000026.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000027.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000028.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000038.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000039.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000040.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000041.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000042.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000043.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000044.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000045.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000046.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000047.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000048.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000049.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000050.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000051.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000052.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000053.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000054.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000055.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000056.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000057.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000058.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000059.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000060.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000061.html create mode 100644 bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000062.html create mode 100644 bindings/ruby/sfml-window/doc/created.rid create mode 100644 bindings/ruby/sfml-window/doc/files/extconf_rb.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/ContextSettings_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/Context_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/Event_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/Input_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/VideoMode_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/Window_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/files/window/main_cpp.html create mode 100644 bindings/ruby/sfml-window/doc/fr_class_index.html create mode 100644 bindings/ruby/sfml-window/doc/fr_file_index.html create mode 100644 bindings/ruby/sfml-window/doc/fr_method_index.html create mode 100644 bindings/ruby/sfml-window/doc/index.html create mode 100644 bindings/ruby/sfml-window/doc/rdoc-style.css diff --git a/bindings/ruby/sfml-system/doc/classes/SFML.html b/bindings/ruby/sfml-system/doc/classes/SFML.html new file mode 100644 index 00000000..82e09f17 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML.html @@ -0,0 +1,145 @@ + + + + + + Module: SFML + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSFML
In: + + system/Vector3.cpp + +
+ + system/main.cpp + +
+ + system/Clock.cpp + +
+ + system/Vector2.cpp + +
+
+
+ + +
+ + + +
+ +
+

+SFML namespace which contains the classes of this +module. +

+ +
+ + +
+ + +
+ + + + +
+ +
+

Classes and Modules

+ + Class SFML::Clock
+Class SFML::Vector2
+Class SFML::Vector3
+ +
+ +
+

Constants

+ +
+ + + + + + +
SystemLoaded=Qtrue
+
+
+ + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Clock.html b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.html new file mode 100644 index 00000000..b53f79d1 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.html @@ -0,0 +1,227 @@ + + + + + + Class: SFML::Clock + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Clock
In: + + system/Vector3.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+Utility class for manipulating time. +

+

+sf::Clock is a lightweight class for measuring +time. +

+

+Its resolution depends on the underlying OS, but you can generally expect a +1 ms resolution. +

+ +
+ + +
+ +
+

Methods

+ +
+ elapsedTime   + elapsed_time   + getElapsedTime   + new   + reset   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Class methods

+ +
+ + +
+ + Clock.new() → clock
+ + +
+ +
+

+The clock starts automatically after being constructed. +

+
+
+ +

Public Instance methods

+ +
+ + +
+ elapsedTime() +
+ +
+

+Alias for getElapsedTime +

+
+
+ +
+ + +
+ elapsed_time() +
+ +
+

+Alias for getElapsedTime +

+
+
+ +
+ + +
+ + clock.getElapsedTime() → Float
+ + +
+ +
+

+This function returns the time elapsed since the last call to Reset() (or +the construction of the instance if Reset() has not been called) in +seconds. +

+
+
+ +
+ + +
+ + clock.reset() → nil
+ + +
+ +
+

+This function puts the time counter back to zero. +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000001.html b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000001.html new file mode 100644 index 00000000..20e9a5c5 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000001.html @@ -0,0 +1,26 @@ + + + + + + new (SFML::Clock) + + + + + 
/* call-seq:
+ *   Clock.new()                -> clock
+ *
+ * The clock starts automatically after being constructed.
+ */
+static VALUE Clock_New( VALUE aKlass )
+{
+        sf::Clock *object = new sf::Clock();
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, Clock_Free, object );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000002.html b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000002.html new file mode 100644 index 00000000..61c86119 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000002.html @@ -0,0 +1,26 @@ + + + + + + getElapsedTime (SFML::Clock) + + + + + 
/* call-seq:
+ *   clock.getElapsedTime()             -> Float
+ *
+ * This function returns the time elapsed since the last call to Reset() 
+ * (or the construction of the instance if Reset() has not been called) in seconds.
+ */
+static VALUE Clock_GetElapsedTime( VALUE self )
+{
+        sf::Clock *object = NULL;
+        Data_Get_Struct( self, sf::Clock, object );
+        return rb_float_new( object->GetElapsedTime() );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000003.html b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000003.html new file mode 100644 index 00000000..30e77124 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Clock.src/M000003.html @@ -0,0 +1,26 @@ + + + + + + reset (SFML::Clock) + + + + + 
/* call-seq:
+ *   clock.reset()              -> nil
+ * 
+ * This function puts the time counter back to zero.
+ */
+static VALUE Clock_Reset( VALUE self )
+{
+        sf::Clock *object = NULL;
+        Data_Get_Struct( self, sf::Clock, object );
+        object->Reset();
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.html new file mode 100644 index 00000000..0636fbfd --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.html @@ -0,0 +1,295 @@ + + + + + + Class: SFML::Vector2 + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Vector2
In: + + system/Vector3.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Vector2 is a simple class that defines a +mathematical vector with two coordinates (x and y). +

+

+It can be used to represent anything that has two dimensions: a size, a +point, a velocity, etc. +

+

+This class differs from the C++ version. It will accept any value that is +Numeric and both x and y must be of the same class. +

+
+  v1 = SFML::Vector2.new(16.5, 24.0)
+  v1.x = 18.2
+  y = v1.y
+
+  v2 = v1 * v1;
+  v3 = SFML::Vector2.new
+  v3 = v1 + v2
+
+  different = (v2 != v3);
+
+ +
+ + +
+ +
+

Methods

+ +
+ *   + +   + -   + -@   + /   + ==   + eql?   + new   +
+
+ +
+ + + + +
+ + + + + +
+

Attributes

+ +
+ + + + + + + + + + + +
x [RW] 
y [RW] 
+
+
+ + + + +
+

Public Class methods

+ + + +

Public Instance methods

+ +
+ + +
+ + *(p1) + +
+ +
+
+
+ +
+ + +
+ + +(p1) + +
+ +
+
+
+ +
+ + +
+ + -(p1) + +
+ +
+
+
+ +
+ + +
+ + -@() + +
+ +
+
+
+ +
+ + +
+ + /(p1) + +
+ +
+
+
+ +
+ + +
+ + ==(p1) + +
+ +
+
+
+ +
+ + +
+ + eql?(p1) + +
+ +
+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000006.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000006.html new file mode 100644 index 00000000..6cd7c754 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000006.html @@ -0,0 +1,49 @@ + + + + + + new (SFML::Vector2) + + + + + 
/* call-seq:
+ *   Vector2.new()                      -> vector
+ *   Vector2.new([x,y])         -> vector
+ *       Vector2.new(vector)         -> vector
+ *   Vector2.new(x,y)           -> vector
+ * 
+ * Create a new vector instance.
+ */
+static VALUE Vector2_Initialize( VALUE self, VALUE someArgs )
+{
+        long arrayLength = RARRAY_LEN( someArgs );
+        rb_iv_set( self, "@x", INT2NUM( 0 ) );
+        rb_iv_set( self, "@y", INT2NUM( 0 ) );
+        
+        if( arrayLength == 0 )
+        {
+                // Nothing needs to be done
+        }
+        else if( arrayLength == 1 )
+        {
+                Vector2_internal_CopyFrom( self, rb_ary_entry( someArgs, 0 ) );
+        }
+        else if( arrayLength == 2 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                VALUE arg2 = rb_ary_entry( someArgs, 1 );
+                Vector2_internal_ValidateTypes( arg1, arg2 );
+                
+                rb_iv_set( self, "@x", arg1 );
+                rb_iv_set( self, "@y", arg2 );
+        }
+        
+        rb_iv_set( self, "@dataType", CLASS_OF( rb_iv_get( self, "@x" ) ) );
+        return self;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000007.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000007.html new file mode 100644 index 00000000..36e91e69 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000007.html @@ -0,0 +1,33 @@ + + + + + + eql? (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_StrictEqual( VALUE self, VALUE anArgument )
+{
+        VALUE aVector = Vector2_ForceType( anArgument );
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE rightX = rb_funcall( aVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( aVector, rb_intern( "y" ), 0 );
+        
+        if( rb_funcall( leftX, rb_intern( "eql?" ), 1, rightX ) == Qtrue &&
+            rb_funcall( leftY, rb_intern( "eql?" ), 1, rightY ) == Qtrue )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000008.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000008.html new file mode 100644 index 00000000..fbae0ebf --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000008.html @@ -0,0 +1,23 @@ + + + + + + -@ (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_Negate( VALUE self )
+{
+        VALUE x = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE y = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE negatedX = rb_funcall( x, rb_intern( "-@" ), 0 );
+        VALUE negatedY = rb_funcall( y, rb_intern( "-@" ), 0 );
+        return rb_funcall( globalVector2Class, rb_intern( "new" ), 2, negatedX, negatedY );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000009.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000009.html new file mode 100644 index 00000000..0a36faa9 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000009.html @@ -0,0 +1,30 @@ + + + + + + + (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_Add( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector2_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+
+        // Do calculation      
+        VALUE newX = rb_funcall( leftX, rb_intern( "+" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "+" ), 1, rightY );
+        
+        return rb_funcall( globalVector2Class, rb_intern( "new" ), 2, newX, newY );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000010.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000010.html new file mode 100644 index 00000000..ef23af0a --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000010.html @@ -0,0 +1,30 @@ + + + + + + - (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_Subtract( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector2_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+
+        // Do calculation
+        VALUE newX = rb_funcall( leftX, rb_intern( "-" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "-" ), 1, rightY );
+        
+        return rb_funcall( globalVector2Class, rb_intern( "new" ), 2, newX, newY );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000011.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000011.html new file mode 100644 index 00000000..af440437 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000011.html @@ -0,0 +1,30 @@ + + + + + + * (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_Multiply( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector2_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+
+        // Do calculation
+        VALUE newX = rb_funcall( leftX, rb_intern( "*" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "*" ), 1, rightY );
+        
+        return rb_funcall( globalVector2Class, rb_intern( "new" ), 2, newX, newY );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000012.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000012.html new file mode 100644 index 00000000..6189e002 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000012.html @@ -0,0 +1,30 @@ + + + + + + / (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_Divide( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector2_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+
+        // Do calculation      
+        VALUE newX = rb_funcall( leftX, rb_intern( "/" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "/" ), 1, rightY );
+        
+        return rb_funcall( globalVector2Class, rb_intern( "new" ), 2, newX, newY );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000013.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000013.html new file mode 100644 index 00000000..225b6f42 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector2.src/M000013.html @@ -0,0 +1,33 @@ + + + + + + == (SFML::Vector2) + + + + + 
/* */
+static VALUE Vector2_Equal( VALUE self, VALUE anArgument )
+{
+        VALUE aVector = Vector2_ForceType( anArgument );
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE rightX = rb_funcall( aVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( aVector, rb_intern( "y" ), 0 );
+        
+        if( rb_funcall( leftX, rb_intern( "==" ), 1, rightX ) == Qtrue &&
+            rb_funcall( leftY, rb_intern( "==" ), 1, rightY ) == Qtrue )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.html new file mode 100644 index 00000000..12c95d9a --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.html @@ -0,0 +1,300 @@ + + + + + + Class: SFML::Vector3 + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Vector3
In: + + system/Vector3.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Vector3 is a simple class that defines a +mathematical vector with three coordinates (x, y and z). +

+

+It can be used to represent anything that has three dimensions: a size, a +point, a velocity, etc. +

+

+This class differs from the C++ version. It will accept any value that is +Numeric and both x, y an z must be of the same class. +

+
+  v1 = SFML::Vector3.new(16.5, 24.0, -8.2)
+  v1.z = 18.2
+  y = v1.y
+
+  v2 = v1 * v1;
+  v3 = SFML::Vector3.new
+  v3 = v1 + v2
+
+  different = (v2 != v3);
+
+ +
+ + +
+ +
+

Methods

+ +
+ *   + +   + -   + -@   + /   + ==   + eql?   + new   +
+
+ +
+ + + + +
+ + + + + +
+

Attributes

+ +
+ + + + + + + + + + + + + + + + +
x [RW] 
y [RW] 
z [RW] 
+
+
+ + + + +
+

Public Class methods

+ + + +

Public Instance methods

+ +
+ + +
+ + *(p1) + +
+ +
+
+
+ +
+ + +
+ + +(p1) + +
+ +
+
+
+ +
+ + +
+ + -(p1) + +
+ +
+
+
+ +
+ + +
+ + -@() + +
+ +
+
+
+ +
+ + +
+ + /(p1) + +
+ +
+
+
+ +
+ + +
+ + ==(p1) + +
+ +
+
+
+ +
+ + +
+ + eql?(p1) + +
+ +
+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000014.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000014.html new file mode 100644 index 00000000..240e05af --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000014.html @@ -0,0 +1,52 @@ + + + + + + new (SFML::Vector3) + + + + + 
/* call-seq:
+ *   Vector3.new()                      -> vector
+ *   Vector3.new([x,y,z])       -> vector
+ *       Vector3.new(vector)         -> vector
+ *   Vector3.new(x,y,z)         -> vector
+ * 
+ * Create a new vector instance.
+ */
+static VALUE Vector3_Initialize( VALUE self, VALUE someArgs )
+{
+        long arrayLength = RARRAY_LEN( someArgs );
+        rb_iv_set( self, "@x", INT2NUM( 0 ) );
+        rb_iv_set( self, "@y", INT2NUM( 0 ) );
+        rb_iv_set( self, "@z", INT2NUM( 0 ) );
+        
+        if( arrayLength == 0 )
+        {
+                // Nothing needs to be done
+        }
+        else if( arrayLength == 1 )
+        {
+                Vector3_internal_CopyFrom( self, rb_ary_entry( someArgs, 0 ) );
+        }
+        else if( arrayLength == 3 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                VALUE arg2 = rb_ary_entry( someArgs, 1 );
+                VALUE arg3 = rb_ary_entry( someArgs, 1 );
+                Vector3_internal_ValidateTypes( arg1, arg2, arg3 );
+                
+                rb_iv_set( self, "@x", arg1 );
+                rb_iv_set( self, "@y", arg2 );
+                rb_iv_set( self, "@z", arg3 );
+        }
+        
+        rb_iv_set( self, "@dataType", CLASS_OF( rb_iv_get( self, "@x" ) ) );
+        return self;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000015.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000015.html new file mode 100644 index 00000000..16d26607 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000015.html @@ -0,0 +1,36 @@ + + + + + + eql? (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_StrictEqual( VALUE self, VALUE anArgument )
+{
+        VALUE aVector = Vector3_ForceType( anArgument );
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE leftZ  = rb_funcall( self, rb_intern( "z" ), 0 );
+        VALUE rightX = rb_funcall( aVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( aVector, rb_intern( "y" ), 0 );
+        VALUE rightZ = rb_funcall( aVector, rb_intern( "z" ), 0 );
+        
+        if( rb_funcall( leftX, rb_intern( "eql?" ), 1, rightX ) == Qtrue &&
+            rb_funcall( leftY, rb_intern( "eql?" ), 1, rightY ) == Qtrue &&
+            rb_funcall( leftZ, rb_intern( "eql?" ), 1, rightZ ) == Qtrue )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000016.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000016.html new file mode 100644 index 00000000..802f50eb --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000016.html @@ -0,0 +1,25 @@ + + + + + + -@ (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_Negate( VALUE self )
+{
+        VALUE x = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE y = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE z = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE negatedX = rb_funcall( x, rb_intern( "-@" ), 0 );
+        VALUE negatedY = rb_funcall( y, rb_intern( "-@" ), 0 );
+        VALUE negatedZ = rb_funcall( z, rb_intern( "-@" ), 0 );
+        return rb_funcall( globalVector3Class, rb_intern( "new" ), 2, negatedX, negatedY, negatedZ );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000017.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000017.html new file mode 100644 index 00000000..2495bd12 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000017.html @@ -0,0 +1,33 @@ + + + + + + + (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_Add( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector3_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE leftZ  = rb_funcall( self, rb_intern( "z" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+        VALUE rightZ = rb_funcall( rightVector, rb_intern( "z" ), 0 );
+
+        // Do calculation      
+        VALUE newX = rb_funcall( leftX, rb_intern( "+" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "+" ), 1, rightY );
+        VALUE newZ = rb_funcall( leftZ, rb_intern( "+" ), 1, rightZ );
+        
+        return rb_funcall( globalVector3Class, rb_intern( "new" ), 2, newX, newY, newZ );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000018.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000018.html new file mode 100644 index 00000000..6820db78 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000018.html @@ -0,0 +1,33 @@ + + + + + + - (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_Subtract( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector3_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE leftZ  = rb_funcall( self, rb_intern( "z" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+        VALUE rightZ = rb_funcall( rightVector, rb_intern( "z" ), 0 );
+
+        // Do calculation      
+        VALUE newX = rb_funcall( leftX, rb_intern( "-" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "-" ), 1, rightY );
+        VALUE newZ = rb_funcall( leftZ, rb_intern( "-" ), 1, rightZ );
+        
+        return rb_funcall( globalVector3Class, rb_intern( "new" ), 2, newX, newY, newZ );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000019.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000019.html new file mode 100644 index 00000000..9fd2a41a --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000019.html @@ -0,0 +1,33 @@ + + + + + + * (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_Multiply( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector3_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE leftZ  = rb_funcall( self, rb_intern( "z" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+        VALUE rightZ = rb_funcall( rightVector, rb_intern( "z" ), 0 );
+
+        // Do calculation      
+        VALUE newX = rb_funcall( leftX, rb_intern( "*" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "*" ), 1, rightY );
+        VALUE newZ = rb_funcall( leftZ, rb_intern( "*" ), 1, rightZ );
+        
+        return rb_funcall( globalVector3Class, rb_intern( "new" ), 2, newX, newY, newZ );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000020.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000020.html new file mode 100644 index 00000000..8a556863 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000020.html @@ -0,0 +1,33 @@ + + + + + + / (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_Divide( VALUE self, VALUE aRightOperand )
+{
+        VALUE rightVector = Vector3_ForceType( aRightOperand );
+        // Get values
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE leftZ  = rb_funcall( self, rb_intern( "z" ), 0 );
+        VALUE rightX = rb_funcall( rightVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( rightVector, rb_intern( "y" ), 0 );
+        VALUE rightZ = rb_funcall( rightVector, rb_intern( "z" ), 0 );
+
+        // Do calculation      
+        VALUE newX = rb_funcall( leftX, rb_intern( "/" ), 1, rightX );
+        VALUE newY = rb_funcall( leftY, rb_intern( "/" ), 1, rightY );
+        VALUE newZ = rb_funcall( leftZ, rb_intern( "/" ), 1, rightZ );
+        
+        return rb_funcall( globalVector3Class, rb_intern( "new" ), 2, newX, newY, newZ );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000021.html b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000021.html new file mode 100644 index 00000000..41820143 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/classes/SFML/Vector3.src/M000021.html @@ -0,0 +1,36 @@ + + + + + + == (SFML::Vector3) + + + + + 
/* */
+static VALUE Vector3_Equal( VALUE self, VALUE anArgument )
+{
+        VALUE aVector = Vector3_ForceType( anArgument );
+        VALUE leftX  = rb_funcall( self, rb_intern( "x" ), 0 );
+        VALUE leftY  = rb_funcall( self, rb_intern( "y" ), 0 );
+        VALUE leftZ  = rb_funcall( self, rb_intern( "z" ), 0 );
+        VALUE rightX = rb_funcall( aVector, rb_intern( "x" ), 0 );
+        VALUE rightY = rb_funcall( aVector, rb_intern( "y" ), 0 );
+        VALUE rightZ = rb_funcall( aVector, rb_intern( "z" ), 0 );
+        
+        if( rb_funcall( leftX, rb_intern( "==" ), 1, rightX ) == Qtrue &&
+            rb_funcall( leftY, rb_intern( "==" ), 1, rightY ) == Qtrue &&
+            rb_funcall( leftZ, rb_intern( "==" ), 1, rightZ ) == Qtrue )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/created.rid b/bindings/ruby/sfml-system/doc/created.rid new file mode 100644 index 00000000..d749879d --- /dev/null +++ b/bindings/ruby/sfml-system/doc/created.rid @@ -0,0 +1 @@ +Tue, 16 Nov 2010 17:24:00 +0100 diff --git a/bindings/ruby/sfml-system/doc/files/extconf_rb.html b/bindings/ruby/sfml-system/doc/files/extconf_rb.html new file mode 100644 index 00000000..3bbbe6bd --- /dev/null +++ b/bindings/ruby/sfml-system/doc/files/extconf_rb.html @@ -0,0 +1,137 @@ + + + + + + File: extconf.rb + + + + + + + + + + +
+

extconf.rb

+ + + + + + + + + +
Path:extconf.rb +
Last Update:Wed Nov 03 08:57:19 +0100 2010
+
+ + +
+ + + +
+ +
+

+rbSFML - Copyright (c) 2010 Henrik Valter Vogelius Hansson - +groogy@groogy.se This software is provided ‘as-is’, without any +express or implied warranty. In no event will the authors be held liable +for any damages arising from the use of this software. +

+

+Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: +

+
    +
  1. The origin of this software must not be misrepresented; you must not claim +that you wrote the original software. If you use this software in a +product, an acknowledgment in the product documentation would be +appreciated but is not required. + +
    2. +
  2. Altered source versions must be plainly marked as such, and must not be +misrepresented as being the original software. + +
    3. +
  3. This notice may not be removed or altered from any source distribution. + +
    4. +
+ +
+ +
+

Required files

+ +
+ mkmf   +
+
+ +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/files/system/Clock_cpp.html b/bindings/ruby/sfml-system/doc/files/system/Clock_cpp.html new file mode 100644 index 00000000..31e549e3 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/files/system/Clock_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Clock.cpp + + + + + + + + + + +
+

Clock.cpp

+ + + + + + + + + +
Path:system/Clock.cpp +
Last Update:Tue Nov 16 17:17:03 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/files/system/Vector2_cpp.html b/bindings/ruby/sfml-system/doc/files/system/Vector2_cpp.html new file mode 100644 index 00000000..27ea39d3 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/files/system/Vector2_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Vector2.cpp + + + + + + + + + + +
+

Vector2.cpp

+ + + + + + + + + +
Path:system/Vector2.cpp +
Last Update:Tue Nov 16 17:21:27 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/files/system/Vector3_cpp.html b/bindings/ruby/sfml-system/doc/files/system/Vector3_cpp.html new file mode 100644 index 00000000..fd164ad1 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/files/system/Vector3_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Vector3.cpp + + + + + + + + + + +
+

Vector3.cpp

+ + + + + + + + + +
Path:system/Vector3.cpp +
Last Update:Tue Nov 16 17:20:51 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/files/system/main_cpp.html b/bindings/ruby/sfml-system/doc/files/system/main_cpp.html new file mode 100644 index 00000000..a3e5bf4a --- /dev/null +++ b/bindings/ruby/sfml-system/doc/files/system/main_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: main.cpp + + + + + + + + + + +
+

main.cpp

+ + + + + + + + + +
Path:system/main.cpp +
Last Update:Tue Nov 16 17:08:37 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/fr_class_index.html b/bindings/ruby/sfml-system/doc/fr_class_index.html new file mode 100644 index 00000000..3a8b0a30 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/fr_class_index.html @@ -0,0 +1,30 @@ + + + + + + + + Classes + + + + + +
+

Classes

+ +
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/fr_file_index.html b/bindings/ruby/sfml-system/doc/fr_file_index.html new file mode 100644 index 00000000..0c0f79db --- /dev/null +++ b/bindings/ruby/sfml-system/doc/fr_file_index.html @@ -0,0 +1,31 @@ + + + + + + + + Files + + + + + +
+

Files

+ +
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/fr_method_index.html b/bindings/ruby/sfml-system/doc/fr_method_index.html new file mode 100644 index 00000000..7d6e4ad9 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/fr_method_index.html @@ -0,0 +1,47 @@ + + + + + + + + Methods + + + + + +
+

Methods

+ +
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/index.html b/bindings/ruby/sfml-system/doc/index.html new file mode 100644 index 00000000..51f7ff4c --- /dev/null +++ b/bindings/ruby/sfml-system/doc/index.html @@ -0,0 +1,24 @@ + + + + + + + RDoc Documentation + + + + + + + + + + + \ No newline at end of file diff --git a/bindings/ruby/sfml-system/doc/rdoc-style.css b/bindings/ruby/sfml-system/doc/rdoc-style.css new file mode 100644 index 00000000..44c7b3d1 --- /dev/null +++ b/bindings/ruby/sfml-system/doc/rdoc-style.css @@ -0,0 +1,208 @@ + +body { + font-family: Verdana,Arial,Helvetica,sans-serif; + font-size: 90%; + margin: 0; + margin-left: 40px; + padding: 0; + background: white; +} + +h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; } +h1 { font-size: 150%; } +h2,h3,h4 { margin-top: 1em; } + +a { background: #eef; color: #039; text-decoration: none; } +a:hover { background: #039; color: #eef; } + +/* Override the base stylesheet's Anchor inside a table cell */ +td > a { + background: transparent; + color: #039; + text-decoration: none; +} + +/* and inside a section title */ +.section-title > a { + background: transparent; + color: #eee; + text-decoration: none; +} + +/* === Structural elements =================================== */ + +div#index { + margin: 0; + margin-left: -40px; + padding: 0; + font-size: 90%; +} + + +div#index a { + margin-left: 0.7em; +} + +div#index .section-bar { + margin-left: 0px; + padding-left: 0.7em; + background: #ccc; + font-size: small; +} + + +div#classHeader, div#fileHeader { + width: auto; + color: white; + padding: 0.5em 1.5em 0.5em 1.5em; + margin: 0; + margin-left: -40px; + border-bottom: 3px solid #006; +} + +div#classHeader a, div#fileHeader a { + background: inherit; + color: white; +} + +div#classHeader td, div#fileHeader td { + background: inherit; + color: white; +} + + +div#fileHeader { + background: #057; +} + +div#classHeader { + background: #048; +} + + +.class-name-in-header { + font-size: 180%; + font-weight: bold; +} + + +div#bodyContent { + padding: 0 1.5em 0 1.5em; +} + +div#description { + padding: 0.5em 1.5em; + background: #efefef; + border: 1px dotted #999; +} + +div#description h1,h2,h3,h4,h5,h6 { + color: #125;; + background: transparent; +} + +div#validator-badges { + text-align: center; +} +div#validator-badges img { border: 0; } + +div#copyright { + color: #333; + background: #efefef; + font: 0.75em sans-serif; + margin-top: 5em; + margin-bottom: 0; + padding: 0.5em 2em; +} + + +/* === Classes =================================== */ + +table.header-table { + color: white; + font-size: small; +} + +.type-note { + font-size: small; + color: #DEDEDE; +} + +.xxsection-bar { + background: #eee; + color: #333; + padding: 3px; +} + +.section-bar { + color: #333; + border-bottom: 1px solid #999; + margin-left: -20px; +} + + +.section-title { + background: #79a; + color: #eee; + padding: 3px; + margin-top: 2em; + margin-left: -30px; + border: 1px solid #999; +} + +.top-aligned-row { vertical-align: top } +.bottom-aligned-row { vertical-align: bottom } + +/* --- Context section classes ----------------------- */ + +.context-row { } +.context-item-name { font-family: monospace; font-weight: bold; color: black; } +.context-item-value { font-size: small; color: #448; } +.context-item-desc { color: #333; padding-left: 2em; } + +/* --- Method classes -------------------------- */ +.method-detail { + background: #efefef; + padding: 0; + margin-top: 0.5em; + margin-bottom: 1em; + border: 1px dotted #ccc; +} +.method-heading { + color: black; + background: #ccc; + border-bottom: 1px solid #666; + padding: 0.2em 0.5em 0 0.5em; +} +.method-signature { color: black; background: inherit; } +.method-name { font-weight: bold; } +.method-args { font-style: italic; } +.method-description { padding: 0 0.5em 0 0.5em; } + +/* --- Source code sections -------------------- */ + +a.source-toggle { font-size: 90%; } +div.method-source-code { + background: #262626; + color: #ffdead; + margin: 1em; + padding: 0.5em; + border: 1px dashed #999; + overflow: hidden; +} + +div.method-source-code pre { color: #ffdead; overflow: hidden; } + +/* --- Ruby keyword styles --------------------- */ + +.standalone-code { background: #221111; color: #ffdead; overflow: hidden; } + +.ruby-constant { color: #7fffd4; background: transparent; } +.ruby-keyword { color: #00ffff; background: transparent; } +.ruby-ivar { color: #eedd82; background: transparent; } +.ruby-operator { color: #00ffee; background: transparent; } +.ruby-identifier { color: #ffdead; background: transparent; } +.ruby-node { color: #ffa07a; background: transparent; } +.ruby-comment { color: #b22222; font-weight: bold; background: transparent; } +.ruby-regexp { color: #ffa07a; background: transparent; } +.ruby-value { color: #7fffd4; background: transparent; } \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML.html b/bindings/ruby/sfml-window/doc/classes/SFML.html new file mode 100644 index 00000000..8208129e --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML.html @@ -0,0 +1,164 @@ + + + + + + Module: SFML + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSFML
In: + + window/main.cpp + +
+ + window/ContextSettings.cpp + +
+ + window/Event.cpp + +
+ + window/VideoMode.cpp + +
+ + window/Context.cpp + +
+ + window/Window.cpp + +
+ + window/Input.cpp + +
+
+
+ + +
+ + + +
+ +
+

+SFML namespace which contains the classes of this +module. +

+ +
+ + +
+ + +
+ + + + +
+ +
+

Classes and Modules

+ + Module SFML::Joy
+Module SFML::Key
+Module SFML::Mouse
+Module SFML::Style
+Class SFML::Context
+Class SFML::ContextSettings
+Class SFML::Event
+Class SFML::Input
+Class SFML::VideoMode
+Class SFML::Window
+ +
+ +
+

Constants

+ +
+ + + + + + +
WindowLoaded=Qtrue
+
+
+ + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Context.html b/bindings/ruby/sfml-window/doc/classes/SFML/Context.html new file mode 100644 index 00000000..69885d0f --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Context.html @@ -0,0 +1,236 @@ + + + + + + Class: SFML::Context + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Context
In: + + window/main.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+If you need to make OpenGL / graphics calls without having an active window +(like in a thread), you can use an instance of this class to get a valid +context. +

+

+Having a valid context is necessary for every OpenGL call, and for +most of the classes from the Graphics package. +

+

+Note that a context is only active in its current thread, if you create a +new thread it will have no valid context +by default. +

+

+To use a sf::Context instance, just construct it +and let it live as long as you need a valid context. No explicit activation +is needed, all it has to do is to exist. Its destructor will take care of +deactivating and freeing all the attached resources. +

+ +
+ + +
+ +
+

Methods

+ +
+ active=   + new   + setActive   + setReferenceActive   + set_active   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Class methods

+ +
+ + +
+ + Context.new() → context
+ + +
+ +
+

+The constructor creates and activates the context +

+
+
+ +
+ + +
+ + Context.SetReferenceActive() → true or false
+ + +
+ +
+

+This function is meant to be called internally; it is used to deactivate +the current context by activating another one (so that we still have an +active context on the current thread). +

+
+
+ +

Public Instance methods

+ +
+ + +
+ active=(p1) +
+ +
+

+Alias for setActive +

+
+
+ +
+ + +
+ + context.SetActive(bool) → nil
+ + +
+ +
+

+Activate or deactivate explicitely the context. +

+
+
+ +
+ + +
+ set_active(p1) +
+ +
+

+Alias for setActive +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000033.html b/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000033.html new file mode 100644 index 00000000..850ece14 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000033.html @@ -0,0 +1,26 @@ + + + + + + new (SFML::Context) + + + + + 
/* call-seq:
+ *   Context.new()              -> context
+ *
+ * The constructor creates and activates the context
+ */
+static VALUE Context_New( VALUE aKlass )
+{
+        sf::Context *object = new sf::Context();
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, Context_Free, object );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000034.html b/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000034.html new file mode 100644 index 00000000..727822cd --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000034.html @@ -0,0 +1,32 @@ + + + + + + setReferenceActive (SFML::Context) + + + + + 
/* call-seq:
+ *   Context.SetReferenceActive()       -> true or false
+ *
+ * This function is meant to be called internally; it is used to deactivate the 
+ * current context by activating another one (so that we still have an active 
+ * context on the current thread).
+ */
+static VALUE Context_SetReferenceActive( VALUE aKlass )
+{
+        if( sf::Context::SetReferenceActive() == true )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000035.html b/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000035.html new file mode 100644 index 00000000..95d8e31d --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Context.src/M000035.html @@ -0,0 +1,36 @@ + + + + + + setActive (SFML::Context) + + + + + 
/* call-seq:
+ *   context.SetActive(bool)    -> nil
+ *
+ * Activate or deactivate explicitely the context.
+ */
+static VALUE Context_SetActive( VALUE self, VALUE anArgument )
+{
+        sf::Context *object = NULL;
+        Data_Get_Struct( self, sf::Context, object );
+        switch( anArgument )
+        {
+                case Qtrue:
+                        object->SetActive( true );
+                        break;
+                case Qfalse:
+                        object->SetActive( false );
+                        break;
+                default:
+                        rb_raise( rb_eTypeError, "expected true or false" );
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.html new file mode 100644 index 00000000..a121188b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.html @@ -0,0 +1,670 @@ + + + + + + Class: SFML::ContextSettings + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::ContextSettings
In: + + window/main.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+ContextSettings allows to define several +advanced settings of the OpenGL context attached to a window. +

+

+All these settings have no impact on the regular SFML rendering (graphics module) — except the +anti-aliasing level, so you may need to use this structure only if +you‘re using SFML as a windowing system +for custom OpenGL rendering. +

+

+The DepthBits and StencilBits members define the number of bits per pixel +requested for the (respectively) depth and stencil buffers. +

+

+AntialiasingLevel represents the requested number of multisampling levels +for anti-aliasing. +

+

+MajorVersion and MinorVersion define the version of the OpenGL context that +you want. Only versions greater or equal to 3.0 are relevant; versions +lesser than 3.0 are all handled the same way (i.e. you can use any version +< 3.0 if you don‘t want an OpenGL 3 context). +

+

+Please note that these values are only a hint. No failure will be reported +if one or more of these values are not supported by the system; instead, SFML will try to find the closest valid match. You +can then retrieve the settings that the window actually used to create its +context, with Window::GetSettings(). +

+ +
+ + +
+ +
+

Methods

+ +
+ antialiasing   + antialiasing=   + antialiasingLevel   + antialiasingLevel=   + antialiasing_level   + antialiasing_level=   + depth   + depth=   + depthBits   + depthBits=   + depth_bits   + depth_bits=   + major   + major=   + majorVersion   + majorVersion=   + major_version   + major_version=   + minor   + minor=   + minorVersion   + minorVersion=   + minor_version   + minor_version=   + new   + stencil   + stencil=   + stencilBits   + stencilBits=   + stencil_bits   + stencil_bits=   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Class methods

+ + + +

Public Instance methods

+ +
+ + +
+ antialiasing() +
+ +
+

+Alias for antialiasingLevel +

+
+
+ +
+ + +
+ antialiasing=(p1) +
+ +
+

+Alias for antialiasingLevel= +

+
+
+ + + + + +
+ + +
+ antialiasing_level() +
+ +
+

+Alias for antialiasingLevel +

+
+
+ +
+ + +
+ antialiasing_level=(p1) +
+ +
+

+Alias for antialiasingLevel= +

+
+
+ +
+ + +
+ depth() +
+ +
+

+Alias for depthBits +

+
+
+ +
+ + +
+ depth=(p1) +
+ +
+

+Alias for depthBits= +

+
+
+ +
+ + +
+ + settings.depthBits → depth
+ + +
+ +
+

+Bits of the depth buffer +

+
+
+ +
+ + +
+ + settings.depthBits=(new_depth) → new_depth
+ + +
+ +
+

+Bits of the depth buffer +

+
+
+ +
+ + +
+ depth_bits() +
+ +
+

+Alias for depthBits +

+
+
+ +
+ + +
+ depth_bits=(p1) +
+ +
+

+Alias for depthBits= +

+
+
+ +
+ + +
+ major() +
+ +
+

+Alias for majorVersion +

+
+
+ +
+ + +
+ major=(p1) +
+ +
+

+Alias for majorVersion= +

+
+
+ +
+ + +
+ + settings.majorVersion → major
+ + +
+ +
+

+Major number of the context version to create +

+
+
+ +
+ + +
+ + settings.majorVersion=(new_major) → new_major
+ + +
+ +
+

+Major number of the context version to create +

+
+
+ +
+ + +
+ major_version() +
+ +
+

+Alias for majorVersion +

+
+
+ +
+ + +
+ major_version=(p1) +
+ +
+

+Alias for majorVersion= +

+
+
+ +
+ + +
+ minor() +
+ +
+

+Alias for minorVersion +

+
+
+ +
+ + +
+ minor=(p1) +
+ +
+

+Alias for minorVersion= +

+
+
+ +
+ + +
+ + settings.minorVersion → minor
+ + +
+ +
+

+Minor number of the context version to create +

+
+
+ +
+ + +
+ + settings.minorVersion=(new_minor) → new_minor
+ + +
+ +
+

+Minor number of the context version to create +

+
+
+ +
+ + +
+ minor_version() +
+ +
+

+Alias for minorVersion +

+
+
+ +
+ + +
+ minor_version=(p1) +
+ +
+

+Alias for minorVersion= +

+
+
+ +
+ + +
+ stencil() +
+ +
+

+Alias for stencilBits +

+
+
+ +
+ + +
+ stencil=(p1) +
+ +
+

+Alias for stencilBits= +

+
+
+ +
+ + +
+ + settings.stencilBits → stencil
+ + +
+ +
+

+Bits of the stencil buffer +

+
+
+ + + +
+ + +
+ stencil_bits() +
+ +
+

+Alias for stencilBits +

+
+
+ +
+ + +
+ stencil_bits=(p1) +
+ +
+

+Alias for stencilBits= +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000113.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000113.html new file mode 100644 index 00000000..def87c31 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000113.html @@ -0,0 +1,73 @@ + + + + + + new (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   ContextSettings.new( depth = 24, stencil = 8, antialiasing = 0, major = 2, minor = 0)      -> settings
+ *
+ * The constructor creates the settings
+ */
+static VALUE ContextSettings_New( VALUE aKlass, VALUE someArgs )
+{
+        long arrayLength = RARRAY_LEN( someArgs );     
+        sf::ContextSettings *object = NULL;
+        if( arrayLength == 0 )
+        {
+                object = new sf::ContextSettings();
+        }
+        else if( arrayLength == 1 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                object = new sf::ContextSettings( NUM2UINT( arg1 ) );
+        }
+        else if( arrayLength == 2 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                VALUE arg2 = rb_ary_entry( someArgs, 1 );
+                object = new sf::ContextSettings( NUM2UINT( arg1 ), NUM2UINT( arg2 ) );
+        }
+        
+        else if( arrayLength == 3 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                VALUE arg2 = rb_ary_entry( someArgs, 1 );
+                VALUE arg3 = rb_ary_entry( someArgs, 2 );
+                object = new sf::ContextSettings( NUM2UINT( arg1 ), NUM2UINT( arg2 ), NUM2UINT( arg3 ) );
+        }
+        else if( arrayLength == 4 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                VALUE arg2 = rb_ary_entry( someArgs, 1 );
+                VALUE arg3 = rb_ary_entry( someArgs, 2 );
+                VALUE arg4 = rb_ary_entry( someArgs, 3 );
+                object = new sf::ContextSettings( NUM2UINT( arg1 ), NUM2UINT( arg2 ), NUM2UINT( arg3 ), NUM2UINT( arg4 ) );
+        }
+        else if( arrayLength == 5 )
+        {
+                VALUE arg1 = rb_ary_entry( someArgs, 0 );
+                VALUE arg2 = rb_ary_entry( someArgs, 1 );
+                VALUE arg3 = rb_ary_entry( someArgs, 2 );
+                VALUE arg4 = rb_ary_entry( someArgs, 3 );
+                VALUE arg5 = rb_ary_entry( someArgs, 4 );
+                object = new sf::ContextSettings( NUM2UINT( arg1 ), NUM2UINT( arg2 ), NUM2UINT( arg3 ), NUM2UINT( arg4 ), NUM2UINT( arg5 ) );
+        }
+        else
+        {
+                rb_raise( rb_eArgError, "Expected 0..5 arguments but was given %ld", arrayLength );
+                return Qnil;
+        }
+         
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, ContextSettings_Free, object );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000114.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000114.html new file mode 100644 index 00000000..76e81ddf --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000114.html @@ -0,0 +1,25 @@ + + + + + + depthBits (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.depthBits -> depth
+ *
+ * Bits of the depth buffer
+ */
+static VALUE ContextSettings_GetDepth( VALUE self )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->DepthBits );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000115.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000115.html new file mode 100644 index 00000000..019d06fe --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000115.html @@ -0,0 +1,25 @@ + + + + + + depthBits= (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.depthBits=(new_depth)     -> new_depth
+ *
+ * Bits of the depth buffer
+ */
+static VALUE ContextSettings_SetDepth( VALUE self, VALUE aValue )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->DepthBits = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000116.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000116.html new file mode 100644 index 00000000..e0ba4e50 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000116.html @@ -0,0 +1,25 @@ + + + + + + stencilBits (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.stencilBits       -> stencil
+ *
+ * Bits of the stencil buffer
+ */
+static VALUE ContextSettings_GetStencil( VALUE self )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->StencilBits );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000117.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000117.html new file mode 100644 index 00000000..c23a479d --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000117.html @@ -0,0 +1,25 @@ + + + + + + stencilBits= (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.stencilBits=(new_stencil) -> new_stencil
+ *
+ * Bits of the stencil buffer
+ */
+static VALUE ContextSettings_SetStencil( VALUE self, VALUE aValue )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->StencilBits = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000118.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000118.html new file mode 100644 index 00000000..2adf7a1c --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000118.html @@ -0,0 +1,25 @@ + + + + + + antialiasingLevel (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.antialiasingLevel -> antialiasing
+ *
+ * Level of antialiasing
+ */
+static VALUE ContextSettings_GetAntialiasing( VALUE self )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->AntialiasingLevel );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000119.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000119.html new file mode 100644 index 00000000..0fcc5e8a --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000119.html @@ -0,0 +1,25 @@ + + + + + + antialiasingLevel= (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.antialiasingLevel=(new_antialiasing)      -> new_antialiasing
+ *
+ * Level of antialiasing
+ */
+static VALUE ContextSettings_SetAntialiasing( VALUE self, VALUE aValue )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->AntialiasingLevel = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000120.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000120.html new file mode 100644 index 00000000..5587949a --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000120.html @@ -0,0 +1,25 @@ + + + + + + majorVersion (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.majorVersion      -> major
+ *
+ * Major number of the context version to create
+ */
+static VALUE ContextSettings_GetMajorVersion( VALUE self )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->MajorVersion );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000121.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000121.html new file mode 100644 index 00000000..4eba16e2 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000121.html @@ -0,0 +1,25 @@ + + + + + + majorVersion= (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.majorVersion=(new_major)  -> new_major
+ *
+ * Major number of the context version to create
+ */
+static VALUE ContextSettings_SetMajorVersion( VALUE self, VALUE aValue )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->MajorVersion = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000122.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000122.html new file mode 100644 index 00000000..762342ac --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000122.html @@ -0,0 +1,25 @@ + + + + + + minorVersion (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.minorVersion      -> minor
+ *
+ * Minor number of the context version to create
+ */
+static VALUE ContextSettings_GetMinorVersion( VALUE self )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->MinorVersion );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000123.html b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000123.html new file mode 100644 index 00000000..ef9e2625 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/ContextSettings.src/M000123.html @@ -0,0 +1,25 @@ + + + + + + minorVersion= (SFML::ContextSettings) + + + + + 
/* call-seq:
+ *   settings.minorVersion=(new_minor)  -> new_minor
+ *
+ * Minor number of the context version to create
+ */
+static VALUE ContextSettings_SetMinorVersion( VALUE self, VALUE aValue )
+{
+        sf::ContextSettings *object = NULL;
+        Data_Get_Struct( self, sf::ContextSettings, object );
+        return INT2FIX( object->MinorVersion = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event.html new file mode 100644 index 00000000..3f536f96 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event.html @@ -0,0 +1,371 @@ + + + + + + Class: SFML::Event + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event
In: + + window/main.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ new   + new   +
+
+ +
+ + + + +
+ + + +
+

Constants

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Closed=INT2NUM( sf::Event::Closed )
Resized=INT2NUM( sf::Event::Resized )
LostFocus=INT2NUM( sf::Event::LostFocus )
GainedFocus=INT2NUM( sf::Event::GainedFocus )
TextEntered=INT2NUM( sf::Event::TextEntered )
KeyPressed=INT2NUM( sf::Event::KeyPressed )
KeyReleased=INT2NUM( sf::Event::KeyReleased )
MouseWheelMoved=INT2NUM( sf::Event::MouseWheelMoved )
MouseButtonPressed=INT2NUM( sf::Event::MouseButtonPressed )
MouseButtonReleased=INT2NUM( sf::Event::MouseButtonReleased )
MouseMoved=INT2NUM( sf::Event::MouseMoved )
MouseEntered=INT2NUM( sf::Event::MouseEntered )
MouseLeft=INT2NUM( sf::Event::MouseLeft )
JoyButtonPressed=INT2NUM( sf::Event::JoyButtonPressed )
JoyButtonReleased=INT2NUM( sf::Event::JoyButtonReleased )
JoyMoved=INT2NUM( sf::Event::JoyMoved )
Count=INT2NUM( sf::Event::Count )
+
+
+ + + +
+

Attributes

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
joyButton [R] 
joyMove [R] 
key [R] 
mouseButton [R] 
mouseMove [R] 
mouseWheel [R] 
size [R] 
text [R] 
type [R] 
+
+
+ + + + +
+

Public Class methods

+ +
+ + +
+ + Event.new(type) → event
+ + +
+ +
+

+You should never call this function directly. You should only aquire +event‘s trough SFML::Window#getEvent or SFML::Window#waitEvent, if you need to pass +data to a method that takes an event instance then make a proxy instance to +simulate an event. NOTE: Using this method works but it will act constant +as you can‘t access any values. +

+
+
+ +
+ + +
+ + new(p1) + +
+ +
+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000091.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000091.html new file mode 100644 index 00000000..f5bcdddf --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000091.html @@ -0,0 +1,29 @@ + + + + + + new (SFML::Event) + + + + + 
/* call-seq:
+ *   Event.new(type)    -> event
+ *
+ * You should never call this function directly. You should only aquire event's trough
+ * SFML::Window#getEvent or SFML::Window#waitEvent, if you need to pass data to a method
+ * that takes an event instance then make a proxy instance to simulate an event.
+ * NOTE: Using this method works but it will act constant as you can't access any values.
+ */
+static VALUE Event_New( int argc, VALUE * args, VALUE aKlass )
+{
+        sf::Event *object = new sf::Event();
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, Event_Free, object );
+        rb_obj_call_init( rbData, argc, args );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000092.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000092.html new file mode 100644 index 00000000..8f1f9847 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event.src/M000092.html @@ -0,0 +1,82 @@ + + + + + + new (SFML::Event) + + + + + 
/* */
+static VALUE Event_Initialize( VALUE self, VALUE aType )
+{
+        sf::Event * object = NULL;
+        Data_Get_Struct( self, sf::Event, object );
+        
+        int typeNum = FIX2INT( aType );
+        if(typeNum >= 0 && typeNum < sf::Event::Count)
+        {
+                rb_iv_set( self, "@type", aType );
+                object->Type = static_cast< sf::Event::EventType >( typeNum );
+        }
+        else
+        {
+                rb_raise( rb_eTypeError, "expected Fixnum in range of 0...SFML::Event::Count" );
+        }
+        
+        bool noSpecialType = false;
+        VALUE eventType;
+        const char * name = NULL;
+        switch( object->Type )
+        {
+                case sf::Event::JoyButtonPressed:
+                case sf::Event::JoyButtonReleased:
+                        eventType = Data_Wrap_Struct( globalJoyButtonEventClass, 0, 0, &object->JoyButton );
+                        name = "@joyButton";
+                        break;
+                case sf::Event::JoyMoved:
+                        eventType = Data_Wrap_Struct( globalJoyMoveEventClass, 0, 0, &object->JoyMove );
+                        name = "@joyMove";
+                        break;
+                case sf::Event::KeyPressed:
+                case sf::Event::KeyReleased:
+                        eventType = Data_Wrap_Struct( globalKeyEventClass, 0, 0, &object->Key );
+                        name = "@key";
+                        break;
+                case sf::Event::MouseButtonPressed:
+                case sf::Event::MouseButtonReleased:
+                        eventType = Data_Wrap_Struct( globalMouseButtonEventClass, 0, 0, &object->MouseButton );
+                        name = "@mouseButton";
+                        break;
+                case sf::Event::MouseMoved:
+                        eventType = Data_Wrap_Struct( globalMouseMoveEventClass, 0, 0, &object->MouseMove );
+                        name = "@mouseMove";
+                        break;
+                case sf::Event::MouseWheelMoved:
+                        eventType = Data_Wrap_Struct( globalMouseWheelEventClass, 0, 0, &object->MouseWheel );
+                        name = "@mouseWheel";
+                        break;
+                case sf::Event::Resized:
+                        eventType = Data_Wrap_Struct( globalSizeEventClass, 0, 0, &object->Size );
+                        name = "@resized";
+                        break;
+                case sf::Event::TextEntered:
+                        eventType = Data_Wrap_Struct( globalTextEventClass, 0, 0, &object->Text );
+                        name = "@text";
+                        break;
+                default:
+                        noSpecialType = true;
+        };
+        
+        if( noSpecialType == false )
+        {
+                rb_obj_call_init( eventType, 0, 0 );
+                rb_iv_set( eventType, "@internal__parent_ref", self );
+                rb_iv_set( self, name, eventType );
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.html new file mode 100644 index 00000000..9db89cc0 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.html @@ -0,0 +1,209 @@ + + + + + + Class: SFML::Event::JoyButton + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::JoyButton
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ button   + joystickId   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + button() + +
+ +
+

+Index of the button that has been +pressed. +

+
+
+ +
+ + +
+ + joystickId() + +
+ +
+

+Index of the joystick (0 or 1). +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000104.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000104.html new file mode 100644 index 00000000..711cc8a0 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000104.html @@ -0,0 +1,17 @@ + + + + + + joystickId (SFML::Event::JoyButton) + + + + + 
/* Index of the joystick (0 or 1). */
+static VALUE JoyButtonEvent_GetJoystickId( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000105.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000105.html new file mode 100644 index 00000000..42b26522 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyButton.src/M000105.html @@ -0,0 +1,17 @@ + + + + + + button (SFML::Event::JoyButton) + + + + + 
/* Index of the button that has been pressed. */
+static VALUE JoyButtonEvent_GetButton( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.html new file mode 100644 index 00000000..739b40f1 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.html @@ -0,0 +1,227 @@ + + + + + + Class: SFML::Event::JoyMove + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::JoyMove
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ axis   + joystickId   + position   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + axis() + +
+ +
+

+Axis on which the joystick moved. +

+
+
+ +
+ + +
+ + joystickId() + +
+ +
+

+Index of the joystick (0 or 1). +

+
+
+ +
+ + +
+ + position() + +
+ +
+

+New position on the axis (in range [-100, 100]). +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000110.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000110.html new file mode 100644 index 00000000..4967680b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000110.html @@ -0,0 +1,17 @@ + + + + + + joystickId (SFML::Event::JoyMove) + + + + + 
/* Index of the joystick (0 or 1). */
+static VALUE JoyMoveEvent_GetJoystickId( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000111.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000111.html new file mode 100644 index 00000000..274a088c --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000111.html @@ -0,0 +1,17 @@ + + + + + + axis (SFML::Event::JoyMove) + + + + + 
/* Axis on which the joystick moved. */
+static VALUE JoyMoveEvent_GetAxis( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000112.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000112.html new file mode 100644 index 00000000..7b7fd2ae --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/JoyMove.src/M000112.html @@ -0,0 +1,17 @@ + + + + + + position (SFML::Event::JoyMove) + + + + + 
/* New position on the axis (in range [-100, 100]). */
+static VALUE JoyMoveEvent_GetPosition( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.html new file mode 100644 index 00000000..449e9fae --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.html @@ -0,0 +1,244 @@ + + + + + + Class: SFML::Event::Key + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::Key
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ alt   + code   + control   + shift   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + alt() + +
+ +
+

+Is the Alt key pressed? +

+
+
+ +
+ + +
+ + code() + +
+ +
+

+Code of the key that has been pressed. +

+
+
+ +
+ + +
+ + control() + +
+ +
+

+Is the Control key pressed? +

+
+
+ +
+ + +
+ + shift() + +
+ +
+

+Is the Shift key pressed? +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000106.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000106.html new file mode 100644 index 00000000..49b4edb3 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000106.html @@ -0,0 +1,17 @@ + + + + + + code (SFML::Event::Key) + + + + + 
/* Code of the key that has been pressed. */
+static VALUE KeyEvent_GetCode( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000107.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000107.html new file mode 100644 index 00000000..7210f1d3 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000107.html @@ -0,0 +1,17 @@ + + + + + + alt (SFML::Event::Key) + + + + + 
/* Is the Alt key pressed? */
+static VALUE KeyEvent_GetAlt( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000108.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000108.html new file mode 100644 index 00000000..5ecee0a0 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000108.html @@ -0,0 +1,17 @@ + + + + + + control (SFML::Event::Key) + + + + + 
/* Is the Control key pressed? */
+static VALUE KeyEvent_GetControl( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000109.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000109.html new file mode 100644 index 00000000..540f1c33 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Key.src/M000109.html @@ -0,0 +1,17 @@ + + + + + + shift (SFML::Event::Key) + + + + + 
/* Is the Shift key pressed? */
+static VALUE KeyEvent_GetShift( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.html new file mode 100644 index 00000000..ed1c1032 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.html @@ -0,0 +1,227 @@ + + + + + + Class: SFML::Event::MouseButton + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::MouseButton
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ button   + x   + y   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + button() + +
+ +
+

+Code of the button that has been +pressed. +

+
+
+ +
+ + +
+ + x() + +
+ +
+

+X position of the mouse pointer, relative to the left of the owner window +

+
+
+ +
+ + +
+ + y() + +
+ +
+

+Y position of the mouse pointer, relative to the top of the owner window +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000095.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000095.html new file mode 100644 index 00000000..5990d834 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000095.html @@ -0,0 +1,17 @@ + + + + + + button (SFML::Event::MouseButton) + + + + + 
/* Code of the button that has been pressed. */
+static VALUE MouseButtonEvent_GetButton( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000096.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000096.html new file mode 100644 index 00000000..d53fe893 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000096.html @@ -0,0 +1,17 @@ + + + + + + x (SFML::Event::MouseButton) + + + + + 
/* X position of the mouse pointer, relative to the left of the owner window */
+static VALUE MouseButtonEvent_GetX( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000097.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000097.html new file mode 100644 index 00000000..6748f47d --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseButton.src/M000097.html @@ -0,0 +1,17 @@ + + + + + + y (SFML::Event::MouseButton) + + + + + 
/* Y position of the mouse pointer, relative to the top of the owner window */
+static VALUE MouseButtonEvent_GetY( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.html new file mode 100644 index 00000000..48b0f109 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.html @@ -0,0 +1,208 @@ + + + + + + Class: SFML::Event::MouseMove + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::MouseMove
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ x   + y   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + x() + +
+ +
+

+X position of the mouse pointer, relative to the left of the owner window +

+
+
+ +
+ + +
+ + y() + +
+ +
+

+Y position of the mouse pointer, relative to the top of the owner window +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000093.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000093.html new file mode 100644 index 00000000..26b535de --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000093.html @@ -0,0 +1,17 @@ + + + + + + x (SFML::Event::MouseMove) + + + + + 
/* X position of the mouse pointer, relative to the left of the owner window */
+static VALUE MouseMoveEvent_GetX( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000094.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000094.html new file mode 100644 index 00000000..a0421e4e --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseMove.src/M000094.html @@ -0,0 +1,17 @@ + + + + + + y (SFML::Event::MouseMove) + + + + + 
/* Y position of the mouse pointer, relative to the top of the owner window */
+static VALUE MouseMoveEvent_GetY( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.html new file mode 100644 index 00000000..baa644be --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.html @@ -0,0 +1,226 @@ + + + + + + Class: SFML::Event::MouseWheel + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::MouseWheel
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ delta   + x   + y   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + delta() + +
+ +
+

+Number of ticks the wheel has moved (positive is up, negative is down). +

+
+
+ +
+ + +
+ + x() + +
+ +
+

+X position of the mouse pointer, relative to the left of the owner window +

+
+
+ +
+ + +
+ + y() + +
+ +
+

+Y position of the mouse pointer, relative to the top of the owner window +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000098.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000098.html new file mode 100644 index 00000000..9e1e28ce --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000098.html @@ -0,0 +1,17 @@ + + + + + + delta (SFML::Event::MouseWheel) + + + + + 
/* Number of ticks the wheel has moved (positive is up, negative is down). */
+static VALUE MouseWheelEvent_GetDelta( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000099.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000099.html new file mode 100644 index 00000000..eac147af --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000099.html @@ -0,0 +1,17 @@ + + + + + + x (SFML::Event::MouseWheel) + + + + + 
/* X position of the mouse pointer, relative to the left of the owner window */
+static VALUE MouseWheelEvent_GetX( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000100.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000100.html new file mode 100644 index 00000000..266eaed4 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.src/M000100.html @@ -0,0 +1,17 @@ + + + + + + y (SFML::Event::MouseWheel) + + + + + 
/* Y position of the mouse pointer, relative to the top of the owner window */
+static VALUE MouseWheelEvent_GetY( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.html new file mode 100644 index 00000000..f9a6a189 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.html @@ -0,0 +1,208 @@ + + + + + + Class: SFML::Event::Size + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::Size
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ height   + width   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + height() + +
+ +
+

+New width, in pixels. +

+
+
+ +
+ + +
+ + width() + +
+ +
+

+New width, in pixels. +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000101.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000101.html new file mode 100644 index 00000000..1a0669d2 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000101.html @@ -0,0 +1,17 @@ + + + + + + width (SFML::Event::Size) + + + + + 
/* New width, in pixels. */
+static VALUE SizeEvent_GetWidth( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000102.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000102.html new file mode 100644 index 00000000..f26a7fc8 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Size.src/M000102.html @@ -0,0 +1,17 @@ + + + + + + height (SFML::Event::Size) + + + + + 
/* New width, in pixels. */
+static VALUE SizeEvent_GetWidth( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.html new file mode 100644 index 00000000..a52063ae --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.html @@ -0,0 +1,190 @@ + + + + + + Class: SFML::Event::Text + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Event::Text
In: + + window/Event.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Event holds all the informations about a +system event that just happened. +

+

+Events are retrieved using the SFML::Window#GetEvent function. +

+

+A SFML::Event instance contains the type of the +event (mouse moved, key pressed, window closed, …) as well as the +details about this particular event. Please note that the event parameters +are defined in a union, which means that only the member matching the type +of the event will be properly filled; all other members will have undefined +values and must not be read if the type of the event doesn‘t match. +For example, if you received a KeyPressed event, then you must read the +event.Key +

+
+ member, all other members such as event.MouseMove or event.Text will have undefined values.
+
+

+The ruby version differs from C++ in that the parameters are still stored +in a union but that the values can be directly accessed from the event +object. If you try to access any data which would be considered undefined +then SFML::SomeKindOfException will be thrown. +

+

+Usage example: +

+
+ while event = window.getEvent()
+
+    # Request for closing the window
+    if event.type == SFML::Event::Closed
+      window.close
+
+    # The escape key was pressed
+    if ( event.type == sf::Event::KeyPressed ) && ( event.code == SFML::Key::Escape )
+      window.close
+
+    # The window was resized
+    if event.type == SFML::Event::Resized
+      DoSomethingWithTheNewSize(event.size);
+
+    # etc ...
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ unicode   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + unicode() + +
+ +
+

+UTF-32 unicode value of the character. +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.src/M000103.html b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.src/M000103.html new file mode 100644 index 00000000..4b678daa --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Event/Text.src/M000103.html @@ -0,0 +1,17 @@ + + + + + + unicode (SFML::Event::Text) + + + + + 
/* UTF-32 unicode value of the character. */
+static VALUE TextEvent_GetUnicode( VALUE self )
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.html new file mode 100644 index 00000000..ef497ae9 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.html @@ -0,0 +1,484 @@ + + + + + + Class: SFML::Input + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Input
In: + + window/main.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+The SFML::Input class provides a way to access the +state of keys, mouse buttons, mouse position, joystick buttons and jostick +axis. +

+

+SFML::Input provides the same informations as the +event system, but these informations can be accessed at any time, which is +more convenient in many situations. +

+

+For example, to move an entity you can decide to catch the +SFML::Event::KeyPressed event on arrow keys. But if you do so, you will +only receive one event when the key gets pressed (or repeated events if you +activated this feature), thus the entity will not move smoothly. The best +solution here is to use SFML::Input#isKeyDown so that you can update +your entity‘s position at every iteration of your game loop, not only +when you catch a KeyPressed event. +

+

+Note that instances of SFML::Input cannot be +created directly, they must be retrieved from a window (SFML::Window) with the SFML::Window#input method. +

+

+Usage example: +

+
+  # Retrieve the input object attached to our window
+  input = window.input
+
+  # Move an entity according to the current keys state
+  offset = 5.0 * window.frameTime # 5 pixels/sec
+  entity.move( -offset, 0 ) if input.keyDown?( SFML::Key::Left )
+  entity.move( offset, 0 )  if input.keyDown?( SFML::Key::Right )
+  entity.move( 0, -offset ) if input.keyDown?( SFML::Key::Up )
+  entity.move( 0,  offset ) if input.keyDown?( SFML::Key::Down )
+
+ +
+ + +
+ +
+

Methods

+ +
+ getJoystickAxis   + getMouseX   + getMouseY   + isJoystickButtonDown   + isKeyDown   + isMouseButtonDown   + joystickAxis   + joystickButtonDown?   + joystick_axis   + joystick_button_down?   + keyDown?   + key_down?   + mouseButtonDown?   + mouseX   + mouseY   + mouse_button_down?   + mouse_x   + mouse_y   + new   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Class methods

+ +
+ + +
+ + Input.new() → input
+ + +
+ +
+

+This will create a new input object. +though it will not receive any updates of events. You should aquire an +input object from the SFML::Window#input +method. +

+
+
+ +

Public Instance methods

+ +
+ + +
+ + input.getJoystickAxis( joystick, axis ) → true or false
+ + +
+ +
+

+The returned position is in the range [-100, 100], except the POV which is +an angle and is thus defined in [0, 360]. +

+
+
+ +
+ + +
+ + input.getMouseX() → fixnum
+ + +
+ +
+

+The returned position is relative to the left border of the owner window. +

+
+
+ +
+ + +
+ + input.getMouseY() → fixnum
+ + +
+ +
+

+The returned position is relative to the top border of the owner window. +

+
+
+ +
+ + +
+ + input.isJoystickButtonDown( joystick, button ) → true or false
+ + +
+ +
+

+Get the current state of a joystick button (pressed or released). +

+
+
+ +
+ + +
+ + input.isKeyDown( keycode ) → true or false
+ + +
+ +
+

+Get the current state of a key (pressed or released). +

+
+
+ +
+ + +
+ + input.isMouseButtonDown( keycode ) → true or false
+ + +
+ +
+

+Get the current state of a mouse button (pressed or released). +

+
+
+ +
+ + +
+ joystickAxis(p1, p2) +
+ +
+

+Alias for getJoystickAxis +

+
+
+ +
+ + +
+ joystickButtonDown?(p1, p2) +
+ +
+

+Alias for isJoystickButtonDown +

+
+
+ +
+ + +
+ joystick_axis(p1, p2) +
+ +
+

+Alias for getJoystickAxis +

+
+
+ +
+ + +
+ joystick_button_down?(p1, p2) +
+ +
+

+Alias for isJoystickButtonDown +

+
+
+ +
+ + +
+ keyDown?(p1) +
+ +
+

+Alias for isKeyDown +

+
+
+ +
+ + +
+ key_down?(p1) +
+ +
+

+Alias for isKeyDown +

+
+
+ +
+ + +
+ mouseButtonDown?(p1) +
+ +
+

+Alias for isMouseButtonDown +

+
+
+ +
+ + +
+ mouseX() +
+ +
+

+Alias for getMouseX +

+
+
+ +
+ + +
+ mouseY() +
+ +
+

+Alias for getMouseY +

+
+
+ +
+ + +
+ mouse_button_down?(p1) +
+ +
+

+Alias for isMouseButtonDown +

+
+
+ +
+ + +
+ mouse_x() +
+ +
+

+Alias for getMouseX +

+
+
+ +
+ + +
+ mouse_y() +
+ +
+

+Alias for getMouseY +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000001.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000001.html new file mode 100644 index 00000000..e97aad56 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000001.html @@ -0,0 +1,27 @@ + + + + + + new (SFML::Input) + + + + + 
/* call-seq:
+ *   Input.new()        -> input
+ *
+ * This will create a new input object. though it will not receive any updates of events.
+ * You should aquire an input object from the SFML::Window#input method.
+ */
+static VALUE Input_New( int argc, VALUE * args, VALUE aKlass )
+{
+        sf::Input *object = new sf::Input();
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, Input_Free, object );
+        rb_obj_call_init( rbData, argc, args );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000002.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000002.html new file mode 100644 index 00000000..df89b801 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000002.html @@ -0,0 +1,33 @@ + + + + + + isKeyDown (SFML::Input) + + + + + 
/* call-seq:
+ *   input.isKeyDown( keycode ) -> true or false
+ *
+ * Get the current state of a key (pressed or released).
+ */
+static VALUE Input_IsKeyDown( VALUE self, VALUE aKeyCode )
+{
+        sf::Input *object = NULL;
+        Data_Get_Struct( self, sf::Input, object );
+        sf::Key::Code rawCode = static_cast< sf::Key::Code > ( NUM2INT( aKeyCode ) );
+        if( object->IsKeyDown( rawCode ) == true )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000003.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000003.html new file mode 100644 index 00000000..81989155 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000003.html @@ -0,0 +1,33 @@ + + + + + + isMouseButtonDown (SFML::Input) + + + + + 
/* call-seq:
+ *   input.isMouseButtonDown( keycode ) -> true or false
+ *
+ * Get the current state of a mouse button (pressed or released).
+ */
+static VALUE Input_IsMouseButtonDown( VALUE self, VALUE aMouseButton )
+{
+        sf::Input *object = NULL;
+        Data_Get_Struct( self, sf::Input, object );
+        sf::Mouse::Button rawButton = static_cast< sf::Mouse::Button > ( NUM2INT( aMouseButton ) );
+        if( object->IsMouseButtonDown( rawButton ) == true )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000004.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000004.html new file mode 100644 index 00000000..9616de3e --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000004.html @@ -0,0 +1,34 @@ + + + + + + isJoystickButtonDown (SFML::Input) + + + + + 
/* call-seq:
+ *   input.isJoystickButtonDown( joystick, button )     -> true or false
+ *
+ * Get the current state of a joystick button (pressed or released).
+ */
+static VALUE Input_IsJoystickButtonDown( VALUE self, VALUE aJoystick, VALUE aButton )
+{
+        sf::Input *object = NULL;
+        Data_Get_Struct( self, sf::Input, object );
+        unsigned int rawJoystick =  NUM2UINT( aJoystick );
+        unsigned int rawButton =  NUM2UINT( aButton );
+        if( object->IsJoystickButtonDown( aJoystick, rawButton ) == true )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000005.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000005.html new file mode 100644 index 00000000..ffa161dd --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000005.html @@ -0,0 +1,25 @@ + + + + + + getMouseX (SFML::Input) + + + + + 
/* call-seq:
+ *   input.getMouseX()  -> fixnum
+ *
+ * The returned position is relative to the left border of the owner window.
+ */
+static VALUE Input_GetMouseX( VALUE self, VALUE aMouseButton )
+{
+        sf::Input *object = NULL;
+        Data_Get_Struct( self, sf::Input, object );
+        return INT2FIX( object->GetMouseX() );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000006.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000006.html new file mode 100644 index 00000000..7833c82a --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000006.html @@ -0,0 +1,25 @@ + + + + + + getMouseY (SFML::Input) + + + + + 
/* call-seq:
+ *   input.getMouseY()  -> fixnum
+ *
+ * The returned position is relative to the top border of the owner window.
+ */
+static VALUE Input_GetMouseY( VALUE self, VALUE aMouseButton )
+{
+        sf::Input *object = NULL;
+        Data_Get_Struct( self, sf::Input, object );
+        return INT2FIX( object->GetMouseY() );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000007.html b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000007.html new file mode 100644 index 00000000..ef622fdf --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Input.src/M000007.html @@ -0,0 +1,27 @@ + + + + + + getJoystickAxis (SFML::Input) + + + + + 
/* call-seq:
+ *   input.getJoystickAxis( joystick, axis )    -> true or false
+ *
+ * The returned position is in the range [-100, 100], except the POV which is an angle and is thus defined in [0, 360].
+ */
+static VALUE Input_GetJoystickAxis( VALUE self, VALUE aJoystick, VALUE anAxis )
+{
+        sf::Input *object = NULL;
+        Data_Get_Struct( self, sf::Input, object );
+        unsigned int rawJoystick =  NUM2UINT( aJoystick );
+        sf::Joy::Axis rawAxis =  static_cast< sf::Joy::Axis >( NUM2INT( anAxis ) );
+        return rb_float_new( object->GetJoystickAxis( rawJoystick, rawAxis ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Joy.html b/bindings/ruby/sfml-window/doc/classes/SFML/Joy.html new file mode 100644 index 00000000..c7793683 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Joy.html @@ -0,0 +1,159 @@ + + + + + + Module: SFML::Joy + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSFML::Joy
In: + + window/main.cpp + +
+
+
+ + +
+ + + +
+ +
+

+Definition of joystick axis for joystick events. +

+ +
+ + +
+ + +
+ + + + +
+ + +
+

Constants

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AxisX=INT2FIX( sf::Joy::AxisX )
AxisY=INT2FIX( sf::Joy::AxisY )
AxisZ=INT2FIX( sf::Joy::AxisZ )
AxisR=INT2FIX( sf::Joy::AxisR )
AxisU=INT2FIX( sf::Joy::AxisU )
AxisV=INT2FIX( sf::Joy::AxisV )
AxisPOV=INT2FIX( sf::Joy::AxisPOV )
AxisCount=INT2FIX( sf::Joy::AxisCount )
+
+
+ + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Key.html b/bindings/ruby/sfml-window/doc/classes/SFML/Key.html new file mode 100644 index 00000000..3342cb30 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Key.html @@ -0,0 +1,298 @@ + + + + + + Module: SFML::Key + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSFML::Key
In: + + window/main.cpp + +
+
+
+ + +
+ + + +
+ +
+

+Definition of key codes for keyboard events. +

+

+All SFML::Key constants exists, I just haven‘t +written them all so Rdoc can interpret them yet. +

+ +
+ + +
+ + +
+ + + + +
+ + +
+

Constants

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
A=INT2FIX( sf::Key::A )
B=INT2FIX( sf::Key::B )
C=INT2FIX( sf::Key::C )
D=INT2FIX( sf::Key::D )
E=INT2FIX( sf::Key::E )
F=INT2FIX( sf::Key::F )
G=INT2FIX( sf::Key::G )
H=INT2FIX( sf::Key::H )
I=INT2FIX( sf::Key::I )
J=INT2FIX( sf::Key::J )
K=INT2FIX( sf::Key::K )
L=INT2FIX( sf::Key::L )
M=INT2FIX( sf::Key::M )
N=INT2FIX( sf::Key::N )
O=INT2FIX( sf::Key::O )
P=INT2FIX( sf::Key::P )
Q=INT2FIX( sf::Key::Q )
R=INT2FIX( sf::Key::R )
S=INT2FIX( sf::Key::S )
T=INT2FIX( sf::Key::T )
U=INT2FIX( sf::Key::U )
V=INT2FIX( sf::Key::V )
X=INT2FIX( sf::Key::X )
Y=INT2FIX( sf::Key::Y )
Z=INT2FIX( sf::Key::Z )
Num0=INT2FIX( sf::Key::Num0 )
Num1=INT2FIX( sf::Key::Num1 )
Num2=INT2FIX( sf::Key::Num2 )
Num3=INT2FIX( sf::Key::Num3 )
Num4=INT2FIX( sf::Key::Num4 )
Num5=INT2FIX( sf::Key::Num5 )
Num6=INT2FIX( sf::Key::Num6 )
Num7=INT2FIX( sf::Key::Num7 )
Num8=INT2FIX( sf::Key::Num8 )
Num9=INT2FIX( sf::Key::Num9 )
+
+
+ + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Mouse.html b/bindings/ruby/sfml-window/doc/classes/SFML/Mouse.html new file mode 100644 index 00000000..51b1fc68 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Mouse.html @@ -0,0 +1,149 @@ + + + + + + Module: SFML::Mouse + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSFML::Mouse
In: + + window/main.cpp + +
+
+
+ + +
+ + + +
+ +
+

+Definition of button codes for mouse events. +

+ +
+ + +
+ + +
+ + + + +
+ + +
+

Constants

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Left=INT2FIX( sf::Mouse::Left )
Right=INT2FIX( sf::Mouse::Right )
Middle=INT2FIX( sf::Mouse::Middle )
XButton1=INT2FIX( sf::Mouse::XButton1 )
XButton2=INT2FIX( sf::Mouse::XButton2 )
ButtonCount=INT2FIX( sf::Mouse::ButtonCount )
+
+
+ + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Style.html b/bindings/ruby/sfml-window/doc/classes/SFML/Style.html new file mode 100644 index 00000000..18fe9ac2 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Style.html @@ -0,0 +1,149 @@ + + + + + + Module: SFML::Style + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSFML::Style
In: + + window/main.cpp + +
+
+
+ + +
+ + + +
+ +
+

+Enumeration of the window styles. +

+ +
+ + +
+ + +
+ + + + +
+ + +
+

Constants

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
None=INT2FIX( sf::Style::None )
Titlebar=INT2FIX( sf::Style::Titlebar )
Resize=INT2FIX( sf::Style::Resize )
Close=INT2FIX( sf::Style::Close )
Fullscreen=INT2FIX( sf::Style::Fullscreen )
Default=INT2FIX( sf::Style::Default )
+
+
+ + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.html new file mode 100644 index 00000000..e7fe12c0 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.html @@ -0,0 +1,414 @@ + + + + + + Class: SFML::VideoMode + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::VideoMode
In: + + window/main.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+A video mode is defined by a width and +a height (in pixels) and a depth (in +bits per pixel). +

+

+Video modes are used to setup windows (SFML::Window) at creation time. +

+

+The main usage of video modes is for fullscreen mode: indeed you must use +one of the valid video modes allowed by the OS (which are defined by what +the monitor and the graphics card support), otherwise your window creation +will just fail. +

+

+SFML::VideoMode provides a static function for +retrieving the list of all the video modes supported by the system: getFullscreenModes(). +

+

+A custom video mode can also be checked directly for fullscreen +compatibility with its isValid() function. +

+

+Additionnally, SFML::VideoMode provides a +static function to get the mode currently used by the desktop: getDesktopMode(). This allows to build +windows with the same size or pixel depth as the current resolution. +

+

+Usage example: +

+
+  # Display the list of all the video modes available for fullscreen
+  modes = SFML::VideoMode.getFullscreenModes()
+  i = 0
+  modes.each do | mode |
+    puts "Mode #" + i + ": " + mode.width + "x" + mode.height + " - " + mode.bitsPerPixel + " bpp"
+
+  end
+
+  # Create a window with the same pixel depth as the desktop
+  desktop = SFML::VideoMode.getDesktopMode()
+  window.create( SFML::VideoMode.new( 1024, 768, desktop.BitsPerPixel ), "SFML window" )
+
+ +
+ + +
+ +
+

Methods

+ +
+ bitsPerPixel   + bitsPerPixel=   + bits_per_pixel   + bits_per_pixel=   + bpp   + bpp=   + getDesktopMode   + getFullscreenModes   + height   + height=   + new   + width   + width=   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Class methods

+ +
+ + +
+ + VideoMode.getDesktopMode → desktop_mode
+ + +
+ +
+

+Get the current desktop video mode. +

+
+
+ +
+ + +
+ + VideoMode.getFullscreenModes → [supported_modes]
+ + +
+ +
+

+Retrieve all the video modes supported in fullscreen mode. +

+

+When creating a fullscreen window, the video mode is restricted to be +compatible with what the graphics driver and monitor support. This function +returns the complete list of all video modes that can be used in fullscreen +mode. The returned array is sorted from best to worst, so that the first +element will always give the best mode (higher width, height and bits-per-pixel). +

+
+
+ + + +

Public Instance methods

+ +
+ + +
+ + mode.bitsPerPixel → bpp
+ + +
+ +
+

+Video mode pixel depth, in bits per pixels. +

+
+
+ +
+ + +
+ + mode.bitsPerPixel=(new_bpp) → new_bpp
+ + +
+ +
+

+Video mode pixel depth, in bits per pixels. +

+
+
+ +
+ + +
+ bits_per_pixel() +
+ +
+

+Alias for bitsPerPixel +

+
+
+ +
+ + +
+ bits_per_pixel=(p1) +
+ +
+

+Alias for bitsPerPixel= +

+
+
+ +
+ + +
+ bpp() +
+ +
+

+Alias for bitsPerPixel +

+
+
+ +
+ + +
+ bpp=(p1) +
+ +
+

+Alias for bitsPerPixel= +

+
+
+ +
+ + +
+ + mode.width → width
+ + +
+ +
+

+Video mode width, in pixels. +

+
+
+ +
+ + +
+ + mode.width=(new_width) → new_width
+ + +
+ +
+

+Video mode width, in pixels. +

+
+
+ +
+ + +
+ + mode.width → width
+ + +
+ +
+

+Video mode width, in pixels. +

+
+
+ +
+ + +
+ + mode.width=(new_width) → new_width
+ + +
+ +
+

+Video mode width, in pixels. +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000020.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000020.html new file mode 100644 index 00000000..21fa891c --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000020.html @@ -0,0 +1,42 @@ + + + + + + new (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   VideoMode.new()                            -> mode
+ *   VideoMode.new( width, height, bpp = 32 )   -> mode
+ *
+ * Create a new mode.
+ */
+static VALUE VideoMode_New( int argc, VALUE *args, VALUE aKlass )
+{
+        sf::VideoMode *object = NULL;
+        switch( argc )
+        {
+                case 0:
+                        object = new sf::VideoMode();
+                        break;
+                case 2:
+                        object = new sf::VideoMode( FIX2UINT( args[0] ), FIX2UINT( args[1] ) );
+                        break;
+                case 3:
+                        object = new sf::VideoMode( FIX2UINT( args[0] ), FIX2UINT( args[1] ),FIX2UINT( args[2] ) );
+                        break;
+                default:
+                        rb_raise( rb_eArgError, "Expected 0, 2 or 3 arguments but was given %d", argc );
+                        break;
+        }
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, VideoMode_Free, object );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000021.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000021.html new file mode 100644 index 00000000..fdcb5b73 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000021.html @@ -0,0 +1,26 @@ + + + + + + getDesktopMode (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   VideoMode.getDesktopMode   -> desktop_mode
+ *
+ * Get the current desktop video mode. 
+ */
+static VALUE VideoMode_GetDesktopMode( VALUE aKlass )
+{
+        sf::VideoMode *object = new sf::VideoMode( sf::VideoMode::GetDesktopMode() );
+        VALUE rbData = Data_Wrap_Struct( aKlass, 0, VideoMode_Free, object );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000022.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000022.html new file mode 100644 index 00000000..1880e413 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000022.html @@ -0,0 +1,37 @@ + + + + + + getFullscreenModes (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   VideoMode.getFullscreenModes       -> [supported_modes]
+ *
+ * Retrieve all the video modes supported in fullscreen mode.
+ *
+ * When creating a fullscreen window, the video mode is restricted to be compatible with what the graphics driver and 
+ * monitor support. This function returns the complete list of all video modes that can be used in fullscreen mode. 
+ * The returned array is sorted from best to worst, so that the first element will always give the best mode
+ * (higher width, height and bits-per-pixel).
+ */
+static VALUE VideoMode_GetFullscreenModes( VALUE aKlass )
+{
+        const std::vector< sf::VideoMode >& modes = sf::VideoMode::GetFullscreenModes();
+        VALUE array = rb_ary_new();
+        for( std::vector< sf::VideoMode >::const_iterator it = modes.begin(), end = modes.end(); it != end; it++ )
+        {
+                sf::VideoMode *object = new sf::VideoMode( *it );
+                VALUE rbData = Data_Wrap_Struct( aKlass, 0, VideoMode_Free, object );
+                rb_obj_call_init( rbData, 0, 0 );
+                rb_ary_push( array, rbData );
+        }
+        return array;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000023.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000023.html new file mode 100644 index 00000000..9d8ca92d --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000023.html @@ -0,0 +1,25 @@ + + + + + + width (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   mode.width         -> width
+ *
+ * Video mode width, in pixels.
+ */
+static VALUE VideoMode_GetWidth( VALUE self )
+{
+        sf::VideoMode *object = NULL;
+        Data_Get_Struct( self, sf::VideoMode, object );
+        return INT2FIX( object->Width );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000024.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000024.html new file mode 100644 index 00000000..31cfd8fa --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000024.html @@ -0,0 +1,25 @@ + + + + + + width= (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   mode.width=(new_width)     -> new_width
+ *
+ * Video mode width, in pixels.
+ */
+static VALUE VideoMode_SetWidth( VALUE self, VALUE aValue )
+{
+        sf::VideoMode *object = NULL;
+        Data_Get_Struct( self, sf::VideoMode, object );
+        return INT2FIX( object->Width = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000025.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000025.html new file mode 100644 index 00000000..40e1c751 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000025.html @@ -0,0 +1,25 @@ + + + + + + height (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   mode.width         -> width
+ *
+ * Video mode width, in pixels.
+ */
+static VALUE VideoMode_GetWidth( VALUE self )
+{
+        sf::VideoMode *object = NULL;
+        Data_Get_Struct( self, sf::VideoMode, object );
+        return INT2FIX( object->Width );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000026.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000026.html new file mode 100644 index 00000000..0fcec977 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000026.html @@ -0,0 +1,25 @@ + + + + + + height= (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   mode.width=(new_width)     -> new_width
+ *
+ * Video mode width, in pixels.
+ */
+static VALUE VideoMode_SetWidth( VALUE self, VALUE aValue )
+{
+        sf::VideoMode *object = NULL;
+        Data_Get_Struct( self, sf::VideoMode, object );
+        return INT2FIX( object->Width = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000027.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000027.html new file mode 100644 index 00000000..9de5371b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000027.html @@ -0,0 +1,25 @@ + + + + + + bitsPerPixel (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   mode.bitsPerPixel  -> bpp
+ *
+ * Video mode pixel depth, in bits per pixels. 
+ */
+static VALUE VideoMode_GetBitsPerPixel( VALUE self )
+{
+        sf::VideoMode *object = NULL;
+        Data_Get_Struct( self, sf::VideoMode, object );
+        return INT2FIX( object->BitsPerPixel );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000028.html b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000028.html new file mode 100644 index 00000000..adf93de7 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/VideoMode.src/M000028.html @@ -0,0 +1,25 @@ + + + + + + bitsPerPixel= (SFML::VideoMode) + + + + + 
/* call-seq:
+ *   mode.bitsPerPixel=(new_bpp)        -> new_bpp
+ *
+ * Video mode pixel depth, in bits per pixels. 
+ */
+static VALUE VideoMode_SetBitsPerPixel( VALUE self, VALUE aValue )
+{
+        sf::VideoMode *object = NULL;
+        Data_Get_Struct( self, sf::VideoMode, object );
+        return INT2FIX( object->BitsPerPixel = NUM2UINT( aValue ) );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.html new file mode 100644 index 00000000..c53deac9 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.html @@ -0,0 +1,1222 @@ + + + + + + Class: SFML::Window + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassSFML::Window
In: + + window/main.cpp + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+SFML::Window is the main class of the Window module. +

+

+It defines an OS window that is able to receive an OpenGL rendering. +

+

+A SFML::Window can create its own new window, but using an +already created window trough a handle is not supported in the ruby +bindings yet. +

+

+The SFML::Window class provides a simple +interface for manipulating the window: move, resize, show/hide, control +mouse cursor, etc. It also provides event handling through its getEvent() function, and real-time state +handling with its attached SFML::Input object (see +getInput()). +

+

+Note that OpenGL experts can pass their own parameters (antialiasing level, +bits for the depth and stencil buffers, etc.) to the OpenGL context +attached to the window, with the SFML::ContextSettings structure which is +passed as an optional argument when creating the window. +

+

+Usage example: +

+
+  # Declare and create a new window
+  window = SFML::Window.new( SFML::VideoMode.new( 800, 600 ), "SFML window" )
+
+  # Limit the framerate to 60 frames per second (this step is optional)
+  window.setFramerateLimit( 60 );
+
+  # The main loop - ends as soon as the window is closed
+  while window.open?
+
+    # Event processing
+    while event = window.getEvent
+
+      # Request for closing the window
+      if event.type == SFML::Event::Closed
+        window.close()
+      end
+    end
+
+    # Activate the window for OpenGL rendering
+    window.setActive()
+
+    # OpenGL drawing commands go here...
+
+    # End the current frame and display its contents on screen
+    window.display()
+  end
+
+ +
+ + +
+ +
+

Methods

+ +
+ active=   + close   + create   + cursorPosition=   + cursor_position=   + display   + enableKeyRepeat   + framerate=   + framerateLimit=   + framerate_limit=   + getEvent   + getHeight   + getInput   + getSettings   + getWidth   + get_event   + height   + input   + isOpened   + joystickThreshold=   + joystick_threshold=   + keyRepeat=   + key_repeat=   + open?   + opened?   + position=   + setActive   + setCursorPosition   + setFramerateLimit   + setIcon   + setJoystickThreshold   + setPosition   + setSize   + setTitle   + set_cursor_position   + set_icon   + set_position   + set_size   + settings   + show   + showMouseCursor   + showMouseCursor=   + show_mouse_cursor   + show_mouse_cursor=   + size=   + title=   + useVerticalSync   + useVerticalSync=   + use_vertical_sync   + use_vertical_sync=   + waitEvent   + wait_event   + width   +
+
+ +
+ + + + +
+ + + +
+

External Aliases

+ +
+ + + + + + + + + + + +
getFrameTime->frameTime
getFrameTime->frame_time
+
+
+ + + + + + +
+

Public Instance methods

+ +
+ + +
+ active=(p1) +
+ +
+

+Alias for setActive +

+
+
+ +
+ + +
+ + window.close()
+ + +
+ +
+

+Close the window and destroy all the attached resources. +

+

+After calling this function, the SFML::Window +instance remains valid and you can call SFML::Window#create to recreate the window. +All other functions such as getEvent or +display will still work (i.e. you +don‘t have to test isOpened every +time), and will have no effect on closed windows. +

+
+
+ +
+ + +
+ + window.create( mode, title, style = SFML::Style::Default, settings = SFML::ContextSettings.new )
+ + +
+ +
+

+Create (or recreate) the window. +

+

+If the window was already created, it closes it first. If style contains +Style::Fullscreen, then mode must be a valid video mode. +

+
+
+ +
+ + +
+ + window.cursorPosition=( vector2 )
+ + +
+ +
+

+Change the position of the mouse cursor. +

+
+
+ +
+ + +
+ cursor_position=(p1) +
+ +
+

+Alias for cursorPosition= +

+
+
+ +
+ + +
+ + window.display()
+ + +
+ +
+

+Display on screen what has been rendered to the window so far. +

+

+This function is typically called after all OpenGL rendering has been done +for the current frame, in order to show +it on screen. +

+
+
+ +
+ + +
+ + window.enableKeyRepeat( enable )
+ + +
+ +
+

+Enable or disable automatic key-repeat. +

+

+If key repeat is enabled, you will receive repeated KeyPress events while +keeping a key pressed. If it is disabled, you will only get a single event +when the key is pressed. +

+

+Key repeat is enabled by default. +

+
+
+ +
+ + +
+ framerate=(p1) +
+ +
+

+Alias for setFramerateLimit +

+
+
+ +
+ + +
+ framerateLimit=(p1) +
+ +
+

+Alias for setFramerateLimit +

+
+
+ +
+ + +
+ framerate_limit=(p1) +
+ +
+

+Alias for setFramerateLimit +

+
+
+ +
+ + +
+ + window.getEvent() → event or nil
+ + +
+ +
+

+Pop the event on top of events stack, if any, and return it. +

+

+This function is not blocking: if there‘s no pending event then it +will return nil. Note that more than the returned event may be present in +the events stack, thus you should always call this function in a loop to +make sure that you process every pending event. +

+
+
+ +
+ + +
+ + window.getHeight() → fixnum
+ + +
+ +
+

+Get the height of the rendering region of +the window. +

+

+The height doesn‘t include the +titlebar and borders of the window. +

+
+
+ +
+ + +
+ + window.getInput() → input
+ + +
+ +
+

+This input gives access to the real-time +state of keyboard, mouse and joysticks for this window +

+
+
+ +
+ + +
+ + window.getSettings() → settings
+ + +
+ +
+

+Get the settings of the OpenGL context of +the window. +

+

+Note that these settings may be different +from what was passed to the constructor or the Create() function, if one or +more settings were not supported. In this +case, SFML chose the closest match. +

+
+
+ +
+ + +
+ + window.getWidth() → fixnum
+ + +
+ +
+

+Get the width of the rendering region of +the window. +

+

+The width doesn‘t include the +titlebar and borders of the window. +

+
+
+ +
+ + +
+ get_event() +
+ +
+

+Alias for getEvent +

+
+
+ +
+ + +
+ height() +
+ +
+

+Alias for getHeight +

+
+
+ +
+ + +
+ input() +
+ +
+

+Alias for getInput +

+
+
+ +
+ + +
+ + window.isOpened() → true or false
+ + +
+ +
+

+This function returns whether or not the window exists. Note that a hidden +window (Show(false)) will return true. +

+
+
+ +
+ + +
+ joystickThreshold=(p1) +
+ +
+

+Alias for setJoystickThreshold +

+
+
+ +
+ + +
+ joystick_threshold=(p1) +
+ +
+

+Alias for setJoystickThreshold +

+
+
+ +
+ + +
+ keyRepeat=(p1) +
+ +
+

+Alias for enableKeyRepeat +

+
+
+ +
+ + +
+ key_repeat=(p1) +
+ +
+

+Alias for enableKeyRepeat +

+
+
+ +
+ + +
+ open?() +
+ +
+

+Alias for isOpened +

+
+
+ +
+ + +
+ opened?() +
+ +
+

+Alias for isOpened +

+
+
+ +
+ + +
+ + window.position=( vector2 )
+ + +
+ +
+

+Change the position of the window on screen. +

+

+This function only works for top-level windows (i.e. it will be ignored for +windows created from the handle of a child window/control). +

+
+
+ +
+ + +
+ + window.setActive( activate ) → true or false
+ + +
+ +
+

+Activate or deactivate the window as the current target for OpenGL +rendering. +

+

+A window is active only on the current thread, if you want to make it +active on another thread you have to deactivate it on the previous thread +first if it was active. Only one window can be active on a thread at a +time, thus the window previously active (if any) automatically gets +deactivated. +

+
+
+ +
+ + +
+ + window.setCursorPosition( new_x, new_y )
+ + +
+ +
+

+Change the position of the mouse cursor. +

+
+
+ +
+ + +
+ + window.setFramerateLimit( new_limit )
+ + +
+ +
+

+Limit the framerate to a maximum fixed frequency. +

+

+If a limit is set, the window will use a small delay after each call to +Display() to ensure that the current frame lasted long enough to match the +framerate limit. +

+
+
+ +
+ + +
+ + window.setIcon( width, height, pixels )
+ + +
+ +
+

+Change the window‘s icon. +

+

+pixels must be an array of width x height pixels in 32-bits RGBA format. In the +ruby binding the array will be flattened so you can have array‘s up +to 3 dimensions(or more) to represent each pixel component. The size of the +array will be assumed to be width * height * 4. +

+

+The OS default icon is used by default. +

+

+Usage example: +

+
+  pixels = [
+    [[255, 0, 0, 255], [0, 0, 255, 255]],
+    [[0, 255, 0, 255], [0, 0, 0, 255]]
+  ]
+
+  window.setIcon( 2, 2, pixels )
+
+
+
+ +
+ + +
+ + window.setJoystickThreshold( new_threshold )
+ + +
+ +
+

+Change the joystick threshold. +

+

+The joystick threshold is the value below which no JoyMoved event will be +generated. +

+

+The threshold value is 0.1 by default. The threshold has to be in the range +0..100 +

+
+
+ +
+ + +
+ + window.setPosition( new_x, new_y )
+ + +
+ +
+

+Change the position of the window on screen. +

+

+This function only works for top-level windows (i.e. it will be ignored for +windows created from the handle of a child window/control). +

+
+
+ +
+ + +
+ + window.setSize( new_width, new_height )
+ + +
+ +
+

+Change the size of the rendering region of the window. +

+
+
+ +
+ + +
+ + window.setTitle( new_title )
+ + +
+ +
+

+Change the title of the window. +

+
+
+ +
+ + +
+ set_cursor_position(p1, p2) +
+ +
+

+Alias for setCursorPosition +

+
+
+ +
+ + +
+ set_icon(p1, p2, p3) +
+ +
+

+Alias for setIcon +

+
+
+ +
+ + +
+ set_position(p1, p2) +
+ +
+

+Alias for setPosition +

+
+
+ +
+ + +
+ set_size(p1, p2) +
+ +
+

+Alias for setSize +

+
+
+ +
+ + +
+ settings() +
+ +
+

+Alias for getSettings +

+
+
+ +
+ + +
+ + window.show( show )
+ + +
+ +
+

+Show or hide the window. +

+

+The window is shown by default. +

+
+
+ +
+ + +
+ + window.showMouseCursor( show )
+ + +
+ +
+

+Show or hide the mouse cursor. +

+

+The mouse cursor is shown by default. +

+
+
+ +
+ + +
+ showMouseCursor=(p1) +
+ +
+

+Alias for showMouseCursor +

+
+
+ +
+ + +
+ show_mouse_cursor(p1) +
+ +
+

+Alias for showMouseCursor +

+
+
+ +
+ + +
+ show_mouse_cursor=(p1) +
+ +
+

+Alias for showMouseCursor +

+
+
+ +
+ + +
+ + window.size=( vector2 )
+ + +
+ +
+

+Change the size of the rendering region of the window. +

+
+
+ +
+ + +
+ title=(p1) +
+ +
+

+Alias for setTitle +

+
+
+ +
+ + +
+ + window.useVerticalSync( enabled )
+ + +
+ +
+

+Enable or disable vertical synchronization. +

+

+Activating vertical synchronization will limit the number of frames +displayed to the refresh rate of the monitor. This can avoid some visual +artifacts, and limit the framerate to a good value (but not constant across +different computers). +

+

+Vertical synchronization is disabled by default. +

+
+
+ +
+ + +
+ useVerticalSync=(p1) +
+ +
+

+Alias for useVerticalSync +

+
+
+ +
+ + +
+ use_vertical_sync(p1) +
+ +
+

+Alias for useVerticalSync +

+
+
+ +
+ + +
+ use_vertical_sync=(p1) +
+ +
+

+Alias for useVerticalSync +

+
+
+ +
+ + +
+ + window.waitEvent() → event or nil
+ + +
+ +
+

+Wait for an event and return it. +

+

+This function is blocking: if there‘s no pending event then it will +wait until an event is received. After this function returns (and no error +occured), the event object is always valid and filled properly. This +function is typically used when you have a thread that is dedicated to +events handling: you want to make this thread sleep as long as no new event +is received. +

+
+
+ +
+ + +
+ wait_event() +
+ +
+

+Alias for waitEvent +

+
+
+ +
+ + +
+ width() +
+ +
+

+Alias for getWidth +

+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000038.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000038.html new file mode 100644 index 00000000..f676fd51 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000038.html @@ -0,0 +1,30 @@ + + + + + + close (SFML::Window) + + + + + 
/* call-seq:
+ *   window.close()
+ *
+ * Close the window and destroy all the attached resources. 
+ *
+ * After calling this function, the SFML::Window instance remains valid and you can call SFML::Window#create to recreate
+ * the window. All other functions such as getEvent or display will still work (i.e. you don't have to test 
+ * isOpened every time), and will have no effect on closed windows. 
+ */
+static VALUE Window_Close( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->Close();
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000039.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000039.html new file mode 100644 index 00000000..a60acbe8 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000039.html @@ -0,0 +1,63 @@ + + + + + + create (SFML::Window) + + + + + 
/* call-seq:
+ *   window.create( mode, title, style = SFML::Style::Default, settings = SFML::ContextSettings.new )
+ *
+ * Create (or recreate) the window. 
+ *
+ * If the window was already created, it closes it first. If style contains Style::Fullscreen, 
+ * then mode must be a valid video mode.
+ */
+static VALUE Window_Create( int argc, VALUE *args, VALUE self )
+{
+        sf::Window *object = NULL;
+        sf::VideoMode *mode = NULL;
+        sf::ContextSettings *settings = NULL;
+        VALUE arg0 = Qnil;
+        
+        Data_Get_Struct( self, sf::Window, object );
+        switch( argc )
+        {
+                case 2:
+                        arg0 = VideoMode_ForceType( args[0] );
+                        VALIDATE_CLASS( arg0, globalVideoModeClass, "first" );
+                        VALIDATE_CLASS( args[1], rb_cString, "second" );
+                        Data_Get_Struct( arg0, sf::VideoMode, mode );
+                        object->Create( *mode ,rb_string_value_cstr( &args[1] ) );
+                        break;
+                case 3:
+                        arg0 = VideoMode_ForceType( args[0] );
+                        VALIDATE_CLASS( arg0, globalVideoModeClass, "first" );
+                        VALIDATE_CLASS( args[1], rb_cString, "second" );
+                        VALIDATE_CLASS( args[2], rb_cFixnum, "third" );
+                        Data_Get_Struct( arg0, sf::VideoMode, mode );
+                        object->Create( *mode, rb_string_value_cstr( &args[1] ), FIX2UINT( args[2] ) );
+                        break;
+                case 4:
+                        arg0 = VideoMode_ForceType( args[0] );
+                        VALIDATE_CLASS( arg0, globalVideoModeClass, "first" );
+                        VALIDATE_CLASS( args[1], rb_cString, "second" );
+                        VALIDATE_CLASS( args[2], rb_cFixnum, "third" );
+                        VALIDATE_CLASS( args[3], globalContextSettingsClass, "fourth" );
+                        Data_Get_Struct( arg0, sf::VideoMode, mode );
+                        Data_Get_Struct( args[3], sf::ContextSettings, settings );
+                        object->Create( *mode, rb_string_value_cstr( &args[1] ), FIX2UINT( args[2] ), *settings );
+                        break;
+                default:
+                        rb_raise( rb_eArgError, "Expected 2..4 arguments but was given %d", argc );
+                        break;
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000040.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000040.html new file mode 100644 index 00000000..46676bb7 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000040.html @@ -0,0 +1,29 @@ + + + + + + display (SFML::Window) + + + + + 
/* call-seq:
+ *   window.display()
+ *
+ * Display on screen what has been rendered to the window so far. 
+ *
+ * This function is typically called after all OpenGL rendering has been done for the current frame, in order to show 
+ * it on screen. 
+ */
+static VALUE Window_Display( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->Display();
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000041.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000041.html new file mode 100644 index 00000000..e46d7def --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000041.html @@ -0,0 +1,42 @@ + + + + + + enableKeyRepeat (SFML::Window) + + + + + 
/* call-seq:
+ *   window.enableKeyRepeat( enable )
+ *
+ * Enable or disable automatic key-repeat. 
+ *
+ * If key repeat is enabled, you will receive repeated KeyPress events while keeping a key pressed. If it is disabled, 
+ * you will only get a single event when the key is pressed.
+ *
+ * Key repeat is enabled by default.
+ */
+static VALUE Window_EnableKeyRepeat( VALUE self, VALUE anEnableFlag )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        if( anEnableFlag == Qfalse )
+        {
+                object->EnableKeyRepeat( false );
+        }
+        else if( anEnableFlag == Qtrue )
+        {
+                object->EnableKeyRepeat( true );
+        }
+        else
+        {
+                rb_raise( rb_eTypeError, "Expected true or false" );
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000042.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000042.html new file mode 100644 index 00000000..bea5a31b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000042.html @@ -0,0 +1,41 @@ + + + + + + getEvent (SFML::Window) + + + + + 
/* call-seq:
+ *   window.getEvent()  -> event or nil
+ *
+ * Pop the event on top of events stack, if any, and return it.
+ *
+ * This function is not blocking: if there's no pending event then it will return nil. Note that more than the returned
+ * event may be present in the events stack, thus you should always call this function in a loop to make sure that you
+ * process every pending event. 
+ */
+static VALUE Window_GetEvent( VALUE self )
+{
+        sf::Event event;
+        sf::Window *window = NULL;
+        Data_Get_Struct( self, sf::Window, window );
+        if( window->GetEvent( event ) == true )
+        {
+                VALUE rbObject = rb_funcall( globalEventClass, rb_intern( "new" ), 1, INT2FIX( event.Type ) );
+                sf::Event *rubyRawEvent = NULL;
+                Data_Get_Struct( rbObject, sf::Event, rubyRawEvent );
+                *rubyRawEvent = event;
+                return rbObject;
+        }
+        else
+        {
+                return Qnil;
+        }      
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000043.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000043.html new file mode 100644 index 00000000..fe05b0d4 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000043.html @@ -0,0 +1,27 @@ + + + + + + getHeight (SFML::Window) + + + + + 
/* call-seq:
+ *   window.getHeight() -> fixnum
+ *
+ * Get the height of the rendering region of the window.
+ *
+ * The height doesn't include the titlebar and borders of the window.
+ */
+static VALUE Window_GetHeight( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        return INT2FIX( object->GetHeight() );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000044.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000044.html new file mode 100644 index 00000000..e49f4000 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000044.html @@ -0,0 +1,27 @@ + + + + + + getInput (SFML::Window) + + + + + 
/* call-seq:
+ *   window.getInput()  -> input
+ *
+ * This input gives access to the real-time state of keyboard, mouse and joysticks for this window
+ */
+static VALUE Window_GetInput( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        VALUE rbData = Data_Wrap_Struct( globalInputClass, 0, 0, const_cast< sf::Input * >( &object->GetInput() ) );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000045.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000045.html new file mode 100644 index 00000000..8aeb506e --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000045.html @@ -0,0 +1,30 @@ + + + + + + getSettings (SFML::Window) + + + + + 
/* call-seq:
+ *   window.getSettings()       -> settings
+ *
+ * Get the settings of the OpenGL context of the window.
+ *
+ * Note that these settings may be different from what was passed to the constructor or the Create() function, if one 
+ * or more settings were not supported. In this case, SFML chose the closest match.
+ */
+static VALUE Window_GetSettings( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        VALUE rbData = Data_Wrap_Struct( globalContextSettingsClass, 0, 0, const_cast<sf::ContextSettings *>( &object->GetSettings() ) );
+        rb_obj_call_init( rbData, 0, 0 );
+        return rbData;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000046.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000046.html new file mode 100644 index 00000000..5fc53324 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000046.html @@ -0,0 +1,27 @@ + + + + + + getWidth (SFML::Window) + + + + + 
/* call-seq:
+ *   window.getWidth()  -> fixnum
+ *
+ * Get the width of the rendering region of the window.
+ *
+ * The width doesn't include the titlebar and borders of the window.
+ */
+static VALUE Window_GetWidth( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        return INT2FIX( object->GetWidth() );
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000047.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000047.html new file mode 100644 index 00000000..6b58cd55 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000047.html @@ -0,0 +1,32 @@ + + + + + + isOpened (SFML::Window) + + + + + 
/* call-seq:
+ *   window.isOpened()  -> true or false
+ *
+ * This function returns whether or not the window exists. Note that a hidden window (Show(false)) will return true.
+ */
+static VALUE Window_IsOpened( VALUE self )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        if( object->IsOpened() == true )
+        {
+                return Qtrue;
+        }
+        else
+        {
+                return Qfalse;
+        }
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000048.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000048.html new file mode 100644 index 00000000..9d5817d7 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000048.html @@ -0,0 +1,41 @@ + + + + + + setActive (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setActive( activate )       -> true or false
+ *
+ * Activate or deactivate the window as the current target for OpenGL rendering.
+ *
+ * A window is active only on the current thread, if you want to make it active on another thread you have to 
+ * deactivate it on the previous thread first if it was active. Only one window can be active on a thread at a time, 
+ * thus the window previously active (if any) automatically gets deactivated.
+ */
+static VALUE Window_SetActive( VALUE self, VALUE anActiveFlag )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        if( anActiveFlag == Qfalse )
+        {
+                object->SetActive( false );
+        }
+        else if( anActiveFlag == Qtrue )
+        {
+                object->SetActive( true );
+        }
+        else
+        {
+                rb_raise( rb_eTypeError, "Expected true or false" );
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000049.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000049.html new file mode 100644 index 00000000..72caefe3 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000049.html @@ -0,0 +1,26 @@ + + + + + + setCursorPosition (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setCursorPosition( new_x, new_y )
+ *
+ * Change the position of the mouse cursor. 
+ */
+static VALUE Window_SetCursorPosition( VALUE self, VALUE aX, VALUE aY )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetCursorPosition( FIX2UINT( aX ), FIX2UINT( aY ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000050.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000050.html new file mode 100644 index 00000000..c3a00b1b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000050.html @@ -0,0 +1,29 @@ + + + + + + cursorPosition= (SFML::Window) + + + + + 
/* call-seq:
+ *   window.cursorPosition=( vector2 )
+ *
+ * Change the position of the mouse cursor. 
+ */
+static VALUE Window_SetCursorPosition2( VALUE self, VALUE anArgument )
+{
+        VALUE argument = Vector2_ForceType( anArgument );
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        VALUE argumentX = rb_funcall( argument, rb_intern( "x" ), 0 );
+        VALUE argumentY = rb_funcall( argument, rb_intern( "y" ), 0 );
+        object->SetCursorPosition( FIX2UINT( argumentX ), FIX2UINT( argumentY ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000051.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000051.html new file mode 100644 index 00000000..4638da82 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000051.html @@ -0,0 +1,29 @@ + + + + + + setFramerateLimit (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setFramerateLimit( new_limit )
+ *
+ * Limit the framerate to a maximum fixed frequency.
+ *
+ * If a limit is set, the window will use a small delay after each call to Display() to ensure that the current frame 
+ * lasted long enough to match the framerate limit.
+ */
+static VALUE Window_SetFramerateLimit( VALUE self, VALUE aLimit )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetFramerateLimit( FIX2UINT( aLimit ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000052.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000052.html new file mode 100644 index 00000000..7eab1b2b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000052.html @@ -0,0 +1,53 @@ + + + + + + setIcon (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setIcon( width, height, pixels )
+ *
+ * Change the window's icon.
+ *
+ * pixels must be an array of width x height pixels in 32-bits RGBA format. In the ruby binding the array will be
+ * flattened so you can have array's up to 3 dimensions(or more) to represent each pixel component. The size of the
+ * array will be assumed to be width * height * 4.
+ *
+ * The OS default icon is used by default.
+ * 
+ * Usage example:
+ *   pixels = [
+ *     [[255, 0, 0, 255], [0, 0, 255, 255]],
+ *     [[0, 255, 0, 255], [0, 0, 0, 255]]
+ *   ]
+ *   
+ *   window.setIcon( 2, 2, pixels )
+ */
+static VALUE Window_SetIcon( VALUE self, VALUE aWidth, VALUE aHeight, VALUE somePixels )
+{
+        const unsigned int rawWidth = FIX2UINT( aWidth );
+        const unsigned int rawHeight = FIX2UINT( aHeight );
+        VALIDATE_CLASS( somePixels, rb_cArray, "third" );
+        const unsigned long dataSize = rawWidth * rawHeight * 4;
+        sf::Uint8 * const tempData = new sf::Uint8[dataSize];
+        VALUE pixels = rb_funcall( somePixels, rb_intern("flatten"), 0 );
+        for(unsigned long index = 0; index < dataSize; index++)
+        {
+                sf::Uint8 val = NUM2CHR( rb_ary_entry( pixels, index ) );
+                tempData[index] = val;
+        }
+        
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetIcon( rawWidth, rawHeight, tempData );
+        delete[] tempData;
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000053.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000053.html new file mode 100644 index 00000000..9e769d08 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000053.html @@ -0,0 +1,30 @@ + + + + + + setJoystickThreshold (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setJoystickThreshold( new_threshold )
+ *
+ * Change the joystick threshold.
+ *
+ * The joystick threshold is the value below which no JoyMoved event will be generated.
+ *
+ * The threshold value is 0.1 by default. The threshold has to be in the range 0..100
+ */
+static VALUE Window_SetJoystickThreshold( VALUE self, VALUE aThreshold )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetJoystickThreshold( rb_float_new( aThreshold ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000054.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000054.html new file mode 100644 index 00000000..135f54e9 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000054.html @@ -0,0 +1,29 @@ + + + + + + setPosition (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setPosition( new_x, new_y )
+ *
+ * Change the position of the window on screen.
+ *
+ * This function only works for top-level windows (i.e. it will be ignored for windows created from the handle of a 
+ * child window/control).
+ */
+static VALUE Window_SetPosition( VALUE self, VALUE aX, VALUE aY )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetPosition( FIX2INT( aX ), FIX2INT( aY ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000055.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000055.html new file mode 100644 index 00000000..cd4aec1c --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000055.html @@ -0,0 +1,32 @@ + + + + + + position= (SFML::Window) + + + + + 
/* call-seq:
+ *   window.position=( vector2 )
+ *
+ * Change the position of the window on screen.
+ *
+ * This function only works for top-level windows (i.e. it will be ignored for windows created from the handle of a 
+ * child window/control).
+ */
+static VALUE Window_SetPosition2( VALUE self, VALUE anArgument )
+{
+        VALUE argument = Vector2_ForceType( anArgument );
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        VALUE argumentX = rb_funcall( argument, rb_intern( "x" ), 0 );
+        VALUE argumentY = rb_funcall( argument, rb_intern( "y" ), 0 );
+        object->SetPosition( FIX2UINT( argumentX ), FIX2INT( argumentY ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000056.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000056.html new file mode 100644 index 00000000..6d8817c3 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000056.html @@ -0,0 +1,26 @@ + + + + + + setSize (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setSize( new_width, new_height )
+ *
+ * Change the size of the rendering region of the window. 
+ */
+static VALUE Window_SetSize( VALUE self, VALUE aWidth, VALUE aHeight )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetSize( FIX2UINT( aWidth ), FIX2UINT( aHeight ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000057.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000057.html new file mode 100644 index 00000000..43d63186 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000057.html @@ -0,0 +1,29 @@ + + + + + + size= (SFML::Window) + + + + + 
/* call-seq:
+ *   window.size=( vector2 )
+ *
+ * Change the size of the rendering region of the window. 
+ */
+static VALUE Window_SetSize2( VALUE self, VALUE anArgument )
+{
+        VALUE argument = Vector2_ForceType( anArgument );
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        VALUE argumentX = rb_funcall( argument, rb_intern( "x" ), 0 );
+        VALUE argumentY = rb_funcall( argument, rb_intern( "y" ), 0 );
+        object->SetSize( FIX2UINT( argumentX ), FIX2UINT( argumentY ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000058.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000058.html new file mode 100644 index 00000000..2e899675 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000058.html @@ -0,0 +1,26 @@ + + + + + + setTitle (SFML::Window) + + + + + 
/* call-seq:
+ *   window.setTitle( new_title )
+ *
+ * Change the title of the window. 
+ */
+static VALUE Window_SetTitle( VALUE self, VALUE aTitle )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        object->SetTitle( rb_string_value_cstr( &aTitle ) );
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000059.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000059.html new file mode 100644 index 00000000..72c4d73f --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000059.html @@ -0,0 +1,39 @@ + + + + + + show (SFML::Window) + + + + + 
/* call-seq:
+ *   window.show( show )
+ *
+ * Show or hide the window.
+ *
+ * The window is shown by default. 
+ */
+static VALUE Window_Show( VALUE self, VALUE aShowFlag )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        if( aShowFlag == Qfalse )
+        {
+                object->Show( false );
+        }
+        else if( aShowFlag == Qtrue )
+        {
+                object->Show( true );
+        }
+        else
+        {
+                rb_raise( rb_eTypeError, "Expected true or false" );
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000060.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000060.html new file mode 100644 index 00000000..eac4e341 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000060.html @@ -0,0 +1,39 @@ + + + + + + showMouseCursor (SFML::Window) + + + + + 
/* call-seq:
+ *   window.showMouseCursor( show )
+ *
+ * Show or hide the mouse cursor.
+ *
+ * The mouse cursor is shown by default.
+ */
+static VALUE Window_ShowMouseCursor( VALUE self, VALUE aShowFlag )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        if( aShowFlag == Qfalse )
+        {
+                object->ShowMouseCursor( false );
+        }
+        else if( aShowFlag == Qtrue )
+        {
+                object->ShowMouseCursor( true );
+        }
+        else
+        {
+                rb_raise( rb_eTypeError, "Expected true or false" );
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000061.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000061.html new file mode 100644 index 00000000..73474cc0 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000061.html @@ -0,0 +1,43 @@ + + + + + + useVerticalSync (SFML::Window) + + + + + 
/* call-seq:
+ *   window.useVerticalSync( enabled )
+ *
+ * Enable or disable vertical synchronization.
+ *
+ * Activating vertical synchronization will limit the number of frames displayed to the refresh rate of the monitor. 
+ * This can avoid some visual artifacts, and limit the framerate to a good value (but not constant across different 
+ * computers).
+ *
+ * Vertical synchronization is disabled by default.
+ */
+static VALUE Window_UseVerticalSync( VALUE self, VALUE aEnableFlag )
+{
+        sf::Window *object = NULL;
+        Data_Get_Struct( self, sf::Window, object );
+        if( aEnableFlag == Qfalse )
+        {
+                object->UseVerticalSync( false );
+        }
+        else if( aEnableFlag == Qtrue )
+        {
+                object->UseVerticalSync( true );
+        }
+        else
+        {
+                rb_raise( rb_eTypeError, "Expected true or false" );
+        }
+        return Qnil;
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000062.html b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000062.html new file mode 100644 index 00000000..e4f0ce67 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/classes/SFML/Window.src/M000062.html @@ -0,0 +1,42 @@ + + + + + + waitEvent (SFML::Window) + + + + + 
/* call-seq:
+ *   window.waitEvent() -> event or nil
+ *
+ * Wait for an event and return it.
+ *
+ * This function is blocking: if there's no pending event then it will wait until an event is received. After this 
+ * function returns (and no error occured), the event object is always valid and filled properly. This function is 
+ * typically used when you have a thread that is dedicated to events handling: you want to make this thread sleep as 
+ * long as no new event is received. 
+ */
+static VALUE Window_WaitEvent( VALUE self )
+{
+        sf::Event event;
+        sf::Window *window = NULL;
+        Data_Get_Struct( self, sf::Window, window );
+        if( window->WaitEvent( event ) == true )
+        {
+                VALUE rbObject = rb_funcall( globalEventClass, rb_intern( "new" ), 1, INT2FIX( event.Type ) );
+                sf::Event *rubyRawEvent = NULL;
+                Data_Get_Struct( rbObject, sf::Event, rubyRawEvent );
+                *rubyRawEvent = event;
+                return rbObject;
+        }
+        else
+        {
+                return Qnil;
+        }      
+}
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/created.rid b/bindings/ruby/sfml-window/doc/created.rid new file mode 100644 index 00000000..1afe1811 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/created.rid @@ -0,0 +1 @@ +Tue, 16 Nov 2010 17:23:56 +0100 diff --git a/bindings/ruby/sfml-window/doc/files/extconf_rb.html b/bindings/ruby/sfml-window/doc/files/extconf_rb.html new file mode 100644 index 00000000..92590830 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/extconf_rb.html @@ -0,0 +1,137 @@ + + + + + + File: extconf.rb + + + + + + + + + + +
+

extconf.rb

+ + + + + + + + + +
Path:extconf.rb +
Last Update:Tue Nov 16 09:57:47 +0100 2010
+
+ + +
+ + + +
+ +
+

+rbSFML - Copyright (c) 2010 Henrik Valter Vogelius Hansson - +groogy@groogy.se This software is provided ‘as-is’, without any +express or implied warranty. In no event will the authors be held liable +for any damages arising from the use of this software. +

+

+Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: +

+
    +
  1. The origin of this software must not be misrepresented; you must not claim +that you wrote the original software. If you use this software in a +product, an acknowledgment in the product documentation would be +appreciated but is not required. + +
    2. +
  2. Altered source versions must be plainly marked as such, and must not be +misrepresented as being the original software. + +
    3. +
  3. This notice may not be removed or altered from any source distribution. + +
    4. +
+ +
+ +
+

Required files

+ +
+ mkmf   +
+
+ +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/ContextSettings_cpp.html b/bindings/ruby/sfml-window/doc/files/window/ContextSettings_cpp.html new file mode 100644 index 00000000..dcc13838 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/ContextSettings_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: ContextSettings.cpp + + + + + + + + + + +
+

ContextSettings.cpp

+ + + + + + + + + +
Path:window/ContextSettings.cpp +
Last Update:Tue Nov 16 15:51:52 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/Context_cpp.html b/bindings/ruby/sfml-window/doc/files/window/Context_cpp.html new file mode 100644 index 00000000..55480a80 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/Context_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Context.cpp + + + + + + + + + + +
+

Context.cpp

+ + + + + + + + + +
Path:window/Context.cpp +
Last Update:Tue Nov 16 15:52:05 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/Event_cpp.html b/bindings/ruby/sfml-window/doc/files/window/Event_cpp.html new file mode 100644 index 00000000..8ffc205f --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/Event_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Event.cpp + + + + + + + + + + +
+

Event.cpp

+ + + + + + + + + +
Path:window/Event.cpp +
Last Update:Tue Nov 16 16:59:49 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/Input_cpp.html b/bindings/ruby/sfml-window/doc/files/window/Input_cpp.html new file mode 100644 index 00000000..3a4b136e --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/Input_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Input.cpp + + + + + + + + + + +
+

Input.cpp

+ + + + + + + + + +
Path:window/Input.cpp +
Last Update:Tue Nov 16 15:49:22 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/VideoMode_cpp.html b/bindings/ruby/sfml-window/doc/files/window/VideoMode_cpp.html new file mode 100644 index 00000000..1599ad7f --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/VideoMode_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: VideoMode.cpp + + + + + + + + + + +
+

VideoMode.cpp

+ + + + + + + + + +
Path:window/VideoMode.cpp +
Last Update:Tue Nov 16 15:49:43 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/Window_cpp.html b/bindings/ruby/sfml-window/doc/files/window/Window_cpp.html new file mode 100644 index 00000000..0aa2bfca --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/Window_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: Window.cpp + + + + + + + + + + +
+

Window.cpp

+ + + + + + + + + +
Path:window/Window.cpp +
Last Update:Tue Nov 16 15:52:14 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/files/window/main_cpp.html b/bindings/ruby/sfml-window/doc/files/window/main_cpp.html new file mode 100644 index 00000000..fed049d5 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/files/window/main_cpp.html @@ -0,0 +1,101 @@ + + + + + + File: main.cpp + + + + + + + + + + +
+

main.cpp

+ + + + + + + + + +
Path:window/main.cpp +
Last Update:Tue Nov 16 17:09:07 +0100 2010
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/fr_class_index.html b/bindings/ruby/sfml-window/doc/fr_class_index.html new file mode 100644 index 00000000..a96020ef --- /dev/null +++ b/bindings/ruby/sfml-window/doc/fr_class_index.html @@ -0,0 +1,45 @@ + + + + + + + + Classes + + + + + +
+

Classes

+ +
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/fr_file_index.html b/bindings/ruby/sfml-window/doc/fr_file_index.html new file mode 100644 index 00000000..51a1836b --- /dev/null +++ b/bindings/ruby/sfml-window/doc/fr_file_index.html @@ -0,0 +1,34 @@ + + + + + + + + Files + + + + + +
+

Files

+ +
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/fr_method_index.html b/bindings/ruby/sfml-window/doc/fr_method_index.html new file mode 100644 index 00000000..9539fc9e --- /dev/null +++ b/bindings/ruby/sfml-window/doc/fr_method_index.html @@ -0,0 +1,169 @@ + + + + + + + + Methods + + + + + +
+

Methods

+
+ active= (SFML::Context)
+ active= (SFML::Window)
+ alt (SFML::Event::Key)
+ antialiasing (SFML::ContextSettings)
+ antialiasing= (SFML::ContextSettings)
+ antialiasingLevel (SFML::ContextSettings)
+ antialiasingLevel= (SFML::ContextSettings)
+ antialiasing_level (SFML::ContextSettings)
+ antialiasing_level= (SFML::ContextSettings)
+ axis (SFML::Event::JoyMove)
+ bitsPerPixel (SFML::VideoMode)
+ bitsPerPixel= (SFML::VideoMode)
+ bits_per_pixel (SFML::VideoMode)
+ bits_per_pixel= (SFML::VideoMode)
+ bpp (SFML::VideoMode)
+ bpp= (SFML::VideoMode)
+ button (SFML::Event::MouseButton)
+ button (SFML::Event::JoyButton)
+ close (SFML::Window)
+ code (SFML::Event::Key)
+ control (SFML::Event::Key)
+ create (SFML::Window)
+ cursorPosition= (SFML::Window)
+ cursor_position= (SFML::Window)
+ delta (SFML::Event::MouseWheel)
+ depth (SFML::ContextSettings)
+ depth= (SFML::ContextSettings)
+ depthBits (SFML::ContextSettings)
+ depthBits= (SFML::ContextSettings)
+ depth_bits (SFML::ContextSettings)
+ depth_bits= (SFML::ContextSettings)
+ display (SFML::Window)
+ enableKeyRepeat (SFML::Window)
+ framerate= (SFML::Window)
+ framerateLimit= (SFML::Window)
+ framerate_limit= (SFML::Window)
+ getDesktopMode (SFML::VideoMode)
+ getEvent (SFML::Window)
+ getFullscreenModes (SFML::VideoMode)
+ getHeight (SFML::Window)
+ getInput (SFML::Window)
+ getJoystickAxis (SFML::Input)
+ getMouseX (SFML::Input)
+ getMouseY (SFML::Input)
+ getSettings (SFML::Window)
+ getWidth (SFML::Window)
+ get_event (SFML::Window)
+ height (SFML::VideoMode)
+ height (SFML::Event::Size)
+ height (SFML::Window)
+ height= (SFML::VideoMode)
+ input (SFML::Window)
+ isJoystickButtonDown (SFML::Input)
+ isKeyDown (SFML::Input)
+ isMouseButtonDown (SFML::Input)
+ isOpened (SFML::Window)
+ joystickAxis (SFML::Input)
+ joystickButtonDown? (SFML::Input)
+ joystickId (SFML::Event::JoyButton)
+ joystickId (SFML::Event::JoyMove)
+ joystickThreshold= (SFML::Window)
+ joystick_axis (SFML::Input)
+ joystick_button_down? (SFML::Input)
+ joystick_threshold= (SFML::Window)
+ keyDown? (SFML::Input)
+ keyRepeat= (SFML::Window)
+ key_down? (SFML::Input)
+ key_repeat= (SFML::Window)
+ major (SFML::ContextSettings)
+ major= (SFML::ContextSettings)
+ majorVersion (SFML::ContextSettings)
+ majorVersion= (SFML::ContextSettings)
+ major_version (SFML::ContextSettings)
+ major_version= (SFML::ContextSettings)
+ minor (SFML::ContextSettings)
+ minor= (SFML::ContextSettings)
+ minorVersion (SFML::ContextSettings)
+ minorVersion= (SFML::ContextSettings)
+ minor_version (SFML::ContextSettings)
+ minor_version= (SFML::ContextSettings)
+ mouseButtonDown? (SFML::Input)
+ mouseX (SFML::Input)
+ mouseY (SFML::Input)
+ mouse_button_down? (SFML::Input)
+ mouse_x (SFML::Input)
+ mouse_y (SFML::Input)
+ new (SFML::Input)
+ new (SFML::VideoMode)
+ new (SFML::Event)
+ new (SFML::ContextSettings)
+ new (SFML::Event)
+ new (SFML::Context)
+ open? (SFML::Window)
+ opened? (SFML::Window)
+ position (SFML::Event::JoyMove)
+ position= (SFML::Window)
+ setActive (SFML::Window)
+ setActive (SFML::Context)
+ setCursorPosition (SFML::Window)
+ setFramerateLimit (SFML::Window)
+ setIcon (SFML::Window)
+ setJoystickThreshold (SFML::Window)
+ setPosition (SFML::Window)
+ setReferenceActive (SFML::Context)
+ setSize (SFML::Window)
+ setTitle (SFML::Window)
+ set_active (SFML::Context)
+ set_cursor_position (SFML::Window)
+ set_icon (SFML::Window)
+ set_position (SFML::Window)
+ set_size (SFML::Window)
+ settings (SFML::Window)
+ shift (SFML::Event::Key)
+ show (SFML::Window)
+ showMouseCursor (SFML::Window)
+ showMouseCursor= (SFML::Window)
+ show_mouse_cursor (SFML::Window)
+ show_mouse_cursor= (SFML::Window)
+ size= (SFML::Window)
+ stencil (SFML::ContextSettings)
+ stencil= (SFML::ContextSettings)
+ stencilBits (SFML::ContextSettings)
+ stencilBits= (SFML::ContextSettings)
+ stencil_bits (SFML::ContextSettings)
+ stencil_bits= (SFML::ContextSettings)
+ title= (SFML::Window)
+ unicode (SFML::Event::Text)
+ useVerticalSync (SFML::Window)
+ useVerticalSync= (SFML::Window)
+ use_vertical_sync (SFML::Window)
+ use_vertical_sync= (SFML::Window)
+ waitEvent (SFML::Window)
+ wait_event (SFML::Window)
+ width (SFML::Window)
+ width (SFML::VideoMode)
+ width (SFML::Event::Size)
+ width= (SFML::VideoMode)
+ x (SFML::Event::MouseMove)
+ x (SFML::Event::MouseButton)
+ x (SFML::Event::MouseWheel)
+ y (SFML::Event::MouseMove)
+ y (SFML::Event::MouseWheel)
+ y (SFML::Event::MouseButton)
+
+
+ + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/index.html b/bindings/ruby/sfml-window/doc/index.html new file mode 100644 index 00000000..0c2bc984 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/index.html @@ -0,0 +1,24 @@ + + + + + + + RDoc Documentation + + + + + + + + + + + \ No newline at end of file diff --git a/bindings/ruby/sfml-window/doc/rdoc-style.css b/bindings/ruby/sfml-window/doc/rdoc-style.css new file mode 100644 index 00000000..44c7b3d1 --- /dev/null +++ b/bindings/ruby/sfml-window/doc/rdoc-style.css @@ -0,0 +1,208 @@ + +body { + font-family: Verdana,Arial,Helvetica,sans-serif; + font-size: 90%; + margin: 0; + margin-left: 40px; + padding: 0; + background: white; +} + +h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; } +h1 { font-size: 150%; } +h2,h3,h4 { margin-top: 1em; } + +a { background: #eef; color: #039; text-decoration: none; } +a:hover { background: #039; color: #eef; } + +/* Override the base stylesheet's Anchor inside a table cell */ +td > a { + background: transparent; + color: #039; + text-decoration: none; +} + +/* and inside a section title */ +.section-title > a { + background: transparent; + color: #eee; + text-decoration: none; +} + +/* === Structural elements =================================== */ + +div#index { + margin: 0; + margin-left: -40px; + padding: 0; + font-size: 90%; +} + + +div#index a { + margin-left: 0.7em; +} + +div#index .section-bar { + margin-left: 0px; + padding-left: 0.7em; + background: #ccc; + font-size: small; +} + + +div#classHeader, div#fileHeader { + width: auto; + color: white; + padding: 0.5em 1.5em 0.5em 1.5em; + margin: 0; + margin-left: -40px; + border-bottom: 3px solid #006; +} + +div#classHeader a, div#fileHeader a { + background: inherit; + color: white; +} + +div#classHeader td, div#fileHeader td { + background: inherit; + color: white; +} + + +div#fileHeader { + background: #057; +} + +div#classHeader { + background: #048; +} + + +.class-name-in-header { + font-size: 180%; + font-weight: bold; +} + + +div#bodyContent { + padding: 0 1.5em 0 1.5em; +} + +div#description { + padding: 0.5em 1.5em; + background: #efefef; + border: 1px dotted #999; +} + +div#description h1,h2,h3,h4,h5,h6 { + color: #125;; + background: transparent; +} + +div#validator-badges { + text-align: center; +} +div#validator-badges img { border: 0; } + +div#copyright { + color: #333; + background: #efefef; + font: 0.75em sans-serif; + margin-top: 5em; + margin-bottom: 0; + padding: 0.5em 2em; +} + + +/* === Classes =================================== */ + +table.header-table { + color: white; + font-size: small; +} + +.type-note { + font-size: small; + color: #DEDEDE; +} + +.xxsection-bar { + background: #eee; + color: #333; + padding: 3px; +} + +.section-bar { + color: #333; + border-bottom: 1px solid #999; + margin-left: -20px; +} + + +.section-title { + background: #79a; + color: #eee; + padding: 3px; + margin-top: 2em; + margin-left: -30px; + border: 1px solid #999; +} + +.top-aligned-row { vertical-align: top } +.bottom-aligned-row { vertical-align: bottom } + +/* --- Context section classes ----------------------- */ + +.context-row { } +.context-item-name { font-family: monospace; font-weight: bold; color: black; } +.context-item-value { font-size: small; color: #448; } +.context-item-desc { color: #333; padding-left: 2em; } + +/* --- Method classes -------------------------- */ +.method-detail { + background: #efefef; + padding: 0; + margin-top: 0.5em; + margin-bottom: 1em; + border: 1px dotted #ccc; +} +.method-heading { + color: black; + background: #ccc; + border-bottom: 1px solid #666; + padding: 0.2em 0.5em 0 0.5em; +} +.method-signature { color: black; background: inherit; } +.method-name { font-weight: bold; } +.method-args { font-style: italic; } +.method-description { padding: 0 0.5em 0 0.5em; } + +/* --- Source code sections -------------------- */ + +a.source-toggle { font-size: 90%; } +div.method-source-code { + background: #262626; + color: #ffdead; + margin: 1em; + padding: 0.5em; + border: 1px dashed #999; + overflow: hidden; +} + +div.method-source-code pre { color: #ffdead; overflow: hidden; } + +/* --- Ruby keyword styles --------------------- */ + +.standalone-code { background: #221111; color: #ffdead; overflow: hidden; } + +.ruby-constant { color: #7fffd4; background: transparent; } +.ruby-keyword { color: #00ffff; background: transparent; } +.ruby-ivar { color: #eedd82; background: transparent; } +.ruby-operator { color: #00ffee; background: transparent; } +.ruby-identifier { color: #ffdead; background: transparent; } +.ruby-node { color: #ffa07a; background: transparent; } +.ruby-comment { color: #b22222; font-weight: bold; background: transparent; } +.ruby-regexp { color: #ffa07a; background: transparent; } +.ruby-value { color: #7fffd4; background: transparent; } \ No newline at end of file