From af202195872d59432cb74db74696bf1e57906663 Mon Sep 17 00:00:00 2001 From: Christoph Egger Date: Sun, 14 Jun 2009 21:52:32 +0200 Subject: Imported Upstream version 1.5+repack1 --- doc/SFML.chm | Bin 763345 -> 1837319 bytes doc/html/AppController_8h-source.htm | 96 + doc/html/AppController_8mm-source.htm | 551 + doc/html/Arial_8hpp-source.htm | 14721 +++++++++++++++++++ doc/html/AudioDevice_8cpp-source.htm | 180 + doc/html/AudioDevice_8hpp-source.htm | 110 + doc/html/AudioResource_8cpp-source.htm | 84 + doc/html/AudioResource_8hpp-source.htm | 39 +- doc/html/Audio_8hpp-source.htm | 29 +- doc/html/Clock_8cpp-source.htm | 84 + doc/html/Clock_8hpp-source.htm | 33 +- doc/html/Cocoa_2Joystick_8cpp-source.htm | 99 + doc/html/Cocoa_2Joystick_8hpp-source.htm | 88 + doc/html/Cocoa_2VideoModeSupport_8cpp-source.htm | 128 + doc/html/Cocoa_2VideoModeSupport_8hpp-source.htm | 86 + doc/html/Color_8cpp-source.htm | 149 + doc/html/Color_8hpp-source.htm | 63 +- doc/html/Config_8hpp-source.htm | 214 +- doc/html/Context_8cpp-source.htm | 105 + doc/html/Context_8hpp-source.htm | 37 +- doc/html/Doxygen_8hpp-source.htm | 27 +- doc/html/Drawable_8cpp-source.htm | 333 + doc/html/Drawable_8hpp-source.htm | 63 +- doc/html/Event_8hpp-source.htm | 311 +- doc/html/FontLoader_8cpp-source.htm | 433 + doc/html/FontLoader_8hpp-source.htm | 106 + doc/html/Font_8cpp-source.htm | 186 + doc/html/Font_8hpp-source.htm | 35 +- doc/html/Ftp_8cpp-source.htm | 629 + doc/html/Ftp_8hpp-source.htm | 167 +- doc/html/GLKit_8h-source.htm | 150 + doc/html/GLKit_8mm-source.htm | 738 + doc/html/Glyph_8hpp-source.htm | 37 +- doc/html/GraphicsContext_8cpp-source.htm | 117 + doc/html/GraphicsContext_8hpp-source.htm | 181 + doc/html/Graphics_8hpp-source.htm | 29 +- doc/html/Http_8cpp-source.htm | 385 + doc/html/Http_8hpp-source.htm | 121 +- doc/html/IPAddress_8cpp-source.htm | 273 + doc/html/IPAddress_8hpp-source.htm | 101 +- doc/html/ImageLoader_8cpp-source.htm | 338 + doc/html/ImageLoader_8hpp-source.htm | 102 + doc/html/ImageUpdater_8hpp-source.htm | 87 + doc/html/Image_8cpp-source.htm | 724 + doc/html/Image_8hpp-source.htm | 151 +- doc/html/Initializer_8cpp-source.htm | 109 + doc/html/Input_8cpp-source.htm | 178 + doc/html/Input_8hpp-source.htm | 43 +- doc/html/Joystick_8hpp-source.htm | 100 + doc/html/Listener_8cpp-source.htm | 124 + doc/html/Listener_8hpp-source.htm | 31 +- doc/html/Lock_8cpp-source.htm | 79 + doc/html/Lock_8hpp-source.htm | 35 +- doc/html/Matrix3_8cpp-source.htm | 71 + doc/html/Matrix3_8hpp-source.htm | 47 +- doc/html/Matrix3_8inl-source.htm | 47 +- doc/html/Music_8cpp-source.htm | 165 + doc/html/Music_8hpp-source.htm | 37 +- doc/html/Mutex_8cpp-source.htm | 89 + doc/html/Mutex_8hpp-source.htm | 29 +- doc/html/Network_8hpp-source.htm | 29 +- doc/html/NonCopyable_8hpp-source.htm | 37 +- doc/html/OpenAL_8hpp-source.htm | 156 + doc/html/OpenGL_8hpp-source.htm | 67 +- doc/html/Packet_8cpp-source.htm | 418 + doc/html/Packet_8hpp-source.htm | 91 +- doc/html/Platform_8cpp-source.htm | 97 + doc/html/Platform_8hpp-source.htm | 78 + doc/html/PostFX_8cpp-source.htm | 493 + doc/html/PostFX_8hpp-source.htm | 39 +- doc/html/Randomizer_8cpp-source.htm | 114 + doc/html/Randomizer_8hpp-source.htm | 31 +- doc/html/Rect_8hpp-source.htm | 39 +- doc/html/Rect_8inl-source.htm | 33 +- doc/html/RenderImageImplFBO_8cpp-source.htm | 201 + doc/html/RenderImageImplFBO_8hpp-source.htm | 97 + doc/html/RenderImageImplPBuffer_8cpp-source.htm | 242 + doc/html/RenderImageImplPBuffer_8hpp-source.htm | 79 + doc/html/RenderImageImpl_8cpp-source.htm | 82 + doc/html/RenderImageImpl_8hpp-source.htm | 96 + doc/html/RenderImage_8cpp-source.htm | 163 + doc/html/RenderImage_8hpp-source.htm | 108 + doc/html/RenderTarget_8cpp-source.htm | 189 + doc/html/RenderTarget_8hpp-source.htm | 35 +- doc/html/RenderWindow_8cpp-source.htm | 170 + doc/html/RenderWindow_8hpp-source.htm | 41 +- doc/html/ResourcePtr_8inl-source.htm | 45 +- doc/html/Resource_8hpp-source.htm | 47 +- doc/html/Resource_8inl-source.htm | 33 +- doc/html/SFML__Main_8cpp-source.htm | 77 + doc/html/SelectorBase_8cpp-source.htm | 143 + doc/html/SelectorBase_8hpp-source.htm | 39 +- doc/html/Selector_8hpp-source.htm | 33 +- doc/html/Selector_8inl-source.htm | 47 +- doc/html/Shape_8cpp-source.htm | 381 + doc/html/Shape_8hpp-source.htm | 59 +- doc/html/Sleep_8cpp-source.htm | 73 + doc/html/Sleep_8hpp-source.htm | 31 +- doc/html/SocketHelper_8cpp-source.htm | 119 + doc/html/SocketHelper_8hpp-source.htm | 41 +- doc/html/SocketTCP_8cpp-source.htm | 468 + doc/html/SocketTCP_8hpp-source.htm | 59 +- doc/html/SocketUDP_8cpp-source.htm | 409 + doc/html/SocketUDP_8hpp-source.htm | 105 +- doc/html/Sockets_8hpp-source.htm | 29 +- doc/html/SoundBufferRecorder_8cpp-source.htm | 96 + doc/html/SoundBufferRecorder_8hpp-source.htm | 31 +- doc/html/SoundBuffer_8cpp-source.htm | 298 + doc/html/SoundBuffer_8hpp-source.htm | 41 +- doc/html/SoundFileDefault_8cpp-source.htm | 350 + doc/html/SoundFileDefault_8hpp-source.htm | 121 + doc/html/SoundFileOgg_8cpp-source.htm | 194 + doc/html/SoundFileOgg_8hpp-source.htm | 103 + doc/html/SoundFile_8cpp-source.htm | 262 + doc/html/SoundFile_8hpp-source.htm | 122 + doc/html/SoundRecorder_8cpp-source.htm | 222 + doc/html/SoundRecorder_8hpp-source.htm | 35 +- doc/html/SoundStream_8cpp-source.htm | 332 + doc/html/SoundStream_8hpp-source.htm | 161 +- doc/html/Sound_8cpp-source.htm | 299 + doc/html/Sound_8hpp-source.htm | 117 +- doc/html/Sprite_8cpp-source.htm | 213 + doc/html/Sprite_8hpp-source.htm | 47 +- doc/html/String_8cpp-source.htm | 400 + doc/html/String_8hpp-source.htm | 41 +- doc/html/System_8hpp-source.htm | 29 +- ...e_01for_01new_01ports_2Joystick_8cpp-source.htm | 95 + ...e_01for_01new_01ports_2Joystick_8hpp-source.htm | 88 + ...01new_01ports_2VideoModeSupport_8cpp-source.htm | 87 + ...01new_01ports_2VideoModeSupport_8hpp-source.htm | 86 + doc/html/Thread_8cpp-source.htm | 150 + doc/html/Thread_8hpp-source.htm | 29 +- doc/html/Unicode_8cpp-source.htm | 313 + doc/html/Unicode_8hpp-source.htm | 65 +- doc/html/Unicode_8inl-source.htm | 35 +- doc/html/Vector2_8hpp-source.htm | 57 +- doc/html/Vector2_8inl-source.htm | 53 +- doc/html/Vector3_8hpp-source.htm | 57 +- doc/html/Vector3_8inl-source.htm | 55 +- doc/html/VideoModeSupport_8hpp-source.htm | 82 + doc/html/VideoMode_8cpp-source.htm | 172 + doc/html/VideoMode_8hpp-source.htm | 43 +- doc/html/View_8cpp-source.htm | 196 + doc/html/View_8hpp-source.htm | 57 +- doc/html/Win32_2Joystick_8cpp-source.htm | 159 + doc/html/Win32_2Joystick_8hpp-source.htm | 95 + doc/html/Win32_2Mutex_8hpp-source.htm | 35 +- doc/html/Win32_2Platform_8hpp-source.htm | 86 + .../Win32_2RenderImageImplPBuffer_8hpp-source.htm | 106 + doc/html/Win32_2SocketHelper_8hpp-source.htm | 37 +- doc/html/Win32_2Thread_8hpp-source.htm | 35 +- doc/html/Win32_2VideoModeSupport_8cpp-source.htm | 101 + doc/html/Win32_2VideoModeSupport_8hpp-source.htm | 86 + doc/html/WindowController_8h-source.htm | 87 + doc/html/WindowController_8mm-source.htm | 164 + doc/html/WindowHandle_8hpp-source.htm | 33 +- doc/html/WindowImplCocoa_8hpp-source.htm | 147 + doc/html/WindowImplCocoa_8mm-source.htm | 769 + doc/html/WindowImplWin32_8cpp-source.htm | 1110 ++ doc/html/WindowImplWin32_8hpp-source.htm | 151 + doc/html/WindowImplXXX_8cpp-source.htm | 215 + doc/html/WindowImplXXX_8hpp-source.htm | 118 + doc/html/WindowImpl_8cpp-source.htm | 242 + doc/html/WindowImpl_8hpp-source.htm | 164 + doc/html/WindowListener_8hpp-source.htm | 33 +- doc/html/WindowSettings_8hpp-source.htm | 29 +- doc/html/WindowStyle_8hpp-source.htm | 29 +- doc/html/Window_2Window_8hpp-source.htm | 39 +- doc/html/Window_8cpp-source.htm | 406 + doc/html/Window_8hpp-source.htm | 29 +- doc/html/annotated.htm | 72 +- doc/html/classGLContext-members.htm | 45 + doc/html/classGLView-members.htm | 49 + doc/html/classWindowController-members.htm | 49 + doc/html/classWindowWrapper-members.htm | 59 + doc/html/classes.htm | 70 +- doc/html/classsf_1_1AudioResource-members.htm | 40 +- doc/html/classsf_1_1AudioResource.htm | 78 +- doc/html/classsf_1_1Clock-members.htm | 40 +- doc/html/classsf_1_1Clock.htm | 70 +- doc/html/classsf_1_1Color-members.htm | 42 +- doc/html/classsf_1_1Color.htm | 232 +- doc/html/classsf_1_1Context-members.htm | 42 +- doc/html/classsf_1_1Context.htm | 120 +- doc/html/classsf_1_1Context.png | Bin 419 -> 419 bytes doc/html/classsf_1_1Drawable-members.htm | 58 +- doc/html/classsf_1_1Drawable.htm | 696 +- doc/html/classsf_1_1Drawable.png | Bin 763 -> 763 bytes doc/html/classsf_1_1Event-members.htm | 86 +- doc/html/classsf_1_1Event.htm | 190 +- doc/html/classsf_1_1Font-members.htm | 46 +- doc/html/classsf_1_1Font.htm | 282 +- doc/html/classsf_1_1Font.png | Bin 402 -> 402 bytes doc/html/classsf_1_1Ftp-members.htm | 70 +- doc/html/classsf_1_1Ftp.htm | 455 +- doc/html/classsf_1_1Ftp.png | Bin 396 -> 396 bytes ...classsf_1_1Ftp_1_1DirectoryResponse-members.htm | 140 +- doc/html/classsf_1_1Ftp_1_1DirectoryResponse.htm | 313 +- doc/html/classsf_1_1Ftp_1_1DirectoryResponse.png | Bin 530 -> 554 bytes .../classsf_1_1Ftp_1_1ListingResponse-members.htm | 142 +- doc/html/classsf_1_1Ftp_1_1ListingResponse.htm | 325 +- doc/html/classsf_1_1Ftp_1_1ListingResponse.png | Bin 507 -> 524 bytes doc/html/classsf_1_1Ftp_1_1Response-members.htm | 136 +- doc/html/classsf_1_1Ftp_1_1Response.htm | 301 +- doc/html/classsf_1_1Ftp_1_1Response.png | Bin 816 -> 852 bytes doc/html/classsf_1_1Glyph-members.htm | 38 +- doc/html/classsf_1_1Glyph.htm | 66 +- doc/html/classsf_1_1Http-members.htm | 40 +- doc/html/classsf_1_1Http.htm | 146 +- doc/html/classsf_1_1Http.png | Bin 399 -> 399 bytes doc/html/classsf_1_1Http_1_1Request-members.htm | 62 +- doc/html/classsf_1_1Http_1_1Request.htm | 232 +- doc/html/classsf_1_1Http_1_1Response-members.htm | 92 +- doc/html/classsf_1_1Http_1_1Response.htm | 240 +- doc/html/classsf_1_1IPAddress-members.htm | 48 +- doc/html/classsf_1_1IPAddress.htm | 273 +- doc/html/classsf_1_1Image-members.htm | 60 +- doc/html/classsf_1_1Image.htm | 605 +- doc/html/classsf_1_1Image.png | Bin 451 -> 451 bytes doc/html/classsf_1_1Input-members.htm | 44 +- doc/html/classsf_1_1Input.htm | 226 +- doc/html/classsf_1_1Input.png | Bin 607 -> 607 bytes doc/html/classsf_1_1Listener-members.htm | 54 +- doc/html/classsf_1_1Listener.htm | 253 +- doc/html/classsf_1_1Lock-members.htm | 38 +- doc/html/classsf_1_1Lock.htm | 66 +- doc/html/classsf_1_1Lock.png | Bin 399 -> 399 bytes doc/html/classsf_1_1Matrix3-members.htm | 48 +- doc/html/classsf_1_1Matrix3.htm | 270 +- doc/html/classsf_1_1Music-members.htm | 53 +- doc/html/classsf_1_1Music.htm | 389 +- doc/html/classsf_1_1Music.png | Bin 651 -> 651 bytes doc/html/classsf_1_1Mutex-members.htm | 38 +- doc/html/classsf_1_1Mutex.htm | 74 +- doc/html/classsf_1_1Mutex.png | Bin 411 -> 411 bytes doc/html/classsf_1_1Packet-members.htm | 56 +- doc/html/classsf_1_1Packet.htm | 220 +- doc/html/classsf_1_1PostFX-members.htm | 62 +- doc/html/classsf_1_1PostFX.htm | 1068 +- doc/html/classsf_1_1PostFX.png | Bin 369 -> 369 bytes doc/html/classsf_1_1Randomizer-members.htm | 46 +- doc/html/classsf_1_1Randomizer.htm | 158 +- doc/html/classsf_1_1Rect-members.htm | 44 +- doc/html/classsf_1_1Rect.htm | 204 +- doc/html/classsf_1_1RenderImage-members.htm | 60 + doc/html/classsf_1_1RenderImage.htm | 532 + doc/html/classsf_1_1RenderImage.png | Bin 0 -> 662 bytes doc/html/classsf_1_1RenderTarget-members.htm | 50 +- doc/html/classsf_1_1RenderTarget.htm | 196 +- doc/html/classsf_1_1RenderTarget.png | Bin 461 -> 461 bytes doc/html/classsf_1_1RenderWindow-members.htm | 64 +- doc/html/classsf_1_1RenderWindow.htm | 778 +- doc/html/classsf_1_1Resource-members.htm | 40 +- doc/html/classsf_1_1Resource.htm | 58 +- doc/html/classsf_1_1ResourcePtr-members.htm | 44 +- doc/html/classsf_1_1ResourcePtr.htm | 162 +- doc/html/classsf_1_1Selector-members.htm | 38 +- doc/html/classsf_1_1Selector.htm | 155 +- doc/html/classsf_1_1Selector.png | Bin 476 -> 476 bytes doc/html/classsf_1_1SelectorBase-members.htm | 38 +- doc/html/classsf_1_1SelectorBase.htm | 165 +- doc/html/classsf_1_1SelectorBase.png | Bin 477 -> 477 bytes doc/html/classsf_1_1Shape-members.htm | 80 +- doc/html/classsf_1_1Shape.htm | 1417 +- doc/html/classsf_1_1Shape.png | Bin 369 -> 369 bytes doc/html/classsf_1_1SocketHelper-members.htm | 50 +- doc/html/classsf_1_1SocketHelper.htm | 162 +- doc/html/classsf_1_1SocketTCP-members.htm | 42 +- doc/html/classsf_1_1SocketTCP.htm | 405 +- doc/html/classsf_1_1SocketUDP-members.htm | 48 +- doc/html/classsf_1_1SocketUDP.htm | 462 +- doc/html/classsf_1_1Sound-members.htm | 64 +- doc/html/classsf_1_1Sound.htm | 630 +- doc/html/classsf_1_1Sound.png | Bin 673 -> 673 bytes doc/html/classsf_1_1SoundBuffer-members.htm | 56 +- doc/html/classsf_1_1SoundBuffer.htm | 367 +- doc/html/classsf_1_1SoundBuffer.png | Bin 775 -> 775 bytes .../classsf_1_1SoundBufferRecorder-members.htm | 46 +- doc/html/classsf_1_1SoundBufferRecorder.htm | 146 +- doc/html/classsf_1_1SoundBufferRecorder.png | Bin 696 -> 696 bytes doc/html/classsf_1_1SoundRecorder-members.htm | 48 +- doc/html/classsf_1_1SoundRecorder.htm | 160 +- doc/html/classsf_1_1SoundRecorder.png | Bin 694 -> 694 bytes doc/html/classsf_1_1SoundStream-members.htm | 74 +- doc/html/classsf_1_1SoundStream.htm | 359 +- doc/html/classsf_1_1SoundStream.png | Bin 699 -> 699 bytes doc/html/classsf_1_1Sprite-members.htm | 66 +- doc/html/classsf_1_1Sprite.htm | 917 +- doc/html/classsf_1_1Sprite.png | Bin 362 -> 362 bytes doc/html/classsf_1_1String-members.htm | 68 +- doc/html/classsf_1_1String.htm | 863 +- doc/html/classsf_1_1String.png | Bin 368 -> 368 bytes doc/html/classsf_1_1Thread-members.htm | 42 +- doc/html/classsf_1_1Thread.htm | 110 +- doc/html/classsf_1_1Unicode-members.htm | 42 +- doc/html/classsf_1_1Unicode.htm | 681 +- doc/html/classsf_1_1Unicode_1_1Text-members.htm | 72 +- doc/html/classsf_1_1Unicode_1_1Text.htm | 128 +- doc/html/classsf_1_1Vector2-members.htm | 38 +- doc/html/classsf_1_1Vector2.htm | 60 +- doc/html/classsf_1_1Vector3-members.htm | 38 +- doc/html/classsf_1_1Vector3.htm | 64 +- doc/html/classsf_1_1VideoMode-members.htm | 46 +- doc/html/classsf_1_1VideoMode.htm | 157 +- doc/html/classsf_1_1View-members.htm | 46 +- doc/html/classsf_1_1View.htm | 324 +- doc/html/classsf_1_1Window-members.htm | 52 +- doc/html/classsf_1_1Window.htm | 590 +- doc/html/classsf_1_1WindowListener-members.htm | 38 +- doc/html/classsf_1_1WindowListener.htm | 62 +- doc/html/files.htm | 113 +- doc/html/functions.htm | 127 +- doc/html/functions_0x62.htm | 129 +- doc/html/functions_0x63.htm | 171 +- doc/html/functions_0x64.htm | 144 +- doc/html/functions_0x65.htm | 125 +- doc/html/functions_0x66.htm | 137 +- doc/html/functions_0x67.htm | 341 +- doc/html/functions_0x68.htm | 130 +- doc/html/functions_0x69.htm | 160 +- doc/html/functions_0x6b.htm | 126 +- doc/html/functions_0x6c.htm | 140 +- doc/html/functions_0x6d.htm | 155 +- doc/html/functions_0x6e.htm | 140 +- doc/html/functions_0x6f.htm | 177 +- doc/html/functions_0x70.htm | 132 +- doc/html/functions_0x72.htm | 159 +- doc/html/functions_0x73.htm | 230 +- doc/html/functions_0x74.htm | 133 +- doc/html/functions_0x75.htm | 136 +- doc/html/functions_0x76.htm | 122 +- doc/html/functions_0x77.htm | 123 +- doc/html/functions_0x78.htm | 124 +- doc/html/functions_0x79.htm | 124 +- doc/html/functions_0x7a.htm | 118 +- doc/html/functions_0x7e.htm | 136 +- doc/html/functions_enum.htm | 64 +- doc/html/functions_eval.htm | 271 +- doc/html/functions_func.htm | 117 +- doc/html/functions_func_0x62.htm | 115 +- doc/html/functions_func_0x63.htm | 138 +- doc/html/functions_func_0x64.htm | 125 +- doc/html/functions_func_0x65.htm | 118 +- doc/html/functions_func_0x66.htm | 118 +- doc/html/functions_func_0x67.htm | 324 +- doc/html/functions_func_0x68.htm | 113 +- doc/html/functions_func_0x69.htm | 147 +- doc/html/functions_func_0x6b.htm | 115 +- doc/html/functions_func_0x6c.htm | 133 +- doc/html/functions_func_0x6d.htm | 121 +- doc/html/functions_func_0x6e.htm | 113 +- doc/html/functions_func_0x6f.htm | 166 +- doc/html/functions_func_0x70.htm | 115 +- doc/html/functions_func_0x72.htm | 145 +- doc/html/functions_func_0x73.htm | 180 +- doc/html/functions_func_0x74.htm | 119 +- doc/html/functions_func_0x75.htm | 119 +- doc/html/functions_func_0x76.htm | 117 +- doc/html/functions_func_0x77.htm | 118 +- doc/html/functions_func_0x7a.htm | 113 +- doc/html/functions_func_0x7e.htm | 131 +- doc/html/functions_type.htm | 67 +- doc/html/functions_vars.htm | 171 +- doc/html/hierarchy.htm | 72 +- doc/html/index.hhc | 158 +- doc/html/index.hhk | 2469 ++-- doc/html/index.hhp | 101 +- doc/html/index.htm | 26 +- doc/html/interfaceGLContext.htm | 125 + doc/html/interfaceGLView.htm | 219 + doc/html/interfaceGLWindow.htm | 54 + doc/html/interfaceWindowController.htm | 225 + doc/html/interfaceWindowWrapper.htm | 492 + doc/html/namespacemembers.htm | 370 +- doc/html/namespacemembers_enum.htm | 54 +- doc/html/namespacemembers_eval.htm | 336 +- doc/html/namespaces.htm | 36 +- doc/html/namespacesf_1_1Blend.htm | 44 +- doc/html/namespacesf_1_1Joy.htm | 90 +- doc/html/namespacesf_1_1Key.htm | 372 +- doc/html/namespacesf_1_1Mouse.htm | 82 +- doc/html/namespacesf_1_1Style.htm | 44 +- ...structsf_1_1Event_1_1JoyButtonEvent-members.htm | 44 +- doc/html/structsf_1_1Event_1_1JoyButtonEvent.htm | 58 +- .../structsf_1_1Event_1_1JoyMoveEvent-members.htm | 46 +- doc/html/structsf_1_1Event_1_1JoyMoveEvent.htm | 62 +- doc/html/structsf_1_1Event_1_1KeyEvent-members.htm | 48 +- doc/html/structsf_1_1Event_1_1KeyEvent.htm | 66 +- ...ructsf_1_1Event_1_1MouseButtonEvent-members.htm | 46 +- doc/html/structsf_1_1Event_1_1MouseButtonEvent.htm | 62 +- ...structsf_1_1Event_1_1MouseMoveEvent-members.htm | 44 +- doc/html/structsf_1_1Event_1_1MouseMoveEvent.htm | 58 +- ...tructsf_1_1Event_1_1MouseWheelEvent-members.htm | 42 +- doc/html/structsf_1_1Event_1_1MouseWheelEvent.htm | 54 +- .../structsf_1_1Event_1_1SizeEvent-members.htm | 44 +- doc/html/structsf_1_1Event_1_1SizeEvent.htm | 58 +- .../structsf_1_1Event_1_1TextEvent-members.htm | 42 +- doc/html/structsf_1_1Event_1_1TextEvent.htm | 54 +- doc/html/structsf_1_1NonCopyable-members.htm | 38 +- doc/html/structsf_1_1NonCopyable.htm | 60 +- .../structsf_1_1SoundStream_1_1Chunk-members.htm | 44 +- doc/html/structsf_1_1SoundStream_1_1Chunk.htm | 78 +- doc/html/structsf_1_1WindowSettings-members.htm | 38 +- doc/html/structsf_1_1WindowSettings.htm | 84 +- doc/html/tabs.css | 9 +- 405 files changed, 56625 insertions(+), 17635 deletions(-) create mode 100755 doc/html/AppController_8h-source.htm create mode 100755 doc/html/AppController_8mm-source.htm create mode 100755 doc/html/Arial_8hpp-source.htm create mode 100755 doc/html/AudioDevice_8cpp-source.htm create mode 100755 doc/html/AudioDevice_8hpp-source.htm create mode 100755 doc/html/AudioResource_8cpp-source.htm create mode 100755 doc/html/Clock_8cpp-source.htm create mode 100755 doc/html/Cocoa_2Joystick_8cpp-source.htm create mode 100755 doc/html/Cocoa_2Joystick_8hpp-source.htm create mode 100755 doc/html/Cocoa_2VideoModeSupport_8cpp-source.htm create mode 100755 doc/html/Cocoa_2VideoModeSupport_8hpp-source.htm create mode 100755 doc/html/Color_8cpp-source.htm create mode 100755 doc/html/Context_8cpp-source.htm create mode 100755 doc/html/Drawable_8cpp-source.htm create mode 100755 doc/html/FontLoader_8cpp-source.htm create mode 100755 doc/html/FontLoader_8hpp-source.htm create mode 100755 doc/html/Font_8cpp-source.htm create mode 100755 doc/html/Ftp_8cpp-source.htm create mode 100755 doc/html/GLKit_8h-source.htm create mode 100755 doc/html/GLKit_8mm-source.htm create mode 100755 doc/html/GraphicsContext_8cpp-source.htm create mode 100755 doc/html/GraphicsContext_8hpp-source.htm create mode 100755 doc/html/Http_8cpp-source.htm create mode 100755 doc/html/IPAddress_8cpp-source.htm create mode 100755 doc/html/ImageLoader_8cpp-source.htm create mode 100755 doc/html/ImageLoader_8hpp-source.htm create mode 100755 doc/html/ImageUpdater_8hpp-source.htm create mode 100755 doc/html/Image_8cpp-source.htm create mode 100755 doc/html/Initializer_8cpp-source.htm create mode 100755 doc/html/Input_8cpp-source.htm create mode 100755 doc/html/Joystick_8hpp-source.htm create mode 100755 doc/html/Listener_8cpp-source.htm create mode 100755 doc/html/Lock_8cpp-source.htm create mode 100755 doc/html/Matrix3_8cpp-source.htm create mode 100755 doc/html/Music_8cpp-source.htm create mode 100755 doc/html/Mutex_8cpp-source.htm create mode 100755 doc/html/OpenAL_8hpp-source.htm create mode 100755 doc/html/Packet_8cpp-source.htm create mode 100755 doc/html/Platform_8cpp-source.htm create mode 100755 doc/html/Platform_8hpp-source.htm create mode 100755 doc/html/PostFX_8cpp-source.htm create mode 100755 doc/html/Randomizer_8cpp-source.htm create mode 100755 doc/html/RenderImageImplFBO_8cpp-source.htm create mode 100755 doc/html/RenderImageImplFBO_8hpp-source.htm create mode 100755 doc/html/RenderImageImplPBuffer_8cpp-source.htm create mode 100755 doc/html/RenderImageImplPBuffer_8hpp-source.htm create mode 100755 doc/html/RenderImageImpl_8cpp-source.htm create mode 100755 doc/html/RenderImageImpl_8hpp-source.htm create mode 100755 doc/html/RenderImage_8cpp-source.htm create mode 100755 doc/html/RenderImage_8hpp-source.htm create mode 100755 doc/html/RenderTarget_8cpp-source.htm create mode 100755 doc/html/RenderWindow_8cpp-source.htm create mode 100755 doc/html/SFML__Main_8cpp-source.htm create mode 100755 doc/html/SelectorBase_8cpp-source.htm create mode 100755 doc/html/Shape_8cpp-source.htm create mode 100755 doc/html/Sleep_8cpp-source.htm create mode 100755 doc/html/SocketHelper_8cpp-source.htm create mode 100755 doc/html/SocketTCP_8cpp-source.htm create mode 100755 doc/html/SocketUDP_8cpp-source.htm create mode 100755 doc/html/SoundBufferRecorder_8cpp-source.htm create mode 100755 doc/html/SoundBuffer_8cpp-source.htm create mode 100755 doc/html/SoundFileDefault_8cpp-source.htm create mode 100755 doc/html/SoundFileDefault_8hpp-source.htm create mode 100755 doc/html/SoundFileOgg_8cpp-source.htm create mode 100755 doc/html/SoundFileOgg_8hpp-source.htm create mode 100755 doc/html/SoundFile_8cpp-source.htm create mode 100755 doc/html/SoundFile_8hpp-source.htm create mode 100755 doc/html/SoundRecorder_8cpp-source.htm create mode 100755 doc/html/SoundStream_8cpp-source.htm create mode 100755 doc/html/Sound_8cpp-source.htm create mode 100755 doc/html/Sprite_8cpp-source.htm create mode 100755 doc/html/String_8cpp-source.htm create mode 100755 doc/html/Template_01for_01new_01ports_2Joystick_8cpp-source.htm create mode 100755 doc/html/Template_01for_01new_01ports_2Joystick_8hpp-source.htm create mode 100755 doc/html/Template_01for_01new_01ports_2VideoModeSupport_8cpp-source.htm create mode 100755 doc/html/Template_01for_01new_01ports_2VideoModeSupport_8hpp-source.htm create mode 100755 doc/html/Thread_8cpp-source.htm create mode 100755 doc/html/Unicode_8cpp-source.htm create mode 100755 doc/html/VideoModeSupport_8hpp-source.htm create mode 100755 doc/html/VideoMode_8cpp-source.htm create mode 100755 doc/html/View_8cpp-source.htm create mode 100755 doc/html/Win32_2Joystick_8cpp-source.htm create mode 100755 doc/html/Win32_2Joystick_8hpp-source.htm create mode 100755 doc/html/Win32_2Platform_8hpp-source.htm create mode 100755 doc/html/Win32_2RenderImageImplPBuffer_8hpp-source.htm create mode 100755 doc/html/Win32_2VideoModeSupport_8cpp-source.htm create mode 100755 doc/html/Win32_2VideoModeSupport_8hpp-source.htm create mode 100755 doc/html/WindowController_8h-source.htm create mode 100755 doc/html/WindowController_8mm-source.htm create mode 100755 doc/html/WindowImplCocoa_8hpp-source.htm create mode 100755 doc/html/WindowImplCocoa_8mm-source.htm create mode 100755 doc/html/WindowImplWin32_8cpp-source.htm create mode 100755 doc/html/WindowImplWin32_8hpp-source.htm create mode 100755 doc/html/WindowImplXXX_8cpp-source.htm create mode 100755 doc/html/WindowImplXXX_8hpp-source.htm create mode 100755 doc/html/WindowImpl_8cpp-source.htm create mode 100755 doc/html/WindowImpl_8hpp-source.htm create mode 100755 doc/html/Window_8cpp-source.htm create mode 100755 doc/html/classGLContext-members.htm create mode 100755 doc/html/classGLView-members.htm create mode 100755 doc/html/classWindowController-members.htm create mode 100755 doc/html/classWindowWrapper-members.htm create mode 100755 doc/html/classsf_1_1RenderImage-members.htm create mode 100755 doc/html/classsf_1_1RenderImage.htm create mode 100755 doc/html/classsf_1_1RenderImage.png create mode 100755 doc/html/interfaceGLContext.htm create mode 100755 doc/html/interfaceGLView.htm create mode 100755 doc/html/interfaceGLWindow.htm create mode 100755 doc/html/interfaceWindowController.htm create mode 100755 doc/html/interfaceWindowWrapper.htm (limited to 'doc') diff --git a/doc/SFML.chm b/doc/SFML.chm index 9372ce7..7980023 100755 Binary files a/doc/SFML.chm and b/doc/SFML.chm differ diff --git a/doc/html/AppController_8h-source.htm b/doc/html/AppController_8h-source.htm new file mode 100755 index 0000000..f4b4637 --- /dev/null +++ b/doc/html/AppController_8h-source.htm @@ -0,0 +1,96 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/AppController_8mm-source.htm b/doc/html/AppController_8mm-source.htm new file mode 100755 index 0000000..316d4ce --- /dev/null +++ b/doc/html/AppController_8mm-source.htm @@ -0,0 +1,551 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Arial_8hpp-source.htm b/doc/html/Arial_8hpp-source.htm new file mode 100755 index 0000000..322172a --- /dev/null +++ b/doc/html/Arial_8hpp-source.htm @@ -0,0 +1,14721 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/AudioDevice_8cpp-source.htm b/doc/html/AudioDevice_8cpp-source.htm new file mode 100755 index 0000000..68dabd2 --- /dev/null +++ b/doc/html/AudioDevice_8cpp-source.htm @@ -0,0 +1,180 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/AudioDevice_8hpp-source.htm b/doc/html/AudioDevice_8hpp-source.htm new file mode 100755 index 0000000..68c3a8c --- /dev/null +++ b/doc/html/AudioDevice_8hpp-source.htm @@ -0,0 +1,110 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/AudioResource_8cpp-source.htm b/doc/html/AudioResource_8cpp-source.htm new file mode 100755 index 0000000..bf6eb5b --- /dev/null +++ b/doc/html/AudioResource_8cpp-source.htm @@ -0,0 +1,84 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/AudioResource_8hpp-source.htm b/doc/html/AudioResource_8hpp-source.htm index 37e440f..e44c02b 100755 --- a/doc/html/AudioResource_8hpp-source.htm +++ b/doc/html/AudioResource_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Clock_8hpp-source.htm b/doc/html/Clock_8hpp-source.htm index 4357dc5..63a164c 100755 --- a/doc/html/Clock_8hpp-source.htm +++ b/doc/html/Clock_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Cocoa_2Joystick_8hpp-source.htm b/doc/html/Cocoa_2Joystick_8hpp-source.htm new file mode 100755 index 0000000..5226b9c --- /dev/null +++ b/doc/html/Cocoa_2Joystick_8hpp-source.htm @@ -0,0 +1,88 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Cocoa_2VideoModeSupport_8cpp-source.htm b/doc/html/Cocoa_2VideoModeSupport_8cpp-source.htm new file mode 100755 index 0000000..01c914d --- /dev/null +++ b/doc/html/Cocoa_2VideoModeSupport_8cpp-source.htm @@ -0,0 +1,128 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Cocoa_2VideoModeSupport_8hpp-source.htm b/doc/html/Cocoa_2VideoModeSupport_8hpp-source.htm new file mode 100755 index 0000000..f403355 --- /dev/null +++ b/doc/html/Cocoa_2VideoModeSupport_8hpp-source.htm @@ -0,0 +1,86 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Color_8cpp-source.htm b/doc/html/Color_8cpp-source.htm new file mode 100755 index 0000000..7ede2b4 --- /dev/null +++ b/doc/html/Color_8cpp-source.htm @@ -0,0 +1,149 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Color_8hpp-source.htm b/doc/html/Color_8hpp-source.htm index fc4957a..e3d30d2 100755 --- a/doc/html/Color_8hpp-source.htm +++ b/doc/html/Color_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Context_8hpp-source.htm b/doc/html/Context_8hpp-source.htm index 7871f68..573556d 100755 --- a/doc/html/Context_8hpp-source.htm +++ b/doc/html/Context_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Drawable_8hpp-source.htm b/doc/html/Drawable_8hpp-source.htm index 66b4445..4f1a676 100755 --- a/doc/html/Drawable_8hpp-source.htm +++ b/doc/html/Drawable_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/FontLoader_8hpp-source.htm b/doc/html/FontLoader_8hpp-source.htm new file mode 100755 index 0000000..f054efe --- /dev/null +++ b/doc/html/FontLoader_8hpp-source.htm @@ -0,0 +1,106 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Font_8cpp-source.htm b/doc/html/Font_8cpp-source.htm new file mode 100755 index 0000000..0dd8cd0 --- /dev/null +++ b/doc/html/Font_8cpp-source.htm @@ -0,0 +1,186 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Font_8hpp-source.htm b/doc/html/Font_8hpp-source.htm index 0a2527f..52eb243 100755 --- a/doc/html/Font_8hpp-source.htm +++ b/doc/html/Font_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Ftp_8hpp-source.htm b/doc/html/Ftp_8hpp-source.htm index 76af8d7..a049a64 100755 --- a/doc/html/Ftp_8hpp-source.htm +++ b/doc/html/Ftp_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/GLKit_8mm-source.htm b/doc/html/GLKit_8mm-source.htm new file mode 100755 index 0000000..516bb17 --- /dev/null +++ b/doc/html/GLKit_8mm-source.htm @@ -0,0 +1,738 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Glyph_8hpp-source.htm b/doc/html/Glyph_8hpp-source.htm index 1ece1f6..43d062b 100755 --- a/doc/html/Glyph_8hpp-source.htm +++ b/doc/html/Glyph_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/GraphicsContext_8hpp-source.htm b/doc/html/GraphicsContext_8hpp-source.htm new file mode 100755 index 0000000..66ca911 --- /dev/null +++ b/doc/html/GraphicsContext_8hpp-source.htm @@ -0,0 +1,181 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Graphics_8hpp-source.htm b/doc/html/Graphics_8hpp-source.htm index c83c1d6..c223c86 100755 --- a/doc/html/Graphics_8hpp-source.htm +++ b/doc/html/Graphics_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Http_8hpp-source.htm b/doc/html/Http_8hpp-source.htm index a8df86c..b22c4ae 100755 --- a/doc/html/Http_8hpp-source.htm +++ b/doc/html/Http_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/IPAddress_8hpp-source.htm b/doc/html/IPAddress_8hpp-source.htm index a01e8c1..8cf9102 100755 --- a/doc/html/IPAddress_8hpp-source.htm +++ b/doc/html/IPAddress_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/ImageLoader_8hpp-source.htm b/doc/html/ImageLoader_8hpp-source.htm new file mode 100755 index 0000000..1dc8342 --- /dev/null +++ b/doc/html/ImageLoader_8hpp-source.htm @@ -0,0 +1,102 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/ImageUpdater_8hpp-source.htm b/doc/html/ImageUpdater_8hpp-source.htm new file mode 100755 index 0000000..0500cb6 --- /dev/null +++ b/doc/html/ImageUpdater_8hpp-source.htm @@ -0,0 +1,87 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Image_8cpp-source.htm b/doc/html/Image_8cpp-source.htm new file mode 100755 index 0000000..6b9c16f --- /dev/null +++ b/doc/html/Image_8cpp-source.htm @@ -0,0 +1,724 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Image_8hpp-source.htm b/doc/html/Image_8hpp-source.htm index 5f996e2..bd6288a 100755 --- a/doc/html/Image_8hpp-source.htm +++ b/doc/html/Image_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Input_8cpp-source.htm b/doc/html/Input_8cpp-source.htm new file mode 100755 index 0000000..1432439 --- /dev/null +++ b/doc/html/Input_8cpp-source.htm @@ -0,0 +1,178 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Input_8hpp-source.htm b/doc/html/Input_8hpp-source.htm index 152c426..3152c45 100755 --- a/doc/html/Input_8hpp-source.htm +++ b/doc/html/Input_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Listener_8cpp-source.htm b/doc/html/Listener_8cpp-source.htm new file mode 100755 index 0000000..a9b3539 --- /dev/null +++ b/doc/html/Listener_8cpp-source.htm @@ -0,0 +1,124 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Listener_8hpp-source.htm b/doc/html/Listener_8hpp-source.htm index 18b08cd..56a7a16 100755 --- a/doc/html/Listener_8hpp-source.htm +++ b/doc/html/Listener_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Lock_8hpp-source.htm b/doc/html/Lock_8hpp-source.htm index 9c30878..f1211da 100755 --- a/doc/html/Lock_8hpp-source.htm +++ b/doc/html/Lock_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Matrix3_8hpp-source.htm b/doc/html/Matrix3_8hpp-source.htm index 43d0091..34cc5d9 100755 --- a/doc/html/Matrix3_8hpp-source.htm +++ b/doc/html/Matrix3_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Music_8hpp-source.htm b/doc/html/Music_8hpp-source.htm index df36857..b8e8764 100755 --- a/doc/html/Music_8hpp-source.htm +++ b/doc/html/Music_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Mutex_8hpp-source.htm b/doc/html/Mutex_8hpp-source.htm index 40a7136..b910970 100755 --- a/doc/html/Mutex_8hpp-source.htm +++ b/doc/html/Mutex_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/OpenGL_8hpp-source.htm b/doc/html/OpenGL_8hpp-source.htm index 6463b90..27ee314 100755 --- a/doc/html/OpenGL_8hpp-source.htm +++ b/doc/html/OpenGL_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Packet_8hpp-source.htm b/doc/html/Packet_8hpp-source.htm index 9e1bf93..5d57461 100755 --- a/doc/html/Packet_8hpp-source.htm +++ b/doc/html/Packet_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Platform_8hpp-source.htm b/doc/html/Platform_8hpp-source.htm new file mode 100755 index 0000000..3f7b682 --- /dev/null +++ b/doc/html/Platform_8hpp-source.htm @@ -0,0 +1,78 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/PostFX_8cpp-source.htm b/doc/html/PostFX_8cpp-source.htm new file mode 100755 index 0000000..538a461 --- /dev/null +++ b/doc/html/PostFX_8cpp-source.htm @@ -0,0 +1,493 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/PostFX_8hpp-source.htm b/doc/html/PostFX_8hpp-source.htm index acacba0..d942a80 100755 --- a/doc/html/PostFX_8hpp-source.htm +++ b/doc/html/PostFX_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Randomizer_8hpp-source.htm b/doc/html/Randomizer_8hpp-source.htm index f953320..c2cee4c 100755 --- a/doc/html/Randomizer_8hpp-source.htm +++ b/doc/html/Randomizer_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/RenderImageImplFBO_8hpp-source.htm b/doc/html/RenderImageImplFBO_8hpp-source.htm new file mode 100755 index 0000000..957cbed --- /dev/null +++ b/doc/html/RenderImageImplFBO_8hpp-source.htm @@ -0,0 +1,97 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderImageImplPBuffer_8cpp-source.htm b/doc/html/RenderImageImplPBuffer_8cpp-source.htm new file mode 100755 index 0000000..02541f4 --- /dev/null +++ b/doc/html/RenderImageImplPBuffer_8cpp-source.htm @@ -0,0 +1,242 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderImageImplPBuffer_8hpp-source.htm b/doc/html/RenderImageImplPBuffer_8hpp-source.htm new file mode 100755 index 0000000..30b5d48 --- /dev/null +++ b/doc/html/RenderImageImplPBuffer_8hpp-source.htm @@ -0,0 +1,79 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderImageImpl_8cpp-source.htm b/doc/html/RenderImageImpl_8cpp-source.htm new file mode 100755 index 0000000..ea12377 --- /dev/null +++ b/doc/html/RenderImageImpl_8cpp-source.htm @@ -0,0 +1,82 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderImageImpl_8hpp-source.htm b/doc/html/RenderImageImpl_8hpp-source.htm new file mode 100755 index 0000000..b76fc0c --- /dev/null +++ b/doc/html/RenderImageImpl_8hpp-source.htm @@ -0,0 +1,96 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderImage_8cpp-source.htm b/doc/html/RenderImage_8cpp-source.htm new file mode 100755 index 0000000..11761df --- /dev/null +++ b/doc/html/RenderImage_8cpp-source.htm @@ -0,0 +1,163 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderImage_8hpp-source.htm b/doc/html/RenderImage_8hpp-source.htm new file mode 100755 index 0000000..aedbd39 --- /dev/null +++ b/doc/html/RenderImage_8hpp-source.htm @@ -0,0 +1,108 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderTarget_8cpp-source.htm b/doc/html/RenderTarget_8cpp-source.htm new file mode 100755 index 0000000..d7ac98c --- /dev/null +++ b/doc/html/RenderTarget_8cpp-source.htm @@ -0,0 +1,189 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/RenderTarget_8hpp-source.htm b/doc/html/RenderTarget_8hpp-source.htm index af4f1ba..64acee2 100755 --- a/doc/html/RenderTarget_8hpp-source.htm +++ b/doc/html/RenderTarget_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/RenderWindow_8hpp-source.htm b/doc/html/RenderWindow_8hpp-source.htm index 4205108..886968f 100755 --- a/doc/html/RenderWindow_8hpp-source.htm +++ b/doc/html/RenderWindow_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/SelectorBase_8cpp-source.htm b/doc/html/SelectorBase_8cpp-source.htm new file mode 100755 index 0000000..5950ef5 --- /dev/null +++ b/doc/html/SelectorBase_8cpp-source.htm @@ -0,0 +1,143 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SelectorBase_8hpp-source.htm b/doc/html/SelectorBase_8hpp-source.htm index d63fa63..412f4c3 100755 --- a/doc/html/SelectorBase_8hpp-source.htm +++ b/doc/html/SelectorBase_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Shape_8hpp-source.htm b/doc/html/Shape_8hpp-source.htm index d874a6e..f45d290 100755 --- a/doc/html/Shape_8hpp-source.htm +++ b/doc/html/Shape_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Sleep_8hpp-source.htm b/doc/html/Sleep_8hpp-source.htm index cafad5a..a091a6e 100755 --- a/doc/html/Sleep_8hpp-source.htm +++ b/doc/html/Sleep_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/SocketHelper_8hpp-source.htm b/doc/html/SocketHelper_8hpp-source.htm index 676df94..881d6ae 100755 --- a/doc/html/SocketHelper_8hpp-source.htm +++ b/doc/html/SocketHelper_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/SocketTCP_8hpp-source.htm b/doc/html/SocketTCP_8hpp-source.htm index e4505b1..b97d6bf 100755 --- a/doc/html/SocketTCP_8hpp-source.htm +++ b/doc/html/SocketTCP_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/SocketUDP_8hpp-source.htm b/doc/html/SocketUDP_8hpp-source.htm index 65ca440..4b93815 100755 --- a/doc/html/SocketUDP_8hpp-source.htm +++ b/doc/html/SocketUDP_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/SoundBufferRecorder_8hpp-source.htm b/doc/html/SoundBufferRecorder_8hpp-source.htm index 0399d8a..0b59418 100755 --- a/doc/html/SoundBufferRecorder_8hpp-source.htm +++ b/doc/html/SoundBufferRecorder_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/SoundBuffer_8hpp-source.htm b/doc/html/SoundBuffer_8hpp-source.htm index 28d4567..1eb96d6 100755 --- a/doc/html/SoundBuffer_8hpp-source.htm +++ b/doc/html/SoundBuffer_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/SoundFileDefault_8hpp-source.htm b/doc/html/SoundFileDefault_8hpp-source.htm new file mode 100755 index 0000000..639e373 --- /dev/null +++ b/doc/html/SoundFileDefault_8hpp-source.htm @@ -0,0 +1,121 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SoundFileOgg_8cpp-source.htm b/doc/html/SoundFileOgg_8cpp-source.htm new file mode 100755 index 0000000..848696f --- /dev/null +++ b/doc/html/SoundFileOgg_8cpp-source.htm @@ -0,0 +1,194 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SoundFileOgg_8hpp-source.htm b/doc/html/SoundFileOgg_8hpp-source.htm new file mode 100755 index 0000000..27f8b2e --- /dev/null +++ b/doc/html/SoundFileOgg_8hpp-source.htm @@ -0,0 +1,103 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SoundFile_8cpp-source.htm b/doc/html/SoundFile_8cpp-source.htm new file mode 100755 index 0000000..9eb12a2 --- /dev/null +++ b/doc/html/SoundFile_8cpp-source.htm @@ -0,0 +1,262 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SoundFile_8hpp-source.htm b/doc/html/SoundFile_8hpp-source.htm new file mode 100755 index 0000000..f0699f4 --- /dev/null +++ b/doc/html/SoundFile_8hpp-source.htm @@ -0,0 +1,122 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SoundRecorder_8cpp-source.htm b/doc/html/SoundRecorder_8cpp-source.htm new file mode 100755 index 0000000..1b01b07 --- /dev/null +++ b/doc/html/SoundRecorder_8cpp-source.htm @@ -0,0 +1,222 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/SoundRecorder_8hpp-source.htm b/doc/html/SoundRecorder_8hpp-source.htm index 9ec5c44..b779646 100755 --- a/doc/html/SoundRecorder_8hpp-source.htm +++ b/doc/html/SoundRecorder_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/SoundStream_8hpp-source.htm b/doc/html/SoundStream_8hpp-source.htm index a374659..20c337c 100755 --- a/doc/html/SoundStream_8hpp-source.htm +++ b/doc/html/SoundStream_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Sound_8hpp-source.htm b/doc/html/Sound_8hpp-source.htm index 568a401..4539489 100755 --- a/doc/html/Sound_8hpp-source.htm +++ b/doc/html/Sound_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Sprite_8hpp-source.htm b/doc/html/Sprite_8hpp-source.htm index c5977cd..cf66a75 100755 --- a/doc/html/Sprite_8hpp-source.htm +++ b/doc/html/Sprite_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/String_8hpp-source.htm b/doc/html/String_8hpp-source.htm index c2416a1..7508f1c 100755 --- a/doc/html/String_8hpp-source.htm +++ b/doc/html/String_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Template_01for_01new_01ports_2Joystick_8hpp-source.htm b/doc/html/Template_01for_01new_01ports_2Joystick_8hpp-source.htm new file mode 100755 index 0000000..de240a9 --- /dev/null +++ b/doc/html/Template_01for_01new_01ports_2Joystick_8hpp-source.htm @@ -0,0 +1,88 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Template_01for_01new_01ports_2VideoModeSupport_8cpp-source.htm b/doc/html/Template_01for_01new_01ports_2VideoModeSupport_8cpp-source.htm new file mode 100755 index 0000000..ec0b352 --- /dev/null +++ b/doc/html/Template_01for_01new_01ports_2VideoModeSupport_8cpp-source.htm @@ -0,0 +1,87 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Template_01for_01new_01ports_2VideoModeSupport_8hpp-source.htm b/doc/html/Template_01for_01new_01ports_2VideoModeSupport_8hpp-source.htm new file mode 100755 index 0000000..081bbe0 --- /dev/null +++ b/doc/html/Template_01for_01new_01ports_2VideoModeSupport_8hpp-source.htm @@ -0,0 +1,86 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Thread_8cpp-source.htm b/doc/html/Thread_8cpp-source.htm new file mode 100755 index 0000000..3eba806 --- /dev/null +++ b/doc/html/Thread_8cpp-source.htm @@ -0,0 +1,150 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Thread_8hpp-source.htm b/doc/html/Thread_8hpp-source.htm index 2c6aad9..185a0ff 100755 --- a/doc/html/Thread_8hpp-source.htm +++ b/doc/html/Thread_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Unicode_8hpp-source.htm b/doc/html/Unicode_8hpp-source.htm index dec76cc..7e3b957 100755 --- a/doc/html/Unicode_8hpp-source.htm +++ b/doc/html/Unicode_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/VideoMode_8cpp-source.htm b/doc/html/VideoMode_8cpp-source.htm new file mode 100755 index 0000000..1312cb6 --- /dev/null +++ b/doc/html/VideoMode_8cpp-source.htm @@ -0,0 +1,172 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/VideoMode_8hpp-source.htm b/doc/html/VideoMode_8hpp-source.htm index 326e10a..1faf203 100755 --- a/doc/html/VideoMode_8hpp-source.htm +++ b/doc/html/VideoMode_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/View_8hpp-source.htm b/doc/html/View_8hpp-source.htm index 521058d..7c0848d 100755 --- a/doc/html/View_8hpp-source.htm +++ b/doc/html/View_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Win32_2Joystick_8hpp-source.htm b/doc/html/Win32_2Joystick_8hpp-source.htm new file mode 100755 index 0000000..a43a051 --- /dev/null +++ b/doc/html/Win32_2Joystick_8hpp-source.htm @@ -0,0 +1,95 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Win32_2Mutex_8hpp-source.htm b/doc/html/Win32_2Mutex_8hpp-source.htm index 965266b..4e16f41 100755 --- a/doc/html/Win32_2Mutex_8hpp-source.htm +++ b/doc/html/Win32_2Mutex_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/Win32_2RenderImageImplPBuffer_8hpp-source.htm b/doc/html/Win32_2RenderImageImplPBuffer_8hpp-source.htm new file mode 100755 index 0000000..4e0bf86 --- /dev/null +++ b/doc/html/Win32_2RenderImageImplPBuffer_8hpp-source.htm @@ -0,0 +1,106 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/Win32_2SocketHelper_8hpp-source.htm b/doc/html/Win32_2SocketHelper_8hpp-source.htm index a4c0796..9e0a061 100755 --- a/doc/html/Win32_2SocketHelper_8hpp-source.htm +++ b/doc/html/Win32_2SocketHelper_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Win32_2VideoModeSupport_8hpp-source.htm b/doc/html/Win32_2VideoModeSupport_8hpp-source.htm new file mode 100755 index 0000000..24b53b2 --- /dev/null +++ b/doc/html/Win32_2VideoModeSupport_8hpp-source.htm @@ -0,0 +1,86 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowController_8h-source.htm b/doc/html/WindowController_8h-source.htm new file mode 100755 index 0000000..3ac215d --- /dev/null +++ b/doc/html/WindowController_8h-source.htm @@ -0,0 +1,87 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowController_8mm-source.htm b/doc/html/WindowController_8mm-source.htm new file mode 100755 index 0000000..1521d44 --- /dev/null +++ b/doc/html/WindowController_8mm-source.htm @@ -0,0 +1,164 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowHandle_8hpp-source.htm b/doc/html/WindowHandle_8hpp-source.htm index 9525b64..28cba68 100755 --- a/doc/html/WindowHandle_8hpp-source.htm +++ b/doc/html/WindowHandle_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + + + + + + + + diff --git a/doc/html/WindowImplCocoa_8mm-source.htm b/doc/html/WindowImplCocoa_8mm-source.htm new file mode 100755 index 0000000..7ebaa3a --- /dev/null +++ b/doc/html/WindowImplCocoa_8mm-source.htm @@ -0,0 +1,769 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowImplWin32_8cpp-source.htm b/doc/html/WindowImplWin32_8cpp-source.htm new file mode 100755 index 0000000..fc62ea4 --- /dev/null +++ b/doc/html/WindowImplWin32_8cpp-source.htm @@ -0,0 +1,1110 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowImplWin32_8hpp-source.htm b/doc/html/WindowImplWin32_8hpp-source.htm new file mode 100755 index 0000000..a25eb58 --- /dev/null +++ b/doc/html/WindowImplWin32_8hpp-source.htm @@ -0,0 +1,151 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowImplXXX_8cpp-source.htm b/doc/html/WindowImplXXX_8cpp-source.htm new file mode 100755 index 0000000..6c9beff --- /dev/null +++ b/doc/html/WindowImplXXX_8cpp-source.htm @@ -0,0 +1,215 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowImplXXX_8hpp-source.htm b/doc/html/WindowImplXXX_8hpp-source.htm new file mode 100755 index 0000000..d9102ec --- /dev/null +++ b/doc/html/WindowImplXXX_8hpp-source.htm @@ -0,0 +1,118 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowImpl_8cpp-source.htm b/doc/html/WindowImpl_8cpp-source.htm new file mode 100755 index 0000000..84270d6 --- /dev/null +++ b/doc/html/WindowImpl_8cpp-source.htm @@ -0,0 +1,242 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowImpl_8hpp-source.htm b/doc/html/WindowImpl_8hpp-source.htm new file mode 100755 index 0000000..a7ea547 --- /dev/null +++ b/doc/html/WindowImpl_8hpp-source.htm @@ -0,0 +1,164 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + + + + + + diff --git a/doc/html/WindowListener_8hpp-source.htm b/doc/html/WindowListener_8hpp-source.htm index a411931..94725dd 100755 --- a/doc/html/WindowListener_8hpp-source.htm +++ b/doc/html/WindowListener_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + - -
- -
+ + + + + + + + + + diff --git a/doc/html/Window_8hpp-source.htm b/doc/html/Window_8hpp-source.htm index de78bf8..688b8f9 100755 --- a/doc/html/Window_8hpp-source.htm +++ b/doc/html/Window_8hpp-source.htm @@ -10,19 +10,25 @@ - -
- -
+ + + - -
- + + -
- -
-

SFML Class List

Here are the classes, structs, unions and interfaces with brief descriptions: +
+

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - - - + + + + + + + + - - - + + + + + - - @@ -85,12 +91,12 @@ - + - + @@ -98,7 +104,9 @@ +
sf::AudioResourceAbstract base class for every class that owns a device-dependant resource -- allow them to initialize / shutdown even when the audio context is not created
sf::ClockClock is an utility class for manipulating time
sf::ColorColor is an utility class for manipulating 32-bits RGBA colors
sf::ContextClass wrapping an OpenGL context
sf::DrawableAbstract base class for every object that can be drawn into a render window
sf::EventEvent defines a system event and its parameters
sf::Event::JoyButtonEventJoystick buttons events parameters
sf::Event::JoyMoveEventJoystick axis move event parameters
sf::Event::KeyEventKeyboard event parameters
sf::Event::MouseButtonEventMouse buttons events parameters
sf::Event::MouseMoveEventMouse move event parameters
sf::Event::MouseWheelEventMouse wheel events parameters
sf::Event::SizeEventSize events parameters
sf::Event::TextEventText event parameters
sf::Event::Event::JoyButtonEventJoystick buttons events parameters
sf::Event::Event::JoyMoveEventJoystick axis move event parameters
sf::Event::Event::KeyEventKeyboard event parameters
sf::Event::Event::MouseButtonEventMouse buttons events parameters
sf::Event::Event::MouseMoveEventMouse move event parameters
sf::Event::Event::MouseWheelEventMouse wheel events parameters
sf::Event::Event::SizeEventSize events parameters
sf::Event::Event::TextEventText event parameters
sf::FontFont is the low-level class for loading and manipulating character fonts
sf::FtpThis class provides methods for manipulating the FTP protocol (described in RFC 959)
sf::Ftp::DirectoryResponseSpecialization of FTP response returning a directory
sf::Ftp::ListingResponseSpecialization of FTP response returning a filename lisiting
sf::Ftp::ResponseThis class wraps a FTP response, which is basically :
    +
sf::Ftp::Ftp::DirectoryResponseSpecialization of FTP response returning a directory
sf::Ftp::Ftp::ListingResponseSpecialization of FTP response returning a filename lisiting
sf::Ftp::Ftp::ResponseThis class wraps a FTP response, which is basically :
  • a status code
  • a message
GLContextWindow independant OpenGL context class
GLViewCustomized Cocoa OpenGL view
GLWindowCocoa window implementation to let fullscreen windows catch key events
sf::GlyphStructure describing a glyph (a visual character)
sf::HttpThis class provides methods for manipulating the HTTP protocol (described in RFC 1945)
sf::Http::RequestThis class wraps an HTTP request, which is basically :
    +
sf::Http::Http::RequestThis class wraps an HTTP request, which is basically :
  • a header with a method, a target URI, and a set of field/value pairs
  • an optional body (for POST requests)
sf::Http::ResponseThis class wraps an HTTP response, which is basically :
    +
sf::Http::Http::ResponseThis class wraps an HTTP response, which is basically :
  • a header with a status code and a set of field/value pairs
  • a body (the content of the requested resource)
sf::ImageImage is the low-level class for loading and manipulating images
sf::SoundBufferRecorderSpecialized SoundRecorder which saves the captured audio data into a sound buffer
sf::SoundRecorderSoundRecorder is an interface for capturing sound data, it is meant to be used as a base class
sf::SoundStreamSoundStream is a streamed sound, ie samples are acquired while the sound is playing
sf::SoundStream::ChunkStructure defining a chunk of audio data to stream
sf::SoundStream::SoundStream::ChunkStructure defining a chunk of audio data to stream
sf::SpriteSprite defines a sprite : texture, transformations, color, and draw on screen
sf::StringString defines a graphical 2D text, that can be drawn on screen
sf::ThreadThread defines an easy way to manipulate a thread
sf::UnicodeProvides utility functions to convert from and to any unicode and ASCII encoding
sf::Unicode::TextThis class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding
sf::Unicode::Unicode::TextThis class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding
sf::Vector2< T >Vector2 is an utility class for manipulating 2 dimensional vectors
sf::Vector3< T >Vector3 is an utility class for manipulating 3 dimensional vectors
sf::VideoModeVideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for getting modes supported by the display device
sf::WindowWindow is a rendering window ; it can create a new window or connect to an existing one
sf::WindowListenerBase class for classes that want to receive events from a window (for internal use only)
sf::WindowSettingsStructure defining the creation settings of windows
WindowWrapperWindowWrapper class : handles both imported and self-built windows
+
+ + +
+

GLContext Member List

This is the complete list of members for GLContext, including all inherited members.

+ + + +
- initWithAttributes:sharedContext:GLContext
mySharedContext (defined in GLContext)GLContext [protected]
+ sharedContextGLContext [static]

+ + + + + diff --git a/doc/html/classGLView-members.htm b/doc/html/classGLView-members.htm new file mode 100755 index 0000000..78c1539 --- /dev/null +++ b/doc/html/classGLView-members.htm @@ -0,0 +1,49 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + +
+

GLView Member List

This is the complete list of members for GLView, including all inherited members.

+ + + + + + + +
- enableVerticalSync:GLView
- finishInitializationGLView
- flushBufferGLView
- initWithFrame:mode:settings:delegate:GLView
myDelegate (defined in GLView)GLView [protected]
myGLContext (defined in GLView)GLView [protected]
- setActive:GLView

+ + + + + diff --git a/doc/html/classWindowController-members.htm b/doc/html/classWindowController-members.htm new file mode 100755 index 0000000..af2404b --- /dev/null +++ b/doc/html/classWindowController-members.htm @@ -0,0 +1,49 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + +
+

WindowController Member List

This is the complete list of members for WindowController, including all inherited members.

+ + + + + + + +
+ controllerWithWindow:WindowController [static]
- initWithWindow:WindowController
parentWindow (defined in WindowController)WindowController [protected]
- viewFrameDidChange:WindowController
- windowDidBecomeMain:WindowController
- windowDidResignMain:WindowController
- windowWillClose:WindowController

+ + + + + diff --git a/doc/html/classWindowWrapper-members.htm b/doc/html/classWindowWrapper-members.htm new file mode 100755 index 0000000..ef08049 --- /dev/null +++ b/doc/html/classWindowWrapper-members.htm @@ -0,0 +1,59 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + +
+

WindowWrapper Member List

This is the complete list of members for WindowWrapper, including all inherited members.

+ + + + + + + + + + + + + + + + + +
- enableVerticalSync:WindowWrapper
- flushBufferWindowWrapper
- glViewWindowWrapper
- initWithSettings:videoMode:style:title:delegate:WindowWrapper
- initWithWindow:settings:delegate:WindowWrapper
- initWithWindow:settings:videoMode:style:title:delegate:WindowWrapper
- mouseInsideWindowWrapper
- mouseLocationWindowWrapper
myFullscreenMode (defined in WindowWrapper)WindowWrapper [protected]
myIsFullscreen (defined in WindowWrapper)WindowWrapper [protected]
myView (defined in WindowWrapper)WindowWrapper [protected]
myWindow (defined in WindowWrapper)WindowWrapper [protected]
- setActive:WindowWrapper
- setPosition:WindowWrapper
- setSize:WindowWrapper
- show:WindowWrapper
- windowWindowWrapper

+ + + + + diff --git a/doc/html/classes.htm b/doc/html/classes.htm index e1fc0a4..4337134 100755 --- a/doc/html/classes.htm +++ b/doc/html/classes.htm @@ -10,44 +10,48 @@ - -
- + + -
- -
-

SFML Class Index

A | C | D | E | F | G | H | I | L | M | N | P | R | S | T | U | V | W

+

+

Class Index

A | C | D | E | F | G | H | I | L | M | N | P | R | S | T | U | V | W

  A  
-		Event::TextEvent (sf)   
  L  
-		RenderWindow (sf)   Sprite (sf)   
AudioResource (sf)   
  F  
-		Listener (sf)   Resource (sf)   String (sf)   
  C  
-		Font (sf)   Lock (sf)   ResourcePtr (sf)   
  T  
-
Clock (sf)   Ftp (sf)   
  M  
-
  S  
-		Thread (sf)   
Color (sf)   Ftp::DirectoryResponse (sf)   Matrix3 (sf)   Selector (sf)   
  U  
-
Context (sf)   Ftp::ListingResponse (sf)   Music (sf)   SelectorBase (sf)   Unicode (sf)   
  D  
-		Ftp::Response (sf)   Mutex (sf)   Shape (sf)   Unicode::Text (sf)   
Drawable (sf)   
  G  
-
  N  
-		SocketHelper (sf)   
  V  
+
  F  
+		Input (sf)   RenderTarget (sf)   Sprite (sf)   
AudioResource (sf)   Font (sf)   IPAddress (sf)   RenderWindow (sf)   String (sf)   
  C  
+		Ftp (sf)   
  L  
+		Resource (sf)   
  T  
+
Clock (sf)   Ftp::DirectoryResponse (sf)   Listener (sf)   ResourcePtr (sf)   Thread (sf)   
Color (sf)   Ftp::ListingResponse (sf)   Lock (sf)   
  S  
+
  U  
+
Context (sf)   Ftp::Response (sf)   
  M  
+		Selector (sf)   Unicode (sf)   
  D  
+
  G  
+		Matrix3 (sf)   SelectorBase (sf)   Unicode::Text (sf)   
Drawable (sf)   GLContext   Music (sf)   Shape (sf)   
  V  
  E  
-		Glyph (sf)   NonCopyable (sf)   SocketTCP (sf)   Vector2 (sf)   
Event (sf)   
  H  
+		GLView   Mutex (sf)   SocketHelper (sf)   Vector2 (sf)   
Event (sf)   GLWindow   
  N  
+		SocketTCP (sf)   Vector3 (sf)   
Event::JoyButtonEvent (sf)   Glyph (sf)   NonCopyable (sf)   SocketUDP (sf)   VideoMode (sf)   
Event::JoyMoveEvent (sf)   
  H  
  P  
-		SocketUDP (sf)   Vector3 (sf)   
Event::JoyButtonEvent (sf)   Http (sf)   Packet (sf)   Sound (sf)   VideoMode (sf)   
Event::JoyMoveEvent (sf)   Http::Request (sf)   PostFX (sf)   SoundBuffer (sf)   View (sf)   
Event::KeyEvent (sf)   Http::Response (sf)   
  R  
-		SoundBufferRecorder (sf)   
  W  
-
Event::MouseButtonEvent (sf)   
  I  
-		Randomizer (sf)   SoundRecorder (sf)   Window (sf)   
Event::MouseMoveEvent (sf)   Image (sf)   Rect (sf)   SoundStream (sf)   WindowListener (sf)   
Event::MouseWheelEvent (sf)   Input (sf)   RenderTarget (sf)   SoundStream::Chunk (sf)   WindowSettings (sf)   
Event::SizeEvent (sf)   IPAddress (sf)   

A | C | D | E | F | G | H | I | L | M | N | P | R | S | T | U | V | W

+Sound (sf)   View (sf)   Event::KeyEvent (sf)   Http (sf)   Packet (sf)   SoundBuffer (sf)   
  W  
+Event::MouseButtonEvent (sf)   Http::Request (sf)   PostFX (sf)   SoundBufferRecorder (sf)   Window (sf)   Event::MouseMoveEvent (sf)   Http::Response (sf)   
  R  
+SoundRecorder (sf)   WindowListener (sf)   Event::MouseWheelEvent (sf)   
  I  
+Randomizer (sf)   SoundStream (sf)   WindowSettings (sf)   Event::SizeEvent (sf)   Image (sf)   Rect (sf)   SoundStream::Chunk (sf)   WindowWrapper   Event::TextEvent (sf)   

A | C | D | E | F | G | H | I | L | M | N | P | R | S | T | U | V | W

+

- -
- -
-
- + + +

sf::AudioResource Member List

This is the complete list of members for sf::AudioResource, including all inherited members.

- -
AudioResource()sf::AudioResource [protected]
AudioResource(const AudioResource &)sf::AudioResource [protected]
~AudioResource()sf::AudioResource [protected, virtual]
+ ~AudioResource()sf::AudioResource [protected, virtual] +

+ - -
- + + -
- -
-
-sf::AudioResource
+

sf::AudioResource Class Reference

Abstract base class for every class that owns a device-dependant resource -- allow them to initialize / shutdown even when the audio context is not created. More...

#include <AudioResource.hpp>

-

Inheritance diagram for sf::AudioResource: +

+Inheritance diagram for sf::AudioResource:
+
+

sf::Sound @@ -42,6 +48,9 @@ sf::SoundStream sf::Music +
+ +

List of all members. @@ -51,16 +60,14 @@ - + - +

Protected Member Functions

 AudioResource (const AudioResource &)
 Copy constructor.
virtual ~AudioResource ()
virtual ~AudioResource ()
 Destructor.
 Destructor.

Detailed Description

Abstract base class for every class that owns a device-dependant resource -- allow them to initialize / shutdown even when the audio context is not created. -

- -

-Definition at line 41 of file AudioResource.hpp.

Constructor & Destructor Documentation

+

Definition at line 41 of file AudioResource.hpp.

+

Constructor & Destructor Documentation

@@ -70,7 +77,7 @@ Definition at line 41< (  )  - [protected] + [protected]
@@ -80,6 +87,8 @@ Definition at line 41< Default constructor.

+

Definition at line 37 of file AudioResource.cpp.

+

@@ -92,7 +101,7 @@ Default constructor. const AudioResource &   )  - [protected] + [protected]

@@ -102,18 +111,20 @@ Default constructor. Copy constructor.

+

Definition at line 46 of file AudioResource.cpp.

+

- +

- + - +
virtual sf::AudioResource::~AudioResource sf::AudioResource::~AudioResource (  )  [protected, virtual] [protected, virtual]
@@ -123,10 +134,13 @@ Copy constructor. Destructor.

+

Definition at line 55 of file AudioResource.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Clock Member List

This is the complete list of members for sf::Clock, including all inherited members.

- + -
Clock()sf::Clock
GetElapsedTime() constsf::Clock
GetElapsedTime() const sf::Clock
Reset()sf::Clock
+

+ - -
- + + -
- -
-
-sf::Clock
+

sf::Clock Class Reference

Clock is an utility class for manipulating time. More...

#include <Clock.hpp> +

+

List of all members. @@ -40,19 +45,17 @@ - + - +
 Clock ()
 Default constructor.
float GetElapsedTime () const
float GetElapsedTime () const
 Get the time elapsed since last reset.
 Get the time elapsed since last reset.
void Reset ()
 Restart the timer.

Detailed Description

Clock is an utility class for manipulating time. -

- -

-Definition at line 39 of file Clock.hpp.

Constructor & Destructor Documentation

+

Definition at line 39 of file Clock.hpp.

+

Constructor & Destructor Documentation

@@ -62,7 +65,7 @@ Definition at line 39 of f (  )  - +
@@ -72,10 +75,12 @@ Definition at line 39 of f Default constructor.

+

Definition at line 37 of file Clock.cpp.

+

Member Function Documentation

- +
@@ -84,7 +89,7 @@ Default constructor. - +
(  )  const const
@@ -95,6 +100,8 @@ Get the time elapsed since last reset.

Returns:
Time elapsed, in seconds
+

Definition at line 46 of file Clock.cpp.

+

@@ -106,7 +113,7 @@ Get the time elapsed since last reset. (  )  - +

@@ -116,10 +123,13 @@ Get the time elapsed since last reset. Restart the timer.

+

Definition at line 55 of file Clock.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Color Member List

This is the complete list of members for sf::Color, including all inherited members.

@@ -38,15 +41,16 @@ - - + + -
asf::Color
bsf::Color
gsf::Color
Greensf::Color [static]
Magentasf::Color [static]
operator *=(const Color &Other)sf::Color
operator!=(const Color &Other) const sf::Color
operator+=(const Color &Other)sf::Color
operator*=(const Color &Other)sf::Color
operator+=(const Color &Other)sf::Color
operator==(const Color &Other) const sf::Color
rsf::Color
Redsf::Color [static]
Whitesf::Color [static]
Yellowsf::Color [static]
+

+ - -
- -
-
- -
-
-sf::Color
+ + +

sf::Color Class Reference

Color is an utility class for manipulating 32-bits RGBA colors. More...

#include <Color.hpp> +

+

List of all members. @@ -43,12 +48,12 @@ - + - - + + - + @@ -96,10 +101,8 @@
 Color (Uint8 R, Uint8 G, Uint8 B, Uint8 A=255)
 Construct the color from its 4 RGBA components.
Color & operator+= (const Color &Other)
Color & operator+= (const Color &Other)
 Operator += overload to add a color.
Color & operator *= (const Color &Other)
 Operator += overload to add a color.
Color & operator*= (const Color &Other)
 Operator *= overload to modulate a color.
 Operator *= overload to modulate a color.
bool operator== (const Color &Other) const
 Compare two colors (for equality).

Detailed Description

Color is an utility class for manipulating 32-bits RGBA colors. -

- -

-Definition at line 40 of file Color.hpp.

Constructor & Destructor Documentation

+

Definition at line 40 of file Color.hpp.

+

Constructor & Destructor Documentation

@@ -109,7 +112,7 @@ Definition at line 40 of f (  )  - +
@@ -119,6 +122,8 @@ Definition at line 40 of f Default constructor.

+

Definition at line 50 of file Color.cpp.

+

@@ -152,7 +157,7 @@ Default constructor. ) - +

@@ -170,48 +175,52 @@ Construct the color from its 4 RGBA components. +

Definition at line 63 of file Color.cpp.

+

Member Function Documentation

- +
- + - +
Color& sf::Color::operator+= bool sf::Color::operator!= ( const Color &  Other  )  const

-Operator += overload to add a color. +Compare two colors (for difference).

Parameters:
- +
Other : Color to add
Other : Color to compare
-
Returns:
Component-wise saturated addition of the two colors
+
Returns:
True if colors are different
+ +

Definition at line 113 of file Color.cpp.

- +

- + - +
Color& sf::Color::operator *= Color & sf::Color::operator*= ( const Color &  Other  ) 
@@ -227,215 +236,221 @@ Operator *= overload to modulate a color.
Returns:
Component-wise multiplication of the two colors
+

Definition at line 90 of file Color.cpp.

+

- +

- + - +
bool sf::Color::operator== Color & sf::Color::operator+= ( const Color &  Other  )  const

-Compare two colors (for equality). +Operator += overload to add a color.

Parameters:
- +
Other : Color to compare
Other : Color to add
-
Returns:
True if colors are equal
+
Returns:
Component-wise saturated addition of the two colors
+ +

Definition at line 76 of file Color.cpp.

- +

- + - +
bool sf::Color::operator!= bool sf::Color::operator== ( const Color &  Other  )  const const

-Compare two colors (for difference). +Compare two colors (for equality).

Parameters:
Other : Color to compare
-
Returns:
True if colors are different
+
Returns:
True if colors are equal
+ +

Definition at line 104 of file Color.cpp.

Member Data Documentation

- +
- +
const Color sf::Color::Black [static] Uint8 sf::Color::a

-Black predefined color. +Alpha (transparency) component.

-

-Definition at line 104 of file Color.hpp. +

Definition at line 119 of file Color.hpp.

+

- +

- +
const Color sf::Color::White [static] Uint8 sf::Color::b

-White predefined color. +Blue component.

-

-Definition at line 105 of file Color.hpp. +

Definition at line 118 of file Color.hpp.

+

- +

- +
const Color sf::Color::Red [static] const Color sf::Color::Black [static]

-Red predefined color. +Black predefined color.

-

-Definition at line 106 of file Color.hpp. +

Definition at line 104 of file Color.hpp.

+

- +

- +
const Color sf::Color::Green [static] const Color sf::Color::Blue [static]

-Green predefined color. +Blue predefined color.

-

-Definition at line 107 of file Color.hpp. +

Definition at line 108 of file Color.hpp.

+

- +

- +
const Color sf::Color::Blue [static] const Color sf::Color::Cyan [static]

-Blue predefined color. +Cyan predefined color.

-

-Definition at line 108 of file Color.hpp. +

Definition at line 111 of file Color.hpp.

+

- +

- +
const Color sf::Color::Yellow [static] Uint8 sf::Color::g

-Yellow predefined color. +Green component.

-

-Definition at line 109 of file Color.hpp. +

Definition at line 117 of file Color.hpp.

+

- +

- +
const Color sf::Color::Magenta [static] const Color sf::Color::Green [static]

-Magenta predefined color. +Green predefined color.

-

-Definition at line 110 of file Color.hpp. +

Definition at line 107 of file Color.hpp.

+

- +

- +
const Color sf::Color::Cyan [static] const Color sf::Color::Magenta [static]

-Cyan predefined color. +Magenta predefined color.

-

-Definition at line 111 of file Color.hpp. +

Definition at line 110 of file Color.hpp.

+

@@ -453,69 +468,70 @@ Definition at line 111 of Red component.

-

-Definition at line 116 of file Color.hpp. +

Definition at line 116 of file Color.hpp.

+

- +

- +
Uint8 sf::Color::g const Color sf::Color::Red [static]

-Green component. +Red predefined color.

-

-Definition at line 117 of file Color.hpp. +

Definition at line 106 of file Color.hpp.

+

- +

- +
Uint8 sf::Color::b const Color sf::Color::White [static]

-Blue component. +White predefined color.

-

-Definition at line 118 of file Color.hpp. +

Definition at line 105 of file Color.hpp.

+

- +

- +
Uint8 sf::Color::a const Color sf::Color::Yellow [static]

-Alpha (transparency) component. +Yellow predefined color.

-

-Definition at line 119 of file Color.hpp. +

Definition at line 109 of file Color.hpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Context Member List

This is the complete list of members for sf::Context, including all inherited members.

- - + + -
Context()sf::Context
GetGlobal()sf::Context [static]
IsContextActive()sf::Context [static]
GetGlobal()sf::Context [static]
IsContextActive()sf::Context [static]
NonCopyable()sf::NonCopyable [inline, private]
SetActive(bool Active)sf::Context
~Context()sf::Context
+

+ - -
- + + -
- -
-
-sf::Context
+

sf::Context Class Reference

Class wrapping an OpenGL context. More...

#include <Context.hpp>

-

Inheritance diagram for sf::Context: +

+Inheritance diagram for sf::Context:
+
+

sf::NonCopyable +
+ +

List of all members. @@ -52,21 +61,19 @@ - + - - + + - +

Public Member Functions

 Activate or deactivate the context.

Static Public Member Functions

static bool IsContextActive ()
static bool IsContextActive ()
 Check if there's a context bound to the current thread.
static Context & GetGlobal ()
 Check if there's a context bound to the current thread.
static Context & GetGlobal ()
 Get the global context.
 Get the global context.

Detailed Description

Class wrapping an OpenGL context.

All SFML windows already have their own context, so this class is more a helper for specific issues involving OpenGL and multi-threading. It's meant to be used internally. -

- -

-Definition at line 49 of file Context.hpp.

Constructor & Destructor Documentation

+

Definition at line 49 of file Context.hpp.

+

Constructor & Destructor Documentation

@@ -76,7 +83,7 @@ Definition at line 49 of (  )  - +
@@ -86,6 +93,8 @@ Definition at line 49 of Default constructor, create the context.

+

Definition at line 44 of file Context.cpp.

+

@@ -97,7 +106,7 @@ Default constructor, create the context. (  )  - +

@@ -107,46 +116,45 @@ Default constructor, create the context. Destructor, destroy the context.

+

Definition at line 53 of file Context.cpp.

+

Member Function Documentation

- +
- + - - + - +
void sf::Context::SetActive Context & sf::Context::GetGlobal (bool  Active  )  [static]

-Activate or deactivate the context. +Get the global context.

-

Parameters:
- - -
Active : True to activate the context, false to deactivate it
-
+
Returns:
Reference to the global context
+ +

Definition at line 80 of file Context.cpp.

- +

- + - +
static bool sf::Context::IsContextActive bool sf::Context::IsContextActive (  )  [static] [static]
@@ -157,32 +165,42 @@ Check if there's a context bound to the current thread.

Returns:
True if there's a context bound to the current thread
+

Definition at line 71 of file Context.cpp.

+

- +

- + - + + - +
static Context& sf::Context::GetGlobal void sf::Context::SetActive ( bool  Active  )  [static]

-Get the global context. +Activate or deactivate the context.

-

Returns:
Reference to the global context
+
Parameters:
+ + +
Active : True to activate the context, false to deactivate it
+
+ +

Definition at line 62 of file Context.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Drawable Member List

This is the complete list of members for sf::Drawable, including all inherited members.

- - - - - - - - + + + + + + + + - + @@ -58,8 +61,9 @@ - -
Drawable(const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))sf::Drawable
GetBlendMode() constsf::Drawable
GetCenter() constsf::Drawable
GetColor() constsf::Drawable
GetInverseMatrix() constsf::Drawable [protected]
GetMatrix() constsf::Drawable [protected]
GetPosition() constsf::Drawable
GetRotation() constsf::Drawable
GetScale() constsf::Drawable
GetBlendMode() const sf::Drawable
GetCenter() const sf::Drawable
GetColor() const sf::Drawable
GetInverseMatrix() const sf::Drawable [protected]
GetMatrix() const sf::Drawable [protected]
GetPosition() const sf::Drawable
GetRotation() const sf::Drawable
GetScale() const sf::Drawable
Move(float OffsetX, float OffsetY)sf::Drawable
Move(const Vector2f &Offset)sf::Drawable
RenderTarget classsf::Drawable [friend]
RenderTarget (defined in sf::Drawable)sf::Drawable [friend]
Rotate(float Angle)sf::Drawable
Scale(float FactorX, float FactorY)sf::Drawable
Scale(const Vector2f &Factor)sf::Drawable
SetY(float Y)sf::Drawable
TransformToGlobal(const sf::Vector2f &Point) const sf::Drawable
TransformToLocal(const sf::Vector2f &Point) const sf::Drawable
~Drawable()sf::Drawable [virtual]
+ ~Drawable()sf::Drawable [virtual] +

+ - -
- -
-
- -
-
-sf::Drawable
+ + +

sf::Drawable Class Reference

Abstract base class for every object that can be drawn into a render window. More...

#include <Drawable.hpp>

-

Inheritance diagram for sf::Drawable: +

+Inheritance diagram for sf::Drawable:
+
+

sf::PostFX @@ -42,15 +48,18 @@ sf::Sprite sf::String +
+ +

List of all members. - + - + @@ -90,24 +99,24 @@ - + - - + + - - + + - - + + - - + + - - + + - + @@ -130,23 +139,21 @@ - + - - + + - + +class 

Public Member Functions

 Drawable (const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))
 Default constructor.
virtual ~Drawable ()
virtual ~Drawable ()
 Virtual destructor.
 Virtual destructor.
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values).
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
const Vector2f & GetPosition () const
const Vector2f & GetPosition () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values).
 Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Protected Member Functions

const Matrix3 & GetMatrix () const
const Matrix3 & GetMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the inverse transform matrix of the drawable.
 Get the inverse transform matrix of the drawable.

Friends

-class RenderTarget
RenderTarget

Detailed Description

Abstract base class for every object that can be drawn into a render window. -

- -

-Definition at line 58 of file Drawable.hpp.

Constructor & Destructor Documentation

+

Definition at line 58 of file Drawable.hpp.

+

Constructor & Destructor Documentation

@@ -178,7 +185,7 @@ Definition at line 58 o ) - +
@@ -196,18 +203,20 @@ Default constructor. +

Definition at line 39 of file Drawable.cpp.

+

- +

- + - +
virtual sf::Drawable::~Drawable sf::Drawable::~Drawable (  )  [virtual] [virtual]
@@ -217,364 +226,367 @@ Default constructor. Virtual destructor.

+

Definition at line 56 of file Drawable.cpp.

+

Member Function Documentation

- +
- + - - - - - - - - - - - - - + + +
void sf::Drawable::SetPosition Blend::Mode sf::Drawable::GetBlendMode (float  X,
float  Y 
)  )  const

-Set the position of the object (take 2 values). +Get the current blending mode.

-

Parameters:
- - - -
X : New X coordinate
Y : New Y coordinate
-
+
Returns:
Current blending mode
+ +

Definition at line 258 of file Drawable.cpp.

- +

- + - - + - +
void sf::Drawable::SetPosition const Vector2f & sf::Drawable::GetCenter (const Vector2f &  Position  )  const

-Set the position of the object (take a 2D vector). +Get the center of the object.

-

Parameters:
- - -
Position : New position
-
+
Returns:
Current position of the center
+ +

Definition at line 231 of file Drawable.cpp.

- +

- + - - + - +
void sf::Drawable::SetX const Color & sf::Drawable::GetColor (float  X  )  const

-Set the X position of the object. +Get the color of the object.

-

Parameters:
- - -
X : New X coordinate
-
+
Returns:
Current color
+ +

Definition at line 249 of file Drawable.cpp.

- +

- + - - + - +
void sf::Drawable::SetY const Matrix3 & sf::Drawable::GetInverseMatrix (float  Y  )  const [protected]

-Set the Y position of the object. +Get the inverse transform matrix of the drawable.

-

Parameters:
- - -
Y : New Y coordinate
-
+
Returns:
Inverse transform matrix
+ +

Definition at line 350 of file Drawable.cpp.

- +

- + - - - - - - - - + + + +
void sf::Drawable::SetScale const Matrix3 & sf::Drawable::GetMatrix (float  ScaleX,
float  ScaleY   )  const [protected]
+
+
+ +

+Get the transform matrix of the drawable. +

+

Returns:
Transform matrix
+ +

Definition at line 334 of file Drawable.cpp.

+ +
+

+ +

+
+ - - - + + + + +
)const Vector2f & sf::Drawable::GetPosition (  )  const

-Set the scale of the object (take 2 values). +Get the position of the object.

-

Parameters:
- - - -
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
-
+
Returns:
Current position
+ +

Definition at line 213 of file Drawable.cpp.

- +

- + - - + - +
void sf::Drawable::SetScale float sf::Drawable::GetRotation (const Vector2f &  Scale  )  const

-Set the scale of the object (take a 2D vector). +Get the orientation of the object.

-

Parameters:
- - -
Scale : New scale (both values must be strictly positive)
-
+Rotation is always in the range [0, 360]

+

Returns:
Current rotation, in degrees
+ +

Definition at line 240 of file Drawable.cpp.

- +

- + - - + - +
void sf::Drawable::SetScaleX const Vector2f & sf::Drawable::GetScale (float  FactorX  )  const

-Set the X scale factor of the object. +Get the current scale of the object.

-

Parameters:
- - -
X : New X scale factor
-
+
Returns:
Current scale factor (always positive)
+ +

Definition at line 222 of file Drawable.cpp.

- +

- + - - + + - +
void sf::Drawable::SetScaleY void sf::Drawable::Move (float  FactorY const Vector2f &  Offset  ) 

-Set the Y scale factor of the object. +Move the object of a given offset (take a 2D vector).

Parameters:
- +
Y : New Y scale factor
Offset : Amount of units to move the object of
+

Definition at line 278 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::SetCenter void sf::Drawable::Move ( float  CenterX, OffsetX,
float  CenterY  OffsetY 
)

-Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). +Move the object of a given offset (take 2 values).

-The default center is (0, 0)

Parameters:
- - + +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
OffsetX : X offset
OffsetY : Y offset
+

Definition at line 268 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetCenter void sf::Drawable::Rotate (const Vector2f &  Center float  Angle  ) 

-Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector). +Rotate the object.

-The default center is (0, 0)

Parameters:
- +
Center : New center
Angle : Angle of rotation, in degrees
+

Definition at line 306 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetRotation void sf::Drawable::Scale (float  Rotation const Vector2f &  Factor  ) 

-Set the orientation of the object. +Scale the object (take a 2D vector).

Parameters:
- +
Rotation : Angle of rotation, in degrees
Factor : Scaling factors (both values must be strictly positive)
+

Definition at line 297 of file Drawable.cpp.

+

- +

- + - - - - + + + + + + + + + + + + +
void sf::Drawable::SetColor void sf::Drawable::Scale (const Color &  Col  ) float  FactorX,
float  FactorY 
)

-Set the color of the object. +Scale the object (take 2 values).

-The default color is white

Parameters:
- + +
Col : New color
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
+

Definition at line 287 of file Drawable.cpp.

+

@@ -587,7 +599,7 @@ The default color is white

Blend::Mode  Mode  )  - + @@ -599,402 +611,462 @@ Set the blending mode for the object. The default blend mode is Blend::Alpha

Parameters:
- +
Mode : New blending mode
Mode : New blending mode
+The default blend mode is Blend::Alpha +

Definition at line 204 of file Drawable.cpp.

- +

- + - + + - +
const Vector2f& sf::Drawable::GetPosition void sf::Drawable::SetCenter ( const Vector2f &  Center  )  const

-Get the position of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

-

Returns:
Current position
+Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

+The default center is (0, 0)

+

Parameters:
+ + +
Center : New center
+
+The default center is (0, 0) +

Definition at line 171 of file Drawable.cpp.

- +

- + - - - + + -
const Vector2f& sf::Drawable::GetScale void sf::Drawable::SetCenter (  )  constfloat  CenterX,
-
-
- -

-Get the current scale of the object. -

-

Returns:
Current scale factor (always positive)
- -
-

- -

-
- - - - - - + + + + + + + + +
const Vector2f& sf::Drawable::GetCenter (  )  constfloat  CenterY 
)

-Get the center of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

-

Returns:
Current position of the center
+Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+The default center is (0, 0)

+

Parameters:
+ + + +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
+
+The default center is (0, 0) +

Definition at line 157 of file Drawable.cpp.

- +

- + - + + - +
float sf::Drawable::GetRotation void sf::Drawable::SetColor ( const Color &  Col  )  const

-Get the orientation of the object. +Set the color of the object.

-Rotation is always in the range [0, 360]

-

Returns:
Current rotation, in degrees
+The default color is white

+

Parameters:
+ + +
Col : New color
+
+The default color is white +

Definition at line 194 of file Drawable.cpp.

- +

- + - + + - +
const Color& sf::Drawable::GetColor void sf::Drawable::SetPosition ( const Vector2f &  Position  )  const

-Get the color of the object. +Set the position of the object (take a 2D vector).

-

Returns:
Current color
+
Parameters:
+ + +
Position : New position
+
+ +

Definition at line 75 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + + +
Blend::Mode sf::Drawable::GetBlendMode void sf::Drawable::SetPosition (  )  constfloat  X,
float  Y 
)

-Get the current blending mode. +Set the position of the object (take 2 values).

-

Returns:
Current blending mode
+
Parameters:
+ + + +
X : New X coordinate
Y : New Y coordinate
+
+ +

Definition at line 65 of file Drawable.cpp.

- +

- + - - - - - - - - - + + - -
void sf::Drawable::Move void sf::Drawable::SetRotation ( float  OffsetX,
float  OffsetY 
Rotation  )  )

-Move the object of a given offset (take 2 values). +Set the orientation of the object.

Parameters:
- - +
OffsetX : X offset
OffsetY : Y offset
Rotation : Angle of rotation, in degrees
+

Definition at line 180 of file Drawable.cpp.

+

- +

- + - + - +
void sf::Drawable::Move void sf::Drawable::SetScale ( const Vector2f &  Offset Scale  ) 

-Move the object of a given offset (take a 2D vector). +Set the scale of the object (take a 2D vector).

Parameters:
- +
Offset : Amount of units to move the object of
Scale : New scale (both values must be strictly positive)
+

Definition at line 117 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::Scale void sf::Drawable::SetScale ( float  FactorX, ScaleX,
float  FactorY  ScaleY 
)

-Scale the object (take 2 values). +Set the scale of the object (take 2 values).

Parameters:
- - + +
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
+

Definition at line 107 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Scale void sf::Drawable::SetScaleX (const Vector2f &  Factor float  FactorX  ) 

-Scale the object (take a 2D vector). +Set the X scale factor of the object.

Parameters:
- +
Factor : Scaling factors (both values must be strictly positive)
X : New X scale factor
+

Definition at line 127 of file Drawable.cpp.

+

- +

- + - + - +
void sf::Drawable::Rotate void sf::Drawable::SetScaleY ( float  Angle FactorY  ) 

-Rotate the object. +Set the Y scale factor of the object.

Parameters:
- +
Angle : Angle of rotation, in degrees
Y : New Y scale factor
+

Definition at line 141 of file Drawable.cpp.

+

- +

- + - - + + - +
sf::Vector2f sf::Drawable::TransformToLocal void sf::Drawable::SetX (const sf::Vector2f &  Point float  X  )  const

-Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point). +Set the X position of the object.

Parameters:
- +
Point : Point to transform
X : New X coordinate
-
Returns:
Transformed point
+ +

Definition at line 85 of file Drawable.cpp.

- +

- + - - + + - +
sf::Vector2f sf::Drawable::TransformToGlobal void sf::Drawable::SetY (const sf::Vector2f &  Point float  Y  )  const

-Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point). +Set the Y position of the object.

Parameters:
- +
Point : Point to transform
Y : New Y coordinate
-
Returns:
Transformed point
+ +

Definition at line 96 of file Drawable.cpp.

- +

- + - + + - +
const Matrix3& sf::Drawable::GetMatrix sf::Vector2f sf::Drawable::TransformToGlobal ( const sf::Vector2f &  Point  )  const [protected] const

-Get the transform matrix of the drawable. +Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

-

Returns:
Transform matrix
+Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+ +

Definition at line 325 of file Drawable.cpp.

- +

- + - + + - +
const Matrix3& sf::Drawable::GetInverseMatrix sf::Vector2f sf::Drawable::TransformToLocal ( const sf::Vector2f &  Point  )  const [protected] const

-Get the inverse transform matrix of the drawable. +Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

-

Returns:
Inverse transform matrix
+Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+ +

Definition at line 316 of file Drawable.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Event Member List

This is the complete list of members for sf::Event, including all inherited members.

- + - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + -
Closed enum valuesf::Event
Closed enum value (defined in sf::Event)sf::Event
EventType enum namesf::Event
GainedFocus enum valuesf::Event
JoyButtonsf::Event
JoyButtonPressed enum valuesf::Event
JoyButtonReleased enum valuesf::Event
JoyMovesf::Event
JoyMoved enum valuesf::Event
Keysf::Event
KeyPressed enum valuesf::Event
KeyReleased enum valuesf::Event
LostFocus enum valuesf::Event
MouseButtonsf::Event
MouseButtonPressed enum valuesf::Event
MouseButtonReleased enum valuesf::Event
MouseEntered enum valuesf::Event
MouseLeft enum valuesf::Event
MouseMovesf::Event
MouseMoved enum valuesf::Event
MouseWheelsf::Event
MouseWheelMoved enum valuesf::Event
Resized enum valuesf::Event
Sizesf::Event
Textsf::Event
TextEntered enum valuesf::Event
GainedFocus enum value (defined in sf::Event)sf::Event
JoyButton (defined in sf::Event)sf::Event
JoyButtonPressed enum value (defined in sf::Event)sf::Event
JoyButtonReleased enum value (defined in sf::Event)sf::Event
JoyMove (defined in sf::Event)sf::Event
JoyMoved enum value (defined in sf::Event)sf::Event
Key (defined in sf::Event)sf::Event
KeyPressed enum value (defined in sf::Event)sf::Event
KeyReleased enum value (defined in sf::Event)sf::Event
LostFocus enum value (defined in sf::Event)sf::Event
MouseButton (defined in sf::Event)sf::Event
MouseButtonPressed enum value (defined in sf::Event)sf::Event
MouseButtonReleased enum value (defined in sf::Event)sf::Event
MouseEntered enum value (defined in sf::Event)sf::Event
MouseLeft enum value (defined in sf::Event)sf::Event
MouseMove (defined in sf::Event)sf::Event
MouseMoved enum value (defined in sf::Event)sf::Event
MouseWheel (defined in sf::Event)sf::Event
MouseWheelMoved enum value (defined in sf::Event)sf::Event
Resized enum value (defined in sf::Event)sf::Event
Size (defined in sf::Event)sf::Event
Text (defined in sf::Event)sf::Event
TextEntered enum value (defined in sf::Event)sf::Event
Typesf::Event
+

+ - -
- + + -
- -
-
-sf::Event
+

sf::Event Class Reference

Event defines a system event and its parameters. More...

#include <Event.hpp> +

+

List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + @@ -80,56 +110,29 @@ - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - -

Classes

struct  JoyButtonEvent
 Joystick buttons events parameters. More...
struct  JoyMoveEvent
 Joystick axis move event parameters. More...
struct  KeyEvent
 Keyboard event parameters. More...
struct  MouseButtonEvent
 Mouse buttons events parameters. More...
struct  MouseMoveEvent
 Mouse move event parameters. More...
struct  MouseWheelEvent
 Mouse wheel events parameters. More...
struct  SizeEvent
 Size events parameters. More...
struct  TextEvent
 Text event parameters. More...

Public Types

enum  EventType {
-  Closed, +  Closed,
-  Resized, +  Resized,
-  LostFocus, +  LostFocus,
-  GainedFocus, +  GainedFocus,
-  TextEntered, +  TextEntered,
-  KeyPressed, +  KeyPressed,
-  KeyReleased, +  KeyReleased,
-  MouseWheelMoved, +  MouseWheelMoved,
-  MouseButtonPressed, +  MouseButtonPressed,
-  MouseButtonReleased, +  MouseButtonReleased,
-  MouseMoved, +  MouseMoved,
-  MouseEntered, +  MouseEntered,
-  MouseLeft, +  MouseLeft,
-  JoyButtonPressed, +  JoyButtonPressed,
-  JoyButtonReleased, +  JoyButtonReleased,
-  JoyMoved +  JoyMoved
}
union {
   KeyEvent   Key
   KeyEvent   Key
   TextEvent   Text
   TextEvent   Text
   MouseMoveEvent   MouseMove
   MouseMoveEvent   MouseMove
   MouseButtonEvent   MouseButton
   MouseButtonEvent   MouseButton
   MouseWheelEvent   MouseWheel
   MouseWheelEvent   MouseWheel
   JoyMoveEvent   JoyMove
   JoyMoveEvent   JoyMove
   JoyButtonEvent   JoyButton
   JoyButtonEvent   JoyButton
   SizeEvent   Size
   SizeEvent   Size
}; 

Classes

struct  JoyButtonEvent
 Joystick buttons events parameters. More...
struct  JoyMoveEvent
 Joystick axis move event parameters. More...
struct  KeyEvent
 Keyboard event parameters. More...
struct  MouseButtonEvent
 Mouse buttons events parameters. More...
struct  MouseMoveEvent
 Mouse move event parameters. More...
struct  MouseWheelEvent
 Mouse wheel events parameters. More...
struct  SizeEvent
 Size events parameters. More...
struct  TextEvent
 Text event parameters. More...

Detailed Description

Event defines a system event and its parameters. -

- -

-Definition at line 191 of file Event.hpp.

Member Enumeration Documentation

+

Definition at line 191 of file Event.hpp.

+

Member Enumeration Documentation

@@ -144,45 +147,9 @@ Definition at line 191 of

Enumeration of the different types of events.

-

Enumerator:
- - - - - - - - - - - - - - - - - -
Closed  -
Resized  -
LostFocus  -
GainedFocus  -
TextEntered  -
KeyPressed  -
KeyReleased  -
MouseWheelMoved  -
MouseButtonPressed  -
MouseButtonReleased  -
MouseMoved  -
MouseEntered  -
MouseLeft  -
JoyButtonPressed  -
JoyButtonReleased  -
JoyMoved  -
-
-

-Definition at line 272 of file Event.hpp. +

Definition at line 272 of file Event.hpp.

+

Member Data Documentation

@@ -201,12 +168,13 @@ Definition at line 272 of Type of the event.

-

-Definition at line 295 of file Event.hpp. +

Definition at line 295 of file Event.hpp.

+

The documentation for this class was generated from the following file: +
- -
- -
-
- + + +

sf::Font Member List

This is the complete list of members for sf::Font, including all inherited members.

- - - - + + + + -
Font()sf::Font
GetCharacterSize() constsf::Font
GetDefaultFont()sf::Font [static]
GetGlyph(Uint32 CodePoint) const sf::Font
GetImage() constsf::Font
GetCharacterSize() const sf::Font
GetDefaultFont()sf::Font [static]
GetGlyph(Uint32 CodePoint) const sf::Font
GetImage() const sf::Font
LoadFromFile(const std::string &Filename, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)sf::Font
LoadFromMemory(const char *Data, std::size_t SizeInBytes, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)sf::Font
operator=(const Resource< Font > &Other)sf::Resource< Font > [protected]
Resource()sf::Resource< Font > [protected]
Resource(const Resource< Font > &Copy)sf::Resource< Font > [protected]
~Resource()sf::Resource< Font > [protected]
+

+ - -
- + + -
- -
-
-sf::Font
-

sf::Font Class Reference

Font is the low-level class for loading and manipulating character fonts. +
+

sf::Font Class Reference

Font is the low-level class for loading and manipulating character fonts. More...

#include <Font.hpp>

-

Inheritance diagram for sf::Font: +

+Inheritance diagram for sf::Font:
+
+

sf::Resource< Font > +
+ +

List of all members. @@ -51,28 +60,26 @@ - + - - + + - - + + - + - + - +

Public Member Functions

bool LoadFromMemory (const char *Data, std::size_t SizeInBytes, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)
 Load the font from a file in memory.
unsigned int GetCharacterSize () const
unsigned int GetCharacterSize () const
 Get the base size of characters in the font; All glyphs dimensions are based on this value.
const Glyph & GetGlyph (Uint32 CodePoint) const
 Get the base size of characters in the font; All glyphs dimensions are based on this value.
const Glyph & GetGlyph (Uint32 CodePoint) const
 Get the description of a glyph (character) given by its unicode value.
const Image & GetImage () const
 Get the description of a glyph (character) given by its unicode value.
const Image & GetImage () const
 Get the image containing the rendered characters (glyphs).
 Get the image containing the rendered characters (glyphs).

Static Public Member Functions

static const Font & GetDefaultFont ()
static const Font & GetDefaultFont ()
 Get the SFML default built-in font (Arial).
 Get the SFML default built-in font (Arial).

Detailed Description

Font is the low-level class for loading and manipulating character fonts.

This class is meant to be used by sf::String -

- -

-Definition at line 54 of file Font.hpp.

Constructor & Destructor Documentation

+

Definition at line 54 of file Font.hpp.

+

Constructor & Destructor Documentation

@@ -82,7 +89,7 @@ Definition at line 54 of fi (  )  - +
@@ -92,9 +99,115 @@ Definition at line 54 of fi Default constructor.

+

Definition at line 64 of file Font.cpp.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
unsigned int sf::Font::GetCharacterSize (  )  const
+
+
+ +

+Get the base size of characters in the font; All glyphs dimensions are based on this value. +

+Get the base size of characters in the font; All glyphs dimensions are based on this value.

+

Returns:
Base size of characters
+ +

Definition at line 120 of file Font.cpp.

+ +
+

+ +

+
+ + + + + + + + +
const Font & sf::Font::GetDefaultFont (  )  [static]
+
+
+ +

+Get the SFML default built-in font (Arial). +

+

Returns:
Instance of the default font
+ +

Definition at line 159 of file Font.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
const Glyph & sf::Font::GetGlyph (Uint32  CodePoint  )  const
+
+
+ +

+Get the description of a glyph (character) given by its unicode value. +

+Get the description of a glyph (character) given by its unicode value.

+

Parameters:
+ + +
CodePoint : Unicode value of the character to get
+
+
Returns:
Glyph's visual settings, or an invalid glyph if character not found
+ +

Definition at line 130 of file Font.cpp.

+ +
+

+ +

+
+ + + + + + + + +
const Image & sf::Font::GetImage (  )  const
+
+
+ +

+Get the image containing the rendered characters (glyphs). +

+

Returns:
Image containing glyphs
+ +

Definition at line 150 of file Font.cpp.

+ +
+

@@ -120,7 +233,7 @@ Default constructor. ) - +
@@ -138,6 +251,8 @@ Load the font from a file.
Returns:
True if loading was successful
+

Definition at line 74 of file Font.cpp.

+

@@ -171,7 +286,7 @@ Load the font from a file. ) - +

@@ -190,104 +305,13 @@ Load the font from a file in memory.
Returns:
True if loading was successful
- -

- -

-
- - - - - - - - -
unsigned int sf::Font::GetCharacterSize (  )  const
-
-
- -

-Get the base size of characters in the font; All glyphs dimensions are based on this value. -

-

Returns:
Base size of characters
+

Definition at line 93 of file Font.cpp.

- -

-
- - - - - - - - - -
const Glyph& sf::Font::GetGlyph (Uint32  CodePoint  )  const
+
The documentation for this class was generated from the following files:
-
- -

-Get the description of a glyph (character) given by its unicode value. -

-

Parameters:
- - -
CodePoint : Unicode value of the character to get
-
-
Returns:
Glyph's visual settings, or an invalid glyph if character not found
- -
-

- -

-
- - - - - - - - -
const Image& sf::Font::GetImage (  )  const
-
-
- -

-Get the image containing the rendered characters (glyphs). -

-

Returns:
Image containing glyphs
- -
-

- -

-
- - - - - - - - -
static const Font& sf::Font::GetDefaultFont (  )  [static]
-
-
- -

-Get the SFML default built-in font (Arial). -

-

Returns:
Instance of the default font
- -
-

-

The documentation for this class was generated from the following file: - -
- -
-
- + + +

sf::Ftp Member List

This is the complete list of members for sf::Ftp, including all inherited members.

- - - - - - - + + + + + + + - - - - - - + + + + + + - - + + - + -
Ascii enum valuesf::Ftp
Binary enum valuesf::Ftp
ChangeDirectory(const std::string &Directory)sf::Ftp
Connect(const IPAddress &Server, unsigned short Port=21, float Timeout=0.f)sf::Ftp
DataChannel classsf::Ftp [friend]
DeleteDirectory(const std::string &Name)sf::Ftp
DeleteFile(const std::string &Name)sf::Ftp
Disconnect()sf::Ftp
Download(const std::string &DistantFile, const std::string &DestPath, TransferMode Mode=Binary)sf::Ftp
ChangeDirectory(const std::string &Directory)sf::Ftp
Connect(const IPAddress &Server, unsigned short Port=21, float Timeout=0.f)sf::Ftp
DataChannel (defined in sf::Ftp)sf::Ftp [friend]
DeleteDirectory(const std::string &Name)sf::Ftp
DeleteFile(const std::string &Name)sf::Ftp
Disconnect()sf::Ftp
Download(const std::string &DistantFile, const std::string &DestPath, TransferMode Mode=Binary)sf::Ftp
Ebcdic enum valuesf::Ftp
GetDirectoryListing(const std::string &Directory="")sf::Ftp
GetWorkingDirectory()sf::Ftp
KeepAlive()sf::Ftp
Login()sf::Ftp
Login(const std::string &UserName, const std::string &Password)sf::Ftp
MakeDirectory(const std::string &Name)sf::Ftp
GetDirectoryListing(const std::string &Directory="")sf::Ftp
GetWorkingDirectory()sf::Ftp
KeepAlive()sf::Ftp
Login()sf::Ftp
Login(const std::string &UserName, const std::string &Password)sf::Ftp
MakeDirectory(const std::string &Name)sf::Ftp
NonCopyable()sf::NonCopyable [inline, private]
ParentDirectory()sf::Ftp
RenameFile(const std::string &File, const std::string &NewName)sf::Ftp
ParentDirectory()sf::Ftp
RenameFile(const std::string &File, const std::string &NewName)sf::Ftp
TransferMode enum namesf::Ftp
Upload(const std::string &LocalFile, const std::string &DestPath, TransferMode Mode=Binary)sf::Ftp
Upload(const std::string &LocalFile, const std::string &DestPath, TransferMode Mode=Binary)sf::Ftp
~Ftp()sf::Ftp
+

+ - -
- -
-
- -
-
-sf::Ftp
+ + +

sf::Ftp Class Reference

This class provides methods for manipulating the FTP protocol (described in RFC 959). More...

#include <Ftp.hpp>

-

Inheritance diagram for sf::Ftp: +

+Inheritance diagram for sf::Ftp:
+
+

sf::NonCopyable +
+ +

List of all members. + + + + + + + + + + + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - - - - - - +class  - - - -

Classes

class  DataChannel
class  DirectoryResponse
 Specialization of FTP response returning a directory. More...
class  ListingResponse
 Specialization of FTP response returning a filename lisiting. More...
class  Response
 This class wraps a FTP response, which is basically :
    +
  • a status code
  • a message.
+ More...

Public Types

enum  TransferMode {
  Binary, @@ -56,76 +79,62 @@
 ~Ftp ()
 Destructor -- close the connection with the server.
Response Connect (const IPAddress &Server, unsigned short Port=21, float Timeout=0.f)
Response Connect (const IPAddress &Server, unsigned short Port=21, float Timeout=0.f)
 Connect to the specified FTP server.
Response Login ()
 Connect to the specified FTP server.
Response Login ()
 Log in using anonymous account.
Response Login (const std::string &UserName, const std::string &Password)
 Log in using anonymous account.
Response Login (const std::string &UserName, const std::string &Password)
 Log in using a username and a password.
Response Disconnect ()
 Log in using a username and a password.
Response Disconnect ()
 Close the connection with FTP server.
Response KeepAlive ()
 Close the connection with FTP server.
Response KeepAlive ()
 Send a null command just to prevent from being disconnected.
DirectoryResponse GetWorkingDirectory ()
 Send a null command just to prevent from being disconnected.
DirectoryResponse GetWorkingDirectory ()
 Get the current working directory.
ListingResponse GetDirectoryListing (const std::string &Directory="")
 Get the current working directory.
ListingResponse GetDirectoryListing (const std::string &Directory="")
 Get the contents of the given directory (subdirectories and files).
Response ChangeDirectory (const std::string &Directory)
 Get the contents of the given directory (subdirectories and files).
Response ChangeDirectory (const std::string &Directory)
 Change the current working directory.
Response ParentDirectory ()
 Change the current working directory.
Response ParentDirectory ()
 Go to the parent directory of the current one.
Response MakeDirectory (const std::string &Name)
 Go to the parent directory of the current one.
Response MakeDirectory (const std::string &Name)
 Create a new directory.
Response DeleteDirectory (const std::string &Name)
 Create a new directory.
Response DeleteDirectory (const std::string &Name)
 Remove an existing directory.
Response RenameFile (const std::string &File, const std::string &NewName)
 Remove an existing directory.
Response RenameFile (const std::string &File, const std::string &NewName)
 Rename a file.
Response DeleteFile (const std::string &Name)
 Rename a file.
Response DeleteFile (const std::string &Name)
 Remove an existing file.
Response Download (const std::string &DistantFile, const std::string &DestPath, TransferMode Mode=Binary)
 Remove an existing file.
Response Download (const std::string &DistantFile, const std::string &DestPath, TransferMode Mode=Binary)
 Download a file from the server.
Response Upload (const std::string &LocalFile, const std::string &DestPath, TransferMode Mode=Binary)
 Download a file from the server.
Response Upload (const std::string &LocalFile, const std::string &DestPath, TransferMode Mode=Binary)
 Upload a file to the server.
 Upload a file to the server.

Friends

-class DataChannel

Classes

class  DirectoryResponse
 Specialization of FTP response returning a directory. More...
class  ListingResponse
DataChannel
 Specialization of FTP response returning a filename lisiting. More...
class  Response
 This class wraps a FTP response, which is basically :
    -
  • a status code
  • a message.
- More...

Detailed Description

This class provides methods for manipulating the FTP protocol (described in RFC 959).

It provides easy access and transfers to remote directories and files on a FTP server -

- -

-Definition at line 47 of file Ftp.hpp.

Member Enumeration Documentation

+

Definition at line 47 of file Ftp.hpp.

+

Member Enumeration Documentation

@@ -151,8 +160,8 @@ Text mode using EBCDIC encoding. -

-Definition at line 54 of file Ftp.hpp. +

Definition at line 54 of file Ftp.hpp.

+

Constructor & Destructor Documentation

@@ -165,7 +174,7 @@ Definition at line 54 of fil (  )  - +
@@ -175,15 +184,47 @@ Definition at line 54 of fil Destructor -- close the connection with the server.

+

Definition at line 186 of file Ftp.cpp.

+

Member Function Documentation

- + +
+
+ + + + + + + + + +
Ftp::Response sf::Ftp::ChangeDirectory (const std::string &  Directory  ) 
+
+
+ +

+Change the current working directory. +

+

Parameters:
+ + +
Directory : New directory, relative to the current one
+
+
Returns:
Server response to the request
+ +

Definition at line 291 of file Ftp.cpp.

+ +
+

+

- + @@ -203,7 +244,7 @@ Destructor -- close the connection with the server. - +
Response sf::Ftp::Connect Ftp::Response sf::Ftp::Connect ( const IPAddress &  Server,
)
@@ -221,78 +262,80 @@ Connect to the specified FTP server.
Returns:
Server response to the request
+

Definition at line 195 of file Ftp.cpp.

+

- +

- + - + + - +
Response sf::Ftp::Login Ftp::Response sf::Ftp::DeleteDirectory ( const std::string &  Name  ) 

-Log in using anonymous account. +Remove an existing directory.

+

Parameters:
+ + +
Name : Name of the directory to remove
+
Returns:
Server response to the request
+

Definition at line 318 of file Ftp.cpp.

+

- +

- + - - - - - - - - - + + - -
Response sf::Ftp::Login Ftp::Response sf::Ftp::DeleteFile ( const std::string &  UserName,
const std::string &  Password 
Name  )  )

-Log in using a username and a password. +Remove an existing file.

Parameters:
- - +
UserName : User name
Password : Password
Name : File to remove
Returns:
Server response to the request
+

Definition at line 340 of file Ftp.cpp.

+

- +

- + - +
Response sf::Ftp::Disconnect Ftp::Response sf::Ftp::Disconnect (  ) 
@@ -303,63 +346,68 @@ Close the connection with FTP server.

Returns:
Server response to the request
+

Definition at line 231 of file Ftp.cpp.

+

- +

- + - - - + + -
Response sf::Ftp::KeepAlive Ftp::Response sf::Ftp::Download (  ) const std::string &  DistantFile,
-
-
- -

-Send a null command just to prevent from being disconnected. -

-

Returns:
Server response to the request
- -
-

- -

-
- - - - - - + + + + + + + + + + + + + + +
DirectoryResponse sf::Ftp::GetWorkingDirectory (  ) const std::string &  DestPath,
TransferMode  Mode = Binary 
)

-Get the current working directory. +Download a file from the server.

+

Parameters:
+ + + + +
DistantFile : Path of the distant file to download
DestPath : Where to put to file on the local computer
Mode : Transfer mode (binary by default)
+
Returns:
Server response to the request
+

Definition at line 349 of file Ftp.cpp.

+

- +

- + - +
ListingResponse sf::Ftp::GetDirectoryListing Ftp::ListingResponse sf::Ftp::GetDirectoryListing ( const std::string &  Directory = ""  ) 
@@ -368,6 +416,7 @@ Get the current working directory.

Get the contents of the given directory (subdirectories and files).

+Get the contents of the given directory (subdirectories and files).

Parameters:
@@ -375,231 +424,222 @@ Get the contents of the given directory (subdirectories and files).
Returns:
Server response to the request
+

Definition at line 264 of file Ftp.cpp.

+

- +

Directory : Directory to list ("" by default, the current one)
- + - - + - +
Response sf::Ftp::ChangeDirectory Ftp::DirectoryResponse sf::Ftp::GetWorkingDirectory (const std::string &  Directory  ) 

-Change the current working directory. +Get the current working directory.

-

Parameters:
- - -
Directory : New directory, relative to the current one
-
Returns:
Server response to the request
+

Definition at line 254 of file Ftp.cpp.

+

- +

- + - +
Response sf::Ftp::ParentDirectory Ftp::Response sf::Ftp::KeepAlive (  ) 

-Go to the parent directory of the current one. +Send a null command just to prevent from being disconnected.

Returns:
Server response to the request
+

Definition at line 245 of file Ftp.cpp.

+

- +

- + - - - + + + + + + + + + + + +
Response sf::Ftp::MakeDirectory Ftp::Response sf::Ftp::Login ( const std::string &  Name  )  UserName,
const std::string &  Password 
)

-Create a new directory. +Log in using a username and a password.

Parameters:
- + +
Name : Name of the directory to create
UserName : User name
Password : Password
Returns:
Server response to the request
+

Definition at line 218 of file Ftp.cpp.

+

- +

- + - - + - +
Response sf::Ftp::DeleteDirectory Ftp::Response sf::Ftp::Login (const std::string &  Name  ) 

-Remove an existing directory. +Log in using anonymous account.

-

Parameters:
- - -
Name : Name of the directory to remove
-
Returns:
Server response to the request
+

Definition at line 209 of file Ftp.cpp.

+

- +

- + - - - - - - - - - + + - -
Response sf::Ftp::RenameFile Ftp::Response sf::Ftp::MakeDirectory ( const std::string &  File,
const std::string &  NewName 
Name  )  )

-Rename a file. +Create a new directory.

Parameters:
- - +
File : File to rename
NewName : New name
Name : Name of the directory to create
Returns:
Server response to the request
+

Definition at line 309 of file Ftp.cpp.

+

- +

- + - - + - +
Response sf::Ftp::DeleteFile Ftp::Response sf::Ftp::ParentDirectory (const std::string &  Name  ) 

-Remove an existing file. +Go to the parent directory of the current one.

-

Parameters:
- - -
Name : File to remove
-
Returns:
Server response to the request
+

Definition at line 300 of file Ftp.cpp.

+

- +

- + - + - - - - - - - + - +
Response sf::Ftp::Download Ftp::Response sf::Ftp::RenameFile ( const std::string &  DistantFile, File,
const std::string &  DestPath,
TransferMode  Mode = Binary  NewName 
)

-Download a file from the server. +Rename a file.

Parameters:
- - - + +
DistantFile : Path of the distant file to download
DestPath : Where to put to file on the local computer
Mode : Transfer mode (binary by default)
File : File to rename
NewName : New name
Returns:
Server response to the request
+

Definition at line 327 of file Ftp.cpp.

+

- +

- + @@ -619,7 +659,7 @@ Download a file from the server. - +
Response sf::Ftp::Upload Ftp::Response sf::Ftp::Upload ( const std::string &  LocalFile,
)
@@ -637,10 +677,13 @@ Upload a file to the server.
Returns:
Server response to the request
+

Definition at line 395 of file Ftp.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- + + -
- -
-

sf::Ftp::DirectoryResponse Member List

This is the complete list of members for sf::Ftp::DirectoryResponse, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BadCommandSequence enum valuesf::Ftp::Response
ClosingConnection enum valuesf::Ftp::Response
ClosingDataConnection enum valuesf::Ftp::Response
CommandNotImplemented enum valuesf::Ftp::Response
CommandUnknown enum valuesf::Ftp::Response
ConnectionClosed enum valuesf::Ftp::Response
ConnectionFailed enum valuesf::Ftp::Response
DataConnectionAlreadyOpened enum valuesf::Ftp::Response
DataConnectionOpened enum valuesf::Ftp::Response
DataConnectionUnavailable enum valuesf::Ftp::Response
DirectoryOk enum valuesf::Ftp::Response
DirectoryResponse(Response Resp)sf::Ftp::DirectoryResponse
DirectoryStatus enum valuesf::Ftp::Response
EnteringPassiveMode enum valuesf::Ftp::Response
FileActionAborted enum valuesf::Ftp::Response
FileActionOk enum valuesf::Ftp::Response
FilenameNotAllowed enum valuesf::Ftp::Response
FileStatus enum valuesf::Ftp::Response
FileUnavailable enum valuesf::Ftp::Response
GetDirectory() constsf::Ftp::DirectoryResponse
GetMessage() constsf::Ftp::Response
GetStatus() constsf::Ftp::Response
HelpMessage enum valuesf::Ftp::Response
InsufficientStorageSpace enum valuesf::Ftp::Response
InvalidFile enum valuesf::Ftp::Response
InvalidResponse enum valuesf::Ftp::Response
IsOk() constsf::Ftp::Response
LocalError enum valuesf::Ftp::Response
LoggedIn enum valuesf::Ftp::Response
NeedAccountToLogIn enum valuesf::Ftp::Response
NeedAccountToStore enum valuesf::Ftp::Response
NeedInformation enum valuesf::Ftp::Response
NeedPassword enum valuesf::Ftp::Response
NotEnoughMemory enum valuesf::Ftp::Response
NotLoggedIn enum valuesf::Ftp::Response
Ok enum valuesf::Ftp::Response
OpeningDataConnection enum valuesf::Ftp::Response
PageTypeUnknown enum valuesf::Ftp::Response
ParameterNotImplemented enum valuesf::Ftp::Response
ParametersUnknown enum valuesf::Ftp::Response
PointlessCommand enum valuesf::Ftp::Response
Response(Status Code=InvalidResponse, const std::string &Message="")sf::Ftp::Response
RestartMarkerReply enum valuesf::Ftp::Response
ServiceReady enum valuesf::Ftp::Response
ServiceReadySoon enum valuesf::Ftp::Response
ServiceUnavailable enum valuesf::Ftp::Response
Status enum namesf::Ftp::Response
SystemStatus enum valuesf::Ftp::Response
SystemType enum valuesf::Ftp::Response
TransferAborted enum valuesf::Ftp::Response
+

+

sf::Ftp::Ftp::DirectoryResponse Member List

This is the complete list of members for sf::Ftp::Ftp::DirectoryResponse, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BadCommandSequence enum valuesf::Ftp::Ftp::Response
ClosingConnection enum valuesf::Ftp::Ftp::Response
ClosingDataConnection enum valuesf::Ftp::Ftp::Response
CommandNotImplemented enum valuesf::Ftp::Ftp::Response
CommandUnknown enum valuesf::Ftp::Ftp::Response
ConnectionClosed enum valuesf::Ftp::Ftp::Response
ConnectionFailed enum valuesf::Ftp::Ftp::Response
DataConnectionAlreadyOpened enum valuesf::Ftp::Ftp::Response
DataConnectionOpened enum valuesf::Ftp::Ftp::Response
DataConnectionUnavailable enum valuesf::Ftp::Ftp::Response
DirectoryOk enum valuesf::Ftp::Ftp::Response
DirectoryResponse(Response Resp)sf::Ftp::Ftp::DirectoryResponse
DirectoryStatus enum valuesf::Ftp::Ftp::Response
EnteringPassiveMode enum valuesf::Ftp::Ftp::Response
FileActionAborted enum valuesf::Ftp::Ftp::Response
FileActionOk enum valuesf::Ftp::Ftp::Response
FilenameNotAllowed enum valuesf::Ftp::Ftp::Response
FileStatus enum valuesf::Ftp::Ftp::Response
FileUnavailable enum valuesf::Ftp::Ftp::Response
GetDirectory() const sf::Ftp::Ftp::DirectoryResponse
GetMessage() const sf::Ftp::Ftp::Response
GetStatus() const sf::Ftp::Ftp::Response
HelpMessage enum valuesf::Ftp::Ftp::Response
InsufficientStorageSpace enum valuesf::Ftp::Ftp::Response
InvalidFile enum valuesf::Ftp::Ftp::Response
InvalidResponse enum valuesf::Ftp::Ftp::Response
IsOk() const sf::Ftp::Ftp::Response
LocalError enum valuesf::Ftp::Ftp::Response
LoggedIn enum valuesf::Ftp::Ftp::Response
NeedAccountToLogIn enum valuesf::Ftp::Ftp::Response
NeedAccountToStore enum valuesf::Ftp::Ftp::Response
NeedInformation enum valuesf::Ftp::Ftp::Response
NeedPassword enum valuesf::Ftp::Ftp::Response
NotEnoughMemory enum valuesf::Ftp::Ftp::Response
NotLoggedIn enum valuesf::Ftp::Ftp::Response
Ok enum valuesf::Ftp::Ftp::Response
OpeningDataConnection enum valuesf::Ftp::Ftp::Response
PageTypeUnknown enum valuesf::Ftp::Ftp::Response
ParameterNotImplemented enum valuesf::Ftp::Ftp::Response
ParametersUnknown enum valuesf::Ftp::Ftp::Response
PointlessCommand enum valuesf::Ftp::Ftp::Response
Response(Status Code=InvalidResponse, const std::string &Message="")sf::Ftp::Ftp::Response
RestartMarkerReply enum valuesf::Ftp::Ftp::Response
ServiceReady enum valuesf::Ftp::Ftp::Response
ServiceReadySoon enum valuesf::Ftp::Ftp::Response
ServiceUnavailable enum valuesf::Ftp::Ftp::Response
Status enum namesf::Ftp::Ftp::Response
SystemStatus enum valuesf::Ftp::Ftp::Response
SystemType enum valuesf::Ftp::Ftp::Response
TransferAborted enum valuesf::Ftp::Ftp::Response

+ - -
- + + -
- -
-
-sf::Ftp::DirectoryResponse
-

sf::Ftp::DirectoryResponse Class Reference

Specialization of FTP response returning a directory. +
+

sf::Ftp::Ftp::DirectoryResponse Class Reference

Specialization of FTP response returning a directory. More...

#include <Ftp.hpp>

-

Inheritance diagram for sf::Ftp::DirectoryResponse: -

- -sf::Ftp::Response +
+Inheritance diagram for sf::Ftp::Ftp::DirectoryResponse:
+
+ +

+ +sf::Ftp::Ftp::Response +
+ +

List of all members. - + - - + + - - + + - - + + - - + + - +

Public Types

enum  Status {
-  RestartMarkerReply = 110, +  RestartMarkerReply = 110,
-  ServiceReadySoon = 120, +  ServiceReadySoon = 120,
-  DataConnectionAlreadyOpened = 125, +  DataConnectionAlreadyOpened = 125,
-  OpeningDataConnection = 150, +  OpeningDataConnection = 150,
-  Ok = 200, +  Ok = 200,
-  PointlessCommand = 202, +  PointlessCommand = 202,
-  SystemStatus = 211, +  SystemStatus = 211,
-  DirectoryStatus = 212, +  DirectoryStatus = 212,
-  FileStatus = 213, +  FileStatus = 213,
-  HelpMessage = 214, +  HelpMessage = 214,
-  SystemType = 215, +  SystemType = 215,
-  ServiceReady = 220, +  ServiceReady = 220,
-  ClosingConnection = 221, +  ClosingConnection = 221,
-  DataConnectionOpened = 225, +  DataConnectionOpened = 225,
-  ClosingDataConnection = 226, +  ClosingDataConnection = 226,
-  EnteringPassiveMode = 227, +  EnteringPassiveMode = 227,
-  LoggedIn = 230, +  LoggedIn = 230,
-  FileActionOk = 250, +  FileActionOk = 250,
-  DirectoryOk = 257, +  DirectoryOk = 257,
-  NeedPassword = 331, +  NeedPassword = 331,
-  NeedAccountToLogIn = 332, +  NeedAccountToLogIn = 332,
-  NeedInformation = 350, +  NeedInformation = 350,
-  ServiceUnavailable = 421, +  ServiceUnavailable = 421,
-  DataConnectionUnavailable = 425, +  DataConnectionUnavailable = 425,
-  TransferAborted = 426, +  TransferAborted = 426,
-  FileActionAborted = 450, +  FileActionAborted = 450,
-  LocalError = 451, +  LocalError = 451,
-  InsufficientStorageSpace = 452, +  InsufficientStorageSpace = 452,
-  CommandUnknown = 500, +  CommandUnknown = 500,
-  ParametersUnknown = 501, +  ParametersUnknown = 501,
-  CommandNotImplemented = 502, +  CommandNotImplemented = 502,
-  BadCommandSequence = 503, +  BadCommandSequence = 503,
-  ParameterNotImplemented = 504, +  ParameterNotImplemented = 504,
-  NotLoggedIn = 530, +  NotLoggedIn = 530,
-  NeedAccountToStore = 532, +  NeedAccountToStore = 532,
-  FileUnavailable = 550, +  FileUnavailable = 550,
-  PageTypeUnknown = 551, +  PageTypeUnknown = 551,
-  NotEnoughMemory = 552, +  NotEnoughMemory = 552,
-  FilenameNotAllowed = 553, +  FilenameNotAllowed = 553,
-  InvalidResponse = 1000, +  InvalidResponse = 1000,
-  ConnectionFailed = 1001, +  ConnectionFailed = 1001,
-  ConnectionClosed = 1002, +  ConnectionClosed = 1002,
-  InvalidFile = 1003 +  InvalidFile = 1003
}
 Enumerate all the valid status codes returned in a FTP response. More...

Public Member Functions

 DirectoryResponse (Response Resp)
 DirectoryResponse (Response Resp)
 Default constructor.
const std::string & GetDirectory () const
 Default constructor.
const std::string & GetDirectory () const
 Get the directory returned in the response.
bool IsOk () const
 Get the directory returned in the response.
bool IsOk () const
 Convenience function to check if the response status code means a success.
Status GetStatus () const
 Convenience function to check if the response status code means a success.
Status GetStatus () const
 Get the response status code.
const std::string & GetMessage () const
 Get the response status code.
const std::string & GetMessage () const
 Get the full message contained in the response.
 Get the full message contained in the response.

Detailed Description

Specialization of FTP response returning a directory. -

- -

-Definition at line 182 of file Ftp.hpp.

Member Enumeration Documentation

+

Definition at line 182 of file Ftp.hpp.

+

Member Enumeration Documentation

@@ -171,111 +178,111 @@ Enumerate all the valid status codes returned in a FTP response.

Enumerator:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RestartMarkerReply  +
RestartMarkerReply  Restart marker reply.
ServiceReadySoon  +
ServiceReadySoon  Service ready in N minutes.
DataConnectionAlreadyOpened  +
DataConnectionAlreadyOpened  Data connection already opened, transfer starting.
OpeningDataConnection  +
OpeningDataConnection  File status ok, about to open data connection.
Ok  +
Ok  Command ok.
PointlessCommand  +
PointlessCommand  Command not implemented.
SystemStatus  +
SystemStatus  System status, or system help reply.
DirectoryStatus  +
DirectoryStatus  Directory status.
FileStatus  +
FileStatus  File status.
HelpMessage  +
HelpMessage  Help message.
SystemType  +
SystemType  NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
ServiceReady  +
ServiceReady  Service ready for new user.
ClosingConnection  +
ClosingConnection  Service closing control connection.
DataConnectionOpened  +
DataConnectionOpened  Data connection open, no transfer in progress.
ClosingDataConnection  +
ClosingDataConnection  Closing data connection, requested file action successful.
EnteringPassiveMode  +
EnteringPassiveMode  Entering passive mode.
LoggedIn  +
LoggedIn  User logged in, proceed. Logged out if appropriate.
FileActionOk  +
FileActionOk  Requested file action ok.
DirectoryOk  +
DirectoryOk  PATHNAME created.
NeedPassword  +
NeedPassword  User name ok, need password.
NeedAccountToLogIn  +
NeedAccountToLogIn  Need account for login.
NeedInformation  +
NeedInformation  Requested file action pending further information.
ServiceUnavailable  +
ServiceUnavailable  Service not available, closing control connection.
DataConnectionUnavailable  +
DataConnectionUnavailable  Can't open data connection.
TransferAborted  +
TransferAborted  Connection closed, transfer aborted.
FileActionAborted  +
FileActionAborted  Requested file action not taken.
LocalError  +
LocalError  Requested action aborted, local error in processing.
InsufficientStorageSpace  +
InsufficientStorageSpace  Requested action not taken; insufficient storage space in system, file unavailable.
CommandUnknown  +
CommandUnknown  Syntax error, command unrecognized.
ParametersUnknown  +
ParametersUnknown  Syntax error in parameters or arguments.
CommandNotImplemented  +
CommandNotImplemented  Command not implemented.
BadCommandSequence  +
BadCommandSequence  Bad sequence of commands.
ParameterNotImplemented  +
ParameterNotImplemented  Command not implemented for that parameter.
NotLoggedIn  +
NotLoggedIn  Not logged in.
NeedAccountToStore  +
NeedAccountToStore  Need account for storing files.
FileUnavailable  +
FileUnavailable  Requested action not taken, file unavailable.
PageTypeUnknown  +
PageTypeUnknown  Requested action aborted, page type unknown.
NotEnoughMemory  +
NotEnoughMemory  Requested file action aborted, exceeded storage allocation.
FilenameNotAllowed  +
FilenameNotAllowed  Requested action not taken, file name not allowed.
InvalidResponse  +
InvalidResponse  Response is not a valid FTP one.
ConnectionFailed  +
ConnectionFailed  Connection with server failed.
ConnectionClosed  +
ConnectionClosed  Connection with server closed.
InvalidFile  +
InvalidFile  Invalid file to upload / download.
-

-Definition at line 74 of file Ftp.hpp. +

Definition at line 74 of file Ftp.hpp.

+

Constructor & Destructor Documentation

- +
- + - + - +
sf::Ftp::DirectoryResponse::DirectoryResponse sf::Ftp::Ftp::DirectoryResponse::DirectoryResponse (Response Ftp::Response  Resp  ) 
@@ -290,19 +297,21 @@ Default constructor. +

Definition at line 123 of file Ftp.cpp.

+

Member Function Documentation

- +
- + - +
const std::string& sf::Ftp::DirectoryResponse::GetDirectory const std::string & sf::Ftp::Ftp::DirectoryResponse::GetDirectory (  )  const const
@@ -313,40 +322,44 @@ Get the directory returned in the response.

Returns:
Directory name
+

Definition at line 139 of file Ftp.cpp.

+

- +

- + - +
bool sf::Ftp::Response::IsOk const std::string & sf::Ftp::Ftp::Response::GetMessage (  )  const [inherited] const [inherited]

-Convenience function to check if the response status code means a success. +Get the full message contained in the response.

-

Returns:
True if status is success (code < 400)
+
Returns:
The response message
+ +

Definition at line 114 of file Ftp.cpp.

- +

- + - +
Status sf::Ftp::Response::GetStatus Ftp::Response::Status sf::Ftp::Ftp::Response::GetStatus (  )  const [inherited] const [inherited]
@@ -357,32 +370,38 @@ Get the response status code.

Returns:
Status code
+

Definition at line 105 of file Ftp.cpp.

+

- +

- + - +
const std::string& sf::Ftp::Response::GetMessage bool sf::Ftp::Ftp::Response::IsOk (  )  const [inherited] const [inherited]

-Get the full message contained in the response. +Convenience function to check if the response status code means a success.

-

Returns:
The response message
+Convenience function to check if the response status code means a success.

+

Returns:
True if status is success (code < 400)
+ +

Definition at line 96 of file Ftp.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- + + -
- -
-

sf::Ftp::ListingResponse Member List

This is the complete list of members for sf::Ftp::ListingResponse, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BadCommandSequence enum valuesf::Ftp::Response
ClosingConnection enum valuesf::Ftp::Response
ClosingDataConnection enum valuesf::Ftp::Response
CommandNotImplemented enum valuesf::Ftp::Response
CommandUnknown enum valuesf::Ftp::Response
ConnectionClosed enum valuesf::Ftp::Response
ConnectionFailed enum valuesf::Ftp::Response
DataConnectionAlreadyOpened enum valuesf::Ftp::Response
DataConnectionOpened enum valuesf::Ftp::Response
DataConnectionUnavailable enum valuesf::Ftp::Response
DirectoryOk enum valuesf::Ftp::Response
DirectoryStatus enum valuesf::Ftp::Response
EnteringPassiveMode enum valuesf::Ftp::Response
FileActionAborted enum valuesf::Ftp::Response
FileActionOk enum valuesf::Ftp::Response
FilenameNotAllowed enum valuesf::Ftp::Response
FileStatus enum valuesf::Ftp::Response
FileUnavailable enum valuesf::Ftp::Response
GetCount() constsf::Ftp::ListingResponse
GetFilename(std::size_t Index) const sf::Ftp::ListingResponse
GetMessage() constsf::Ftp::Response
GetStatus() constsf::Ftp::Response
HelpMessage enum valuesf::Ftp::Response
InsufficientStorageSpace enum valuesf::Ftp::Response
InvalidFile enum valuesf::Ftp::Response
InvalidResponse enum valuesf::Ftp::Response
IsOk() constsf::Ftp::Response
ListingResponse(Response Resp, const std::vector< char > &Data)sf::Ftp::ListingResponse
LocalError enum valuesf::Ftp::Response
LoggedIn enum valuesf::Ftp::Response
NeedAccountToLogIn enum valuesf::Ftp::Response
NeedAccountToStore enum valuesf::Ftp::Response
NeedInformation enum valuesf::Ftp::Response
NeedPassword enum valuesf::Ftp::Response
NotEnoughMemory enum valuesf::Ftp::Response
NotLoggedIn enum valuesf::Ftp::Response
Ok enum valuesf::Ftp::Response
OpeningDataConnection enum valuesf::Ftp::Response
PageTypeUnknown enum valuesf::Ftp::Response
ParameterNotImplemented enum valuesf::Ftp::Response
ParametersUnknown enum valuesf::Ftp::Response
PointlessCommand enum valuesf::Ftp::Response
Response(Status Code=InvalidResponse, const std::string &Message="")sf::Ftp::Response
RestartMarkerReply enum valuesf::Ftp::Response
ServiceReady enum valuesf::Ftp::Response
ServiceReadySoon enum valuesf::Ftp::Response
ServiceUnavailable enum valuesf::Ftp::Response
Status enum namesf::Ftp::Response
SystemStatus enum valuesf::Ftp::Response
SystemType enum valuesf::Ftp::Response
TransferAborted enum valuesf::Ftp::Response
+

+

sf::Ftp::Ftp::ListingResponse Member List

This is the complete list of members for sf::Ftp::Ftp::ListingResponse, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BadCommandSequence enum valuesf::Ftp::Ftp::Response
ClosingConnection enum valuesf::Ftp::Ftp::Response
ClosingDataConnection enum valuesf::Ftp::Ftp::Response
CommandNotImplemented enum valuesf::Ftp::Ftp::Response
CommandUnknown enum valuesf::Ftp::Ftp::Response
ConnectionClosed enum valuesf::Ftp::Ftp::Response
ConnectionFailed enum valuesf::Ftp::Ftp::Response
DataConnectionAlreadyOpened enum valuesf::Ftp::Ftp::Response
DataConnectionOpened enum valuesf::Ftp::Ftp::Response
DataConnectionUnavailable enum valuesf::Ftp::Ftp::Response
DirectoryOk enum valuesf::Ftp::Ftp::Response
DirectoryStatus enum valuesf::Ftp::Ftp::Response
EnteringPassiveMode enum valuesf::Ftp::Ftp::Response
FileActionAborted enum valuesf::Ftp::Ftp::Response
FileActionOk enum valuesf::Ftp::Ftp::Response
FilenameNotAllowed enum valuesf::Ftp::Ftp::Response
FileStatus enum valuesf::Ftp::Ftp::Response
FileUnavailable enum valuesf::Ftp::Ftp::Response
GetCount() const sf::Ftp::Ftp::ListingResponse
GetFilename(std::size_t Index) const sf::Ftp::Ftp::ListingResponse
GetMessage() const sf::Ftp::Ftp::Response
GetStatus() const sf::Ftp::Ftp::Response
HelpMessage enum valuesf::Ftp::Ftp::Response
InsufficientStorageSpace enum valuesf::Ftp::Ftp::Response
InvalidFile enum valuesf::Ftp::Ftp::Response
InvalidResponse enum valuesf::Ftp::Ftp::Response
IsOk() const sf::Ftp::Ftp::Response
ListingResponse(Response Resp, const std::vector< char > &Data)sf::Ftp::Ftp::ListingResponse
LocalError enum valuesf::Ftp::Ftp::Response
LoggedIn enum valuesf::Ftp::Ftp::Response
NeedAccountToLogIn enum valuesf::Ftp::Ftp::Response
NeedAccountToStore enum valuesf::Ftp::Ftp::Response
NeedInformation enum valuesf::Ftp::Ftp::Response
NeedPassword enum valuesf::Ftp::Ftp::Response
NotEnoughMemory enum valuesf::Ftp::Ftp::Response
NotLoggedIn enum valuesf::Ftp::Ftp::Response
Ok enum valuesf::Ftp::Ftp::Response
OpeningDataConnection enum valuesf::Ftp::Ftp::Response
PageTypeUnknown enum valuesf::Ftp::Ftp::Response
ParameterNotImplemented enum valuesf::Ftp::Ftp::Response
ParametersUnknown enum valuesf::Ftp::Ftp::Response
PointlessCommand enum valuesf::Ftp::Ftp::Response
Response(Status Code=InvalidResponse, const std::string &Message="")sf::Ftp::Ftp::Response
RestartMarkerReply enum valuesf::Ftp::Ftp::Response
ServiceReady enum valuesf::Ftp::Ftp::Response
ServiceReadySoon enum valuesf::Ftp::Ftp::Response
ServiceUnavailable enum valuesf::Ftp::Ftp::Response
Status enum namesf::Ftp::Ftp::Response
SystemStatus enum valuesf::Ftp::Ftp::Response
SystemType enum valuesf::Ftp::Ftp::Response
TransferAborted enum valuesf::Ftp::Ftp::Response

+ - -
- + + -
- -
-
-sf::Ftp::ListingResponse
-

sf::Ftp::ListingResponse Class Reference

Specialization of FTP response returning a filename lisiting. +
+

sf::Ftp::Ftp::ListingResponse Class Reference

Specialization of FTP response returning a filename lisiting. More...

#include <Ftp.hpp>

-

Inheritance diagram for sf::Ftp::ListingResponse: -

- -sf::Ftp::Response +
+Inheritance diagram for sf::Ftp::Ftp::ListingResponse:
+
+ +

+ +sf::Ftp::Ftp::Response +
+ +

List of all members. - + - - + + - - + + - - + + - - + + - - + + - +

Public Types

enum  Status {
-  RestartMarkerReply = 110, +  RestartMarkerReply = 110,
-  ServiceReadySoon = 120, +  ServiceReadySoon = 120,
-  DataConnectionAlreadyOpened = 125, +  DataConnectionAlreadyOpened = 125,
-  OpeningDataConnection = 150, +  OpeningDataConnection = 150,
-  Ok = 200, +  Ok = 200,
-  PointlessCommand = 202, +  PointlessCommand = 202,
-  SystemStatus = 211, +  SystemStatus = 211,
-  DirectoryStatus = 212, +  DirectoryStatus = 212,
-  FileStatus = 213, +  FileStatus = 213,
-  HelpMessage = 214, +  HelpMessage = 214,
-  SystemType = 215, +  SystemType = 215,
-  ServiceReady = 220, +  ServiceReady = 220,
-  ClosingConnection = 221, +  ClosingConnection = 221,
-  DataConnectionOpened = 225, +  DataConnectionOpened = 225,
-  ClosingDataConnection = 226, +  ClosingDataConnection = 226,
-  EnteringPassiveMode = 227, +  EnteringPassiveMode = 227,
-  LoggedIn = 230, +  LoggedIn = 230,
-  FileActionOk = 250, +  FileActionOk = 250,
-  DirectoryOk = 257, +  DirectoryOk = 257,
-  NeedPassword = 331, +  NeedPassword = 331,
-  NeedAccountToLogIn = 332, +  NeedAccountToLogIn = 332,
-  NeedInformation = 350, +  NeedInformation = 350,
-  ServiceUnavailable = 421, +  ServiceUnavailable = 421,
-  DataConnectionUnavailable = 425, +  DataConnectionUnavailable = 425,
-  TransferAborted = 426, +  TransferAborted = 426,
-  FileActionAborted = 450, +  FileActionAborted = 450,
-  LocalError = 451, +  LocalError = 451,
-  InsufficientStorageSpace = 452, +  InsufficientStorageSpace = 452,
-  CommandUnknown = 500, +  CommandUnknown = 500,
-  ParametersUnknown = 501, +  ParametersUnknown = 501,
-  CommandNotImplemented = 502, +  CommandNotImplemented = 502,
-  BadCommandSequence = 503, +  BadCommandSequence = 503,
-  ParameterNotImplemented = 504, +  ParameterNotImplemented = 504,
-  NotLoggedIn = 530, +  NotLoggedIn = 530,
-  NeedAccountToStore = 532, +  NeedAccountToStore = 532,
-  FileUnavailable = 550, +  FileUnavailable = 550,
-  PageTypeUnknown = 551, +  PageTypeUnknown = 551,
-  NotEnoughMemory = 552, +  NotEnoughMemory = 552,
-  FilenameNotAllowed = 553, +  FilenameNotAllowed = 553,
-  InvalidResponse = 1000, +  InvalidResponse = 1000,
-  ConnectionFailed = 1001, +  ConnectionFailed = 1001,
-  ConnectionClosed = 1002, +  ConnectionClosed = 1002,
-  InvalidFile = 1003 +  InvalidFile = 1003
}
 Enumerate all the valid status codes returned in a FTP response. More...

Public Member Functions

 ListingResponse (Response Resp, const std::vector< char > &Data)
 ListingResponse (Response Resp, const std::vector< char > &Data)
 Default constructor.
std::size_t GetCount () const
 Default constructor.
std::size_t GetCount () const
 Get the number of filenames in the listing.
const std::string & GetFilename (std::size_t Index) const
 Get the number of filenames in the listing.
const std::string & GetFilename (std::size_t Index) const
 Get the Index-th filename in the directory.
bool IsOk () const
 Get the Index-th filename in the directory.
bool IsOk () const
 Convenience function to check if the response status code means a success.
Status GetStatus () const
 Convenience function to check if the response status code means a success.
Status GetStatus () const
 Get the response status code.
const std::string & GetMessage () const
 Get the response status code.
const std::string & GetMessage () const
 Get the full message contained in the response.
 Get the full message contained in the response.

Detailed Description

Specialization of FTP response returning a filename lisiting. -

- -

-Definition at line 214 of file Ftp.hpp.

Member Enumeration Documentation

+

Definition at line 214 of file Ftp.hpp.

+

Member Enumeration Documentation

@@ -174,108 +181,108 @@ Enumerate all the valid status codes returned in a FTP response.

Enumerator:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RestartMarkerReply  +
RestartMarkerReply  Restart marker reply.
ServiceReadySoon  +
ServiceReadySoon  Service ready in N minutes.
DataConnectionAlreadyOpened  +
DataConnectionAlreadyOpened  Data connection already opened, transfer starting.
OpeningDataConnection  +
OpeningDataConnection  File status ok, about to open data connection.
Ok  +
Ok  Command ok.
PointlessCommand  +
PointlessCommand  Command not implemented.
SystemStatus  +
SystemStatus  System status, or system help reply.
DirectoryStatus  +
DirectoryStatus  Directory status.
FileStatus  +
FileStatus  File status.
HelpMessage  +
HelpMessage  Help message.
SystemType  +
SystemType  NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
ServiceReady  +
ServiceReady  Service ready for new user.
ClosingConnection  +
ClosingConnection  Service closing control connection.
DataConnectionOpened  +
DataConnectionOpened  Data connection open, no transfer in progress.
ClosingDataConnection  +
ClosingDataConnection  Closing data connection, requested file action successful.
EnteringPassiveMode  +
EnteringPassiveMode  Entering passive mode.
LoggedIn  +
LoggedIn  User logged in, proceed. Logged out if appropriate.
FileActionOk  +
FileActionOk  Requested file action ok.
DirectoryOk  +
DirectoryOk  PATHNAME created.
NeedPassword  +
NeedPassword  User name ok, need password.
NeedAccountToLogIn  +
NeedAccountToLogIn  Need account for login.
NeedInformation  +
NeedInformation  Requested file action pending further information.
ServiceUnavailable  +
ServiceUnavailable  Service not available, closing control connection.
DataConnectionUnavailable  +
DataConnectionUnavailable  Can't open data connection.
TransferAborted  +
TransferAborted  Connection closed, transfer aborted.
FileActionAborted  +
FileActionAborted  Requested file action not taken.
LocalError  +
LocalError  Requested action aborted, local error in processing.
InsufficientStorageSpace  +
InsufficientStorageSpace  Requested action not taken; insufficient storage space in system, file unavailable.
CommandUnknown  +
CommandUnknown  Syntax error, command unrecognized.
ParametersUnknown  +
ParametersUnknown  Syntax error in parameters or arguments.
CommandNotImplemented  +
CommandNotImplemented  Command not implemented.
BadCommandSequence  +
BadCommandSequence  Bad sequence of commands.
ParameterNotImplemented  +
ParameterNotImplemented  Command not implemented for that parameter.
NotLoggedIn  +
NotLoggedIn  Not logged in.
NeedAccountToStore  +
NeedAccountToStore  Need account for storing files.
FileUnavailable  +
FileUnavailable  Requested action not taken, file unavailable.
PageTypeUnknown  +
PageTypeUnknown  Requested action aborted, page type unknown.
NotEnoughMemory  +
NotEnoughMemory  Requested file action aborted, exceeded storage allocation.
FilenameNotAllowed  +
FilenameNotAllowed  Requested action not taken, file name not allowed.
InvalidResponse  +
InvalidResponse  Response is not a valid FTP one.
ConnectionFailed  +
ConnectionFailed  Connection with server failed.
ConnectionClosed  +
ConnectionClosed  Connection with server closed.
InvalidFile  +
InvalidFile  Invalid file to upload / download.
-

-Definition at line 74 of file Ftp.hpp. +

Definition at line 74 of file Ftp.hpp.

+

Constructor & Destructor Documentation

- +
- + - + @@ -287,7 +294,7 @@ Definition at line 74 of fil - +
sf::Ftp::ListingResponse::ListingResponse sf::Ftp::Ftp::ListingResponse::ListingResponse (Response Ftp::Response  Resp,
)
@@ -303,19 +310,21 @@ Default constructor. +

Definition at line 148 of file Ftp.cpp.

+

Member Function Documentation

- +
- + - +
std::size_t sf::Ftp::ListingResponse::GetCount std::size_t sf::Ftp::Ftp::ListingResponse::GetCount (  )  const const
@@ -326,19 +335,21 @@ Get the number of filenames in the listing.

Returns:
Total number of filenames
+

Definition at line 168 of file Ftp.cpp.

+

- +

- + - +
const std::string& sf::Ftp::ListingResponse::GetFilename const std::string & sf::Ftp::Ftp::ListingResponse::GetFilename ( std::size_t  Index  )  const const
@@ -354,40 +365,44 @@ Get the Index-th filename in the directory.
Returns:
Index-th filename
+

Definition at line 177 of file Ftp.cpp.

+

- +

- + - +
bool sf::Ftp::Response::IsOk const std::string & sf::Ftp::Ftp::Response::GetMessage (  )  const [inherited] const [inherited]

-Convenience function to check if the response status code means a success. +Get the full message contained in the response.

-

Returns:
True if status is success (code < 400)
+
Returns:
The response message
+ +

Definition at line 114 of file Ftp.cpp.

- +

- + - +
Status sf::Ftp::Response::GetStatus Ftp::Response::Status sf::Ftp::Ftp::Response::GetStatus (  )  const [inherited] const [inherited]
@@ -398,32 +413,38 @@ Get the response status code.

Returns:
Status code
+

Definition at line 105 of file Ftp.cpp.

+

- +

- + - +
const std::string& sf::Ftp::Response::GetMessage bool sf::Ftp::Ftp::Response::IsOk (  )  const [inherited] const [inherited]

-Get the full message contained in the response. +Convenience function to check if the response status code means a success.

-

Returns:
The response message
+Convenience function to check if the response status code means a success.

+

Returns:
True if status is success (code < 400)
+ +

Definition at line 96 of file Ftp.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- + + -
- -
-

sf::Ftp::Response Member List

This is the complete list of members for sf::Ftp::Response, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BadCommandSequence enum valuesf::Ftp::Response
ClosingConnection enum valuesf::Ftp::Response
ClosingDataConnection enum valuesf::Ftp::Response
CommandNotImplemented enum valuesf::Ftp::Response
CommandUnknown enum valuesf::Ftp::Response
ConnectionClosed enum valuesf::Ftp::Response
ConnectionFailed enum valuesf::Ftp::Response
DataConnectionAlreadyOpened enum valuesf::Ftp::Response
DataConnectionOpened enum valuesf::Ftp::Response
DataConnectionUnavailable enum valuesf::Ftp::Response
DirectoryOk enum valuesf::Ftp::Response
DirectoryStatus enum valuesf::Ftp::Response
EnteringPassiveMode enum valuesf::Ftp::Response
FileActionAborted enum valuesf::Ftp::Response
FileActionOk enum valuesf::Ftp::Response
FilenameNotAllowed enum valuesf::Ftp::Response
FileStatus enum valuesf::Ftp::Response
FileUnavailable enum valuesf::Ftp::Response
GetMessage() constsf::Ftp::Response
GetStatus() constsf::Ftp::Response
HelpMessage enum valuesf::Ftp::Response
InsufficientStorageSpace enum valuesf::Ftp::Response
InvalidFile enum valuesf::Ftp::Response
InvalidResponse enum valuesf::Ftp::Response
IsOk() constsf::Ftp::Response
LocalError enum valuesf::Ftp::Response
LoggedIn enum valuesf::Ftp::Response
NeedAccountToLogIn enum valuesf::Ftp::Response
NeedAccountToStore enum valuesf::Ftp::Response
NeedInformation enum valuesf::Ftp::Response
NeedPassword enum valuesf::Ftp::Response
NotEnoughMemory enum valuesf::Ftp::Response
NotLoggedIn enum valuesf::Ftp::Response
Ok enum valuesf::Ftp::Response
OpeningDataConnection enum valuesf::Ftp::Response
PageTypeUnknown enum valuesf::Ftp::Response
ParameterNotImplemented enum valuesf::Ftp::Response
ParametersUnknown enum valuesf::Ftp::Response
PointlessCommand enum valuesf::Ftp::Response
Response(Status Code=InvalidResponse, const std::string &Message="")sf::Ftp::Response
RestartMarkerReply enum valuesf::Ftp::Response
ServiceReady enum valuesf::Ftp::Response
ServiceReadySoon enum valuesf::Ftp::Response
ServiceUnavailable enum valuesf::Ftp::Response
Status enum namesf::Ftp::Response
SystemStatus enum valuesf::Ftp::Response
SystemType enum valuesf::Ftp::Response
TransferAborted enum valuesf::Ftp::Response
+

+

sf::Ftp::Ftp::Response Member List

This is the complete list of members for sf::Ftp::Ftp::Response, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BadCommandSequence enum valuesf::Ftp::Ftp::Response
ClosingConnection enum valuesf::Ftp::Ftp::Response
ClosingDataConnection enum valuesf::Ftp::Ftp::Response
CommandNotImplemented enum valuesf::Ftp::Ftp::Response
CommandUnknown enum valuesf::Ftp::Ftp::Response
ConnectionClosed enum valuesf::Ftp::Ftp::Response
ConnectionFailed enum valuesf::Ftp::Ftp::Response
DataConnectionAlreadyOpened enum valuesf::Ftp::Ftp::Response
DataConnectionOpened enum valuesf::Ftp::Ftp::Response
DataConnectionUnavailable enum valuesf::Ftp::Ftp::Response
DirectoryOk enum valuesf::Ftp::Ftp::Response
DirectoryStatus enum valuesf::Ftp::Ftp::Response
EnteringPassiveMode enum valuesf::Ftp::Ftp::Response
FileActionAborted enum valuesf::Ftp::Ftp::Response
FileActionOk enum valuesf::Ftp::Ftp::Response
FilenameNotAllowed enum valuesf::Ftp::Ftp::Response
FileStatus enum valuesf::Ftp::Ftp::Response
FileUnavailable enum valuesf::Ftp::Ftp::Response
GetMessage() const sf::Ftp::Ftp::Response
GetStatus() const sf::Ftp::Ftp::Response
HelpMessage enum valuesf::Ftp::Ftp::Response
InsufficientStorageSpace enum valuesf::Ftp::Ftp::Response
InvalidFile enum valuesf::Ftp::Ftp::Response
InvalidResponse enum valuesf::Ftp::Ftp::Response
IsOk() const sf::Ftp::Ftp::Response
LocalError enum valuesf::Ftp::Ftp::Response
LoggedIn enum valuesf::Ftp::Ftp::Response
NeedAccountToLogIn enum valuesf::Ftp::Ftp::Response
NeedAccountToStore enum valuesf::Ftp::Ftp::Response
NeedInformation enum valuesf::Ftp::Ftp::Response
NeedPassword enum valuesf::Ftp::Ftp::Response
NotEnoughMemory enum valuesf::Ftp::Ftp::Response
NotLoggedIn enum valuesf::Ftp::Ftp::Response
Ok enum valuesf::Ftp::Ftp::Response
OpeningDataConnection enum valuesf::Ftp::Ftp::Response
PageTypeUnknown enum valuesf::Ftp::Ftp::Response
ParameterNotImplemented enum valuesf::Ftp::Ftp::Response
ParametersUnknown enum valuesf::Ftp::Ftp::Response
PointlessCommand enum valuesf::Ftp::Ftp::Response
Response(Status Code=InvalidResponse, const std::string &Message="")sf::Ftp::Ftp::Response
RestartMarkerReply enum valuesf::Ftp::Ftp::Response
ServiceReady enum valuesf::Ftp::Ftp::Response
ServiceReadySoon enum valuesf::Ftp::Ftp::Response
ServiceUnavailable enum valuesf::Ftp::Ftp::Response
Status enum namesf::Ftp::Ftp::Response
SystemStatus enum valuesf::Ftp::Ftp::Response
SystemType enum valuesf::Ftp::Ftp::Response
TransferAborted enum valuesf::Ftp::Ftp::Response

+ - -
- + + -
- -
-
-sf::Ftp::Response
-

sf::Ftp::Response Class Reference

This class wraps a FTP response, which is basically :
    +
    +

    sf::Ftp::Ftp::Response Class Reference

    This class wraps a FTP response, which is basically :
    • a status code
    • a message.
    More...

    #include <Ftp.hpp>

    -

    Inheritance diagram for sf::Ftp::Response: -

    - -sf::Ftp::DirectoryResponse -sf::Ftp::ListingResponse +
    +Inheritance diagram for sf::Ftp::Ftp::Response:
    +
    + +

    + +sf::Ftp::Ftp::DirectoryResponse +sf::Ftp::Ftp::ListingResponse +
    + +

    List of all members. - + - - + + - - + + - - + + - +

    Public Types

    enum  Status {
    -  RestartMarkerReply = 110, +  RestartMarkerReply = 110,
    -  ServiceReadySoon = 120, +  ServiceReadySoon = 120,
    -  DataConnectionAlreadyOpened = 125, +  DataConnectionAlreadyOpened = 125,
    -  OpeningDataConnection = 150, +  OpeningDataConnection = 150,
    -  Ok = 200, +  Ok = 200,
    -  PointlessCommand = 202, +  PointlessCommand = 202,
    -  SystemStatus = 211, +  SystemStatus = 211,
    -  DirectoryStatus = 212, +  DirectoryStatus = 212,
    -  FileStatus = 213, +  FileStatus = 213,
    -  HelpMessage = 214, +  HelpMessage = 214,
    -  SystemType = 215, +  SystemType = 215,
    -  ServiceReady = 220, +  ServiceReady = 220,
    -  ClosingConnection = 221, +  ClosingConnection = 221,
    -  DataConnectionOpened = 225, +  DataConnectionOpened = 225,
    -  ClosingDataConnection = 226, +  ClosingDataConnection = 226,
    -  EnteringPassiveMode = 227, +  EnteringPassiveMode = 227,
    -  LoggedIn = 230, +  LoggedIn = 230,
    -  FileActionOk = 250, +  FileActionOk = 250,
    -  DirectoryOk = 257, +  DirectoryOk = 257,
    -  NeedPassword = 331, +  NeedPassword = 331,
    -  NeedAccountToLogIn = 332, +  NeedAccountToLogIn = 332,
    -  NeedInformation = 350, +  NeedInformation = 350,
    -  ServiceUnavailable = 421, +  ServiceUnavailable = 421,
    -  DataConnectionUnavailable = 425, +  DataConnectionUnavailable = 425,
    -  TransferAborted = 426, +  TransferAborted = 426,
    -  FileActionAborted = 450, +  FileActionAborted = 450,
    -  LocalError = 451, +  LocalError = 451,
    -  InsufficientStorageSpace = 452, +  InsufficientStorageSpace = 452,
    -  CommandUnknown = 500, +  CommandUnknown = 500,
    -  ParametersUnknown = 501, +  ParametersUnknown = 501,
    -  CommandNotImplemented = 502, +  CommandNotImplemented = 502,
    -  BadCommandSequence = 503, +  BadCommandSequence = 503,
    -  ParameterNotImplemented = 504, +  ParameterNotImplemented = 504,
    -  NotLoggedIn = 530, +  NotLoggedIn = 530,
    -  NeedAccountToStore = 532, +  NeedAccountToStore = 532,
    -  FileUnavailable = 550, +  FileUnavailable = 550,
    -  PageTypeUnknown = 551, +  PageTypeUnknown = 551,
    -  NotEnoughMemory = 552, +  NotEnoughMemory = 552,
    -  FilenameNotAllowed = 553, +  FilenameNotAllowed = 553,
    -  InvalidResponse = 1000, +  InvalidResponse = 1000,
    -  ConnectionFailed = 1001, +  ConnectionFailed = 1001,
    -  ConnectionClosed = 1002, +  ConnectionClosed = 1002,
    -  InvalidFile = 1003 +  InvalidFile = 1003
    }
     Enumerate all the valid status codes returned in a FTP response. More...

    Public Member Functions

     Response (Status Code=InvalidResponse, const std::string &Message="")
     Response (Status Code=InvalidResponse, const std::string &Message="")
     Default constructor.
    bool IsOk () const
     Default constructor.
    bool IsOk () const
     Convenience function to check if the response status code means a success.
    Status GetStatus () const
     Convenience function to check if the response status code means a success.
    Status GetStatus () const
     Get the response status code.
    const std::string & GetMessage () const
     Get the response status code.
    const std::string & GetMessage () const
     Get the full message contained in the response.
     Get the full message contained in the response.

    Detailed Description

    This class wraps a FTP response, which is basically :
    • a status code
    • a message.
    -

    - -

    -Definition at line 66 of file Ftp.hpp.

    Member Enumeration Documentation

    +

    Definition at line 66 of file Ftp.hpp.

    +

    Member Enumeration Documentation

    @@ -173,106 +180,106 @@ Enumerate all the valid status codes returned in a FTP response.

    Enumerator:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    RestartMarkerReply  +
    RestartMarkerReply  Restart marker reply.
    ServiceReadySoon  +
    ServiceReadySoon  Service ready in N minutes.
    DataConnectionAlreadyOpened  +
    DataConnectionAlreadyOpened  Data connection already opened, transfer starting.
    OpeningDataConnection  +
    OpeningDataConnection  File status ok, about to open data connection.
    Ok  +
    Ok  Command ok.
    PointlessCommand  +
    PointlessCommand  Command not implemented.
    SystemStatus  +
    SystemStatus  System status, or system help reply.
    DirectoryStatus  +
    DirectoryStatus  Directory status.
    FileStatus  +
    FileStatus  File status.
    HelpMessage  +
    HelpMessage  Help message.
    SystemType  +
    SystemType  NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
    ServiceReady  +
    ServiceReady  Service ready for new user.
    ClosingConnection  +
    ClosingConnection  Service closing control connection.
    DataConnectionOpened  +
    DataConnectionOpened  Data connection open, no transfer in progress.
    ClosingDataConnection  +
    ClosingDataConnection  Closing data connection, requested file action successful.
    EnteringPassiveMode  +
    EnteringPassiveMode  Entering passive mode.
    LoggedIn  +
    LoggedIn  User logged in, proceed. Logged out if appropriate.
    FileActionOk  +
    FileActionOk  Requested file action ok.
    DirectoryOk  +
    DirectoryOk  PATHNAME created.
    NeedPassword  +
    NeedPassword  User name ok, need password.
    NeedAccountToLogIn  +
    NeedAccountToLogIn  Need account for login.
    NeedInformation  +
    NeedInformation  Requested file action pending further information.
    ServiceUnavailable  +
    ServiceUnavailable  Service not available, closing control connection.
    DataConnectionUnavailable  +
    DataConnectionUnavailable  Can't open data connection.
    TransferAborted  +
    TransferAborted  Connection closed, transfer aborted.
    FileActionAborted  +
    FileActionAborted  Requested file action not taken.
    LocalError  +
    LocalError  Requested action aborted, local error in processing.
    InsufficientStorageSpace  +
    InsufficientStorageSpace  Requested action not taken; insufficient storage space in system, file unavailable.
    CommandUnknown  +
    CommandUnknown  Syntax error, command unrecognized.
    ParametersUnknown  +
    ParametersUnknown  Syntax error in parameters or arguments.
    CommandNotImplemented  +
    CommandNotImplemented  Command not implemented.
    BadCommandSequence  +
    BadCommandSequence  Bad sequence of commands.
    ParameterNotImplemented  +
    ParameterNotImplemented  Command not implemented for that parameter.
    NotLoggedIn  +
    NotLoggedIn  Not logged in.
    NeedAccountToStore  +
    NeedAccountToStore  Need account for storing files.
    FileUnavailable  +
    FileUnavailable  Requested action not taken, file unavailable.
    PageTypeUnknown  +
    PageTypeUnknown  Requested action aborted, page type unknown.
    NotEnoughMemory  +
    NotEnoughMemory  Requested file action aborted, exceeded storage allocation.
    FilenameNotAllowed  +
    FilenameNotAllowed  Requested action not taken, file name not allowed.
    InvalidResponse  +
    InvalidResponse  Response is not a valid FTP one.
    ConnectionFailed  +
    ConnectionFailed  Connection with server failed.
    ConnectionClosed  +
    ConnectionClosed  Connection with server closed.
    InvalidFile  +
    InvalidFile  Invalid file to upload / download.
    -

    -Definition at line 74 of file Ftp.hpp. +

    Definition at line 74 of file Ftp.hpp.

    +

    Constructor & Destructor Documentation

    - +
    - + @@ -286,7 +293,7 @@ Definition at line 74 of fil - +
    sf::Ftp::Response::Response sf::Ftp::Ftp::Response::Response ( Status  Code = InvalidResponse,
    )
    @@ -302,41 +309,45 @@ Default constructor. +

    Definition at line 84 of file Ftp.cpp.

    +

    Member Function Documentation

    - +
    - + - +
    bool sf::Ftp::Response::IsOk const std::string & sf::Ftp::Ftp::Response::GetMessage (  )  const const

    -Convenience function to check if the response status code means a success. +Get the full message contained in the response.

    -

    Returns:
    True if status is success (code < 400)
    +
    Returns:
    The response message
    + +

    Definition at line 114 of file Ftp.cpp.

    - +

    - + - +
    Status sf::Ftp::Response::GetStatus Ftp::Response::Status sf::Ftp::Ftp::Response::GetStatus (  )  const const
    @@ -347,32 +358,38 @@ Get the response status code.

    Returns:
    Status code
    +

    Definition at line 105 of file Ftp.cpp.

    +

- +

- + - +
const std::string& sf::Ftp::Response::GetMessage bool sf::Ftp::Ftp::Response::IsOk (  )  const const

-Get the full message contained in the response. +Convenience function to check if the response status code means a success.

-

Returns:
The response message
+Convenience function to check if the response status code means a success.

+

Returns:
True if status is success (code < 400)
+ +

Definition at line 96 of file Ftp.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: +
- -
- -
-
- + + +

sf::Glyph Member List

This is the complete list of members for sf::Glyph, including all inherited members.

-
Advancesf::Glyph
Glyph()sf::Glyph [inline]
Rectanglesf::Glyph
TexCoordssf::Glyph
+

+ - -
- + + -
- -
-
-sf::Glyph
+

sf::Glyph Class Reference

Structure describing a glyph (a visual character). More...

#include <Glyph.hpp> +

+

List of all members. @@ -53,10 +58,8 @@

Detailed Description

Structure describing a glyph (a visual character). -

- -

-Definition at line 40 of file Glyph.hpp.

Constructor & Destructor Documentation

+

Definition at line 40 of file Glyph.hpp.

+

Constructor & Destructor Documentation

@@ -66,7 +69,7 @@ Definition at line 40 of f (  )  - [inline] + [inline]
@@ -76,8 +79,8 @@ Definition at line 40 of f Default constructor.

-

-Definition at line 48 of file Glyph.hpp. +

Definition at line 48 of file Glyph.hpp.

+

Member Data Documentation

@@ -96,8 +99,8 @@ Definition at line 48 of f Offset to move horizontically to the next character.

-

-Definition at line 53 of file Glyph.hpp. +

Definition at line 53 of file Glyph.hpp.

+

@@ -115,8 +118,8 @@ Definition at line 53 of f Bounding rectangle of the glyph, in relative coordinates.

-

-Definition at line 54 of file Glyph.hpp. +

Definition at line 54 of file Glyph.hpp.

+

@@ -134,12 +137,13 @@ Definition at line 54 of f Texture coordinates of the glyph inside the bitmap font.

-

-Definition at line 55 of file Glyph.hpp. +

Definition at line 55 of file Glyph.hpp.

+

The documentation for this class was generated from the following file: + - -
- -
-
- + + +

sf::Http Member List

This is the complete list of members for sf::Http, including all inherited members.

- + -
Http()sf::Http
Http(const std::string &Host, unsigned short Port=0)sf::Http
NonCopyable()sf::NonCopyable [inline, private]
SendRequest(const Request &Req)sf::Http
SendRequest(const Request &Req, float Timeout=0.f)sf::Http
SetHost(const std::string &Host, unsigned short Port=0)sf::Http
+

+ - -
- + + -
- -
-
-sf::Http
+

sf::Http Class Reference

This class provides methods for manipulating the HTTP protocol (described in RFC 1945). More...

#include <Http.hpp>

-

Inheritance diagram for sf::Http: +

+Inheritance diagram for sf::Http:
+
+

sf::NonCopyable +
+ +

List of all members. - - - - - - - - - - - - - @@ -65,15 +61,26 @@ + + + + + + + + + + + + +

Public Member Functions

 Http ()
 Default constructor.
 Http (const std::string &Host, unsigned short Port=0)
 Construct the Http instance with the target host.
void SetHost (const std::string &Host, unsigned short Port=0)
 Set the target host.
Response SendRequest (const Request &Req)
 Send a HTTP request and return the server's response.

Classes

class  Request
 This class wraps an HTTP response, which is basically :
  • a header with a status code and a set of field/value pairs
  • a body (the content of the requested resource).
More...

Public Member Functions

 Http ()
 Default constructor.
 Http (const std::string &Host, unsigned short Port=0)
 Construct the Http instance with the target host.
void SetHost (const std::string &Host, unsigned short Port=0)
 Set the target host.
Response SendRequest (const Request &Req, float Timeout=0.f)
 Send a HTTP request and return the server's response.

Detailed Description

This class provides methods for manipulating the HTTP protocol (described in RFC 1945).

It can connect to a website, get its files, send requests, etc. -

- -

-Definition at line 45 of file Http.hpp.

Constructor & Destructor Documentation

+

Definition at line 45 of file Http.hpp.

+

Constructor & Destructor Documentation

@@ -83,7 +90,7 @@ Definition at line 45 of fi (  )  - +
@@ -93,6 +100,8 @@ Definition at line 45 of fi Default constructor.

+

Definition at line 308 of file Http.cpp.

+

@@ -114,7 +123,7 @@ Default constructor. ) - +

@@ -130,77 +139,94 @@ Construct the 319 of file Http.cpp.

+

Member Function Documentation

- +
- + - - + + - - + + - +
void sf::Http::SetHost Http::Response sf::Http::SendRequest (const std::string &  Host, const Request &  Req,
unsigned short  Port = 0 float  Timeout = 0.f 
)

-Set the target host. +Send a HTTP request and return the server's response.

+You must be connected to a host before sending requests. Any missing mandatory header field will be added with an appropriate value. Warning : this function waits for the server's response and may not return instantly; use a thread if you don't want to block your application.

Parameters:
- - + +
Host : Web server to connect to
Port : Port to use for connection (0 by default -- use the standard port of the protocol used)
Req : Request to send
Timeout : Maximum time to wait, in seconds (0 by default, means no timeout)
+
Returns:
Server's response
+You must be connected to a host before sending requests. Any missing mandatory header field will be added with an appropriate value. Warning : this function waits for the server's response and may not return instantly; use a thread if you don't want to block your application. +

Definition at line 367 of file Http.cpp.

- +

- + - - - - + + + + + + + + + + + + +
Response sf::Http::SendRequest void sf::Http::SetHost (const Request &  Req  ) const std::string &  Host,
unsigned short  Port = 0 
)

-Send a HTTP request and return the server's response. +Set the target host.

-You must be connected to a host before sending requests. Any missing mandatory header field will be added with an appropriate value. Warning : this function waits for the server's response and may not return instantly; use a thread if you don't want to block your application.

Parameters:
- + +
Req : Request to send
Host : Web server to connect to
Port : Port to use for connection (0 by default -- use the standard port of the protocol used)
-
Returns:
Server's response
+ +

Definition at line 328 of file Http.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- + + -
- -
-

sf::Http::Request Member List

This is the complete list of members for sf::Http::Request, including all inherited members.

- - - - - - - - - - - -
Get enum valuesf::Http::Request
Head enum valuesf::Http::Request
Http classsf::Http::Request [friend]
Method enum namesf::Http::Request
Post enum valuesf::Http::Request
Request(Method RequestMethod=Get, const std::string &URI="/", const std::string &Body="")sf::Http::Request
SetBody(const std::string &Body)sf::Http::Request
SetField(const std::string &Field, const std::string &Value)sf::Http::Request
SetHttpVersion(unsigned int Major, unsigned int Minor)sf::Http::Request
SetMethod(Method RequestMethod)sf::Http::Request
SetURI(const std::string &URI)sf::Http::Request
+

+

sf::Http::Http::Request Member List

This is the complete list of members for sf::Http::Http::Request, including all inherited members.

+ + + + + + + + + + + +
Get enum valuesf::Http::Http::Request
Head enum valuesf::Http::Http::Request
Http (defined in sf::Http::Http::Request)sf::Http::Http::Request [friend]
Method enum namesf::Http::Http::Request
Post enum valuesf::Http::Http::Request
Request(Method RequestMethod=Get, const std::string &URI="/", const std::string &Body="")sf::Http::Http::Request
SetBody(const std::string &Body)sf::Http::Http::Request
SetField(const std::string &Field, const std::string &Value)sf::Http::Http::Request
SetHttpVersion(unsigned int Major, unsigned int Minor)sf::Http::Http::Request
SetMethod(Method RequestMethod)sf::Http::Http::Request
SetURI(const std::string &URI)sf::Http::Http::Request

+ - -
- + + -
- -
-
-sf::Http::Request
-

sf::Http::Request Class Reference

This class wraps an HTTP request, which is basically :
    +
    +

    sf::Http::Http::Request Class Reference

    This class wraps an HTTP request, which is basically :
    • a header with a method, a target URI, and a set of field/value pairs
    • an optional body (for POST requests).
    More...

    #include <Http.hpp> +

    +

    List of all members. - + - - + + - - + + - - + + - - + + - - + + - + +class 

    Public Types

    enum  Method {
    -  Get, +  Get,
    -  Post, +  Post,
    -  Head +  Head
    }
     Enumerate the available HTTP methods for a request. More...

    Public Member Functions

     Request (Method RequestMethod=Get, const std::string &URI="/", const std::string &Body="")
     Request (Method RequestMethod=Get, const std::string &URI="/", const std::string &Body="")
     Default constructor.
    void SetField (const std::string &Field, const std::string &Value)
     Default constructor.
    void SetField (const std::string &Field, const std::string &Value)
     Set the value of a field; the field is added if it doesn't exist.
    void SetMethod (Method RequestMethod)
     Set the value of a field; the field is added if it doesn't exist.
    void SetMethod (Method RequestMethod)
     Set the request method.
    void SetURI (const std::string &URI)
     Set the request method.
    void SetURI (const std::string &URI)
     Set the target URI of the request.
    void SetHttpVersion (unsigned int Major, unsigned int Minor)
     Set the target URI of the request.
    void SetHttpVersion (unsigned int Major, unsigned int Minor)
     Set the HTTP version of the request.
    void SetBody (const std::string &Body)
     Set the HTTP version of the request.
    void SetBody (const std::string &Body)
     Set the body of the request.
     Set the body of the request.

    Friends

    -class Http
    Http

    Detailed Description

    This class wraps an HTTP request, which is basically :
    • a header with a method, a target URI, and a set of field/value pairs
    • an optional body (for POST requests).
    -

    - -

    -Definition at line 54 of file Http.hpp.

    Member Enumeration Documentation

    +

    Definition at line 54 of file Http.hpp.

    +

    Member Enumeration Documentation

    @@ -97,26 +100,26 @@ Enumerate the available HTTP methods for a request.

    Enumerator:
    - - -
    Get  +
    Get  Request in get mode, standard method to retrieve a page.
    Post  +
    Post  Request in post mode, usually to send data to a page.
    Head  +
    Head  Request a page's header only.
    -

    -Definition at line 61 of file Http.hpp. +

    Definition at line 61 of file Http.hpp.

    +

    Constructor & Destructor Documentation

    - +
    - + @@ -136,7 +139,7 @@ Definition at line 61 of fi - +
    sf::Http::Request::Request sf::Http::Http::Request::Request ( Method  RequestMethod = Get,
    )
    @@ -153,170 +156,183 @@ Default constructor. +

    Definition at line 54 of file Http.cpp.

    +

    Member Function Documentation

    - +
    - + - - - - - - - - - + + - -
    void sf::Http::Request::SetField void sf::Http::Http::Request::SetBody ( const std::string &  Field,
    const std::string &  Value 
    Body  )  )

    -Set the value of a field; the field is added if it doesn't exist. +Set the body of the request.

    +This parameter is optional and makes sense only for POST requests. This parameter is empty by default

    Parameters:
    - - +
    Field : Name of the field to set (case-insensitive)
    Value : Value of the field
    Body : Content of the request body
    +This parameter is optional and makes sense only for POST requests. This parameter is empty by default +

    Definition at line 114 of file Http.cpp.

    - +

    - + - - - - + + + + + + + + + + + + +
    void sf::Http::Request::SetMethod void sf::Http::Http::Request::SetField (Method  RequestMethod  ) const std::string &  Field,
    const std::string &  Value 
    )

    -Set the request method. +Set the value of a field; the field is added if it doesn't exist.

    -This parameter is Http::Request::Get by default

    Parameters:
    - + +
    RequestMethod : Method to use for the request
    Field : Name of the field to set (case-insensitive)
    Value : Value of the field
    +

    Definition at line 68 of file Http.cpp.

    +

    - +

    - + - - - - + + + + + + + + + + + + +
    void sf::Http::Request::SetURI void sf::Http::Http::Request::SetHttpVersion (const std::string &  URI  ) unsigned int  Major,
    unsigned int  Minor 
    )

    -Set the target URI of the request. +Set the HTTP version of the request.

    -This parameter is "/" by default

    +This parameter is 1.0 by default

    Parameters:
    - + +
    URI : URI to request, local to the host
    Major : Major version number
    Minor : Minor version number
    +This parameter is 1.0 by default +

    Definition at line 102 of file Http.cpp.

    - +

    - + - - - - - - - - - - + + + - -
    void sf::Http::Request::SetHttpVersion void sf::Http::Http::Request::SetMethod (unsigned int  Major,
    unsigned int  Minor 
    Method  RequestMethod  )  )

    -Set the HTTP version of the request. +Set the request method.

    -This parameter is 1.0 by default

    +This parameter is Http::Request::Get by default

    Parameters:
    - - +
    Major : Major version number
    Minor : Minor version number
    RequestMethod : Method to use for the request
    +This parameter is Get by default +

    Definition at line 78 of file Http.cpp.

    - +

    - + - + - +
    void sf::Http::Request::SetBody void sf::Http::Http::Request::SetURI ( const std::string &  Body URI  ) 

    -Set the body of the request. +Set the target URI of the request.

    -This parameter is optional and makes sense only for POST requests. This parameter is empty by default

    +This parameter is "/" by default

    Parameters:
    - +
    Body : Content of the request body
    URI : URI to request, local to the host
    +This parameter is "/" by default +

    Definition at line 88 of file Http.cpp.

    -

    The documentation for this class was generated from the following file: +
    The documentation for this class was generated from the following files: +
- -
- + + -
- -
-

sf::Http::Response Member List

This is the complete list of members for sf::Http::Response, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Accepted enum valuesf::Http::Response
BadGateway enum valuesf::Http::Response
BadRequest enum valuesf::Http::Response
ConnectionFailed enum valuesf::Http::Response
Created enum valuesf::Http::Response
Forbidden enum valuesf::Http::Response
GetBody() constsf::Http::Response
GetField(const std::string &Field) const sf::Http::Response
GetMajorHttpVersion() constsf::Http::Response
GetMinorHttpVersion() constsf::Http::Response
GetStatus() constsf::Http::Response
Http classsf::Http::Response [friend]
InternalServerError enum valuesf::Http::Response
InvalidResponse enum valuesf::Http::Response
MovedPermanently enum valuesf::Http::Response
MovedTemporarily enum valuesf::Http::Response
MultipleChoices enum valuesf::Http::Response
NoContent enum valuesf::Http::Response
NotFound enum valuesf::Http::Response
NotImplemented enum valuesf::Http::Response
NotModified enum valuesf::Http::Response
Ok enum valuesf::Http::Response
Response()sf::Http::Response
ServiceNotAvailable enum valuesf::Http::Response
Status enum namesf::Http::Response
Unauthorized enum valuesf::Http::Response
+

+

sf::Http::Http::Response Member List

This is the complete list of members for sf::Http::Http::Response, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Accepted enum valuesf::Http::Http::Response
BadGateway enum valuesf::Http::Http::Response
BadRequest enum valuesf::Http::Http::Response
ConnectionFailed enum valuesf::Http::Http::Response
Created enum valuesf::Http::Http::Response
Forbidden enum valuesf::Http::Http::Response
GetBody() const sf::Http::Http::Response
GetField(const std::string &Field) const sf::Http::Http::Response
GetMajorHttpVersion() const sf::Http::Http::Response
GetMinorHttpVersion() const sf::Http::Http::Response
GetStatus() const sf::Http::Http::Response
Http (defined in sf::Http::Http::Response)sf::Http::Http::Response [friend]
InternalServerError enum valuesf::Http::Http::Response
InvalidResponse enum valuesf::Http::Http::Response
MovedPermanently enum valuesf::Http::Http::Response
MovedTemporarily enum valuesf::Http::Http::Response
MultipleChoices enum valuesf::Http::Http::Response
NoContent enum valuesf::Http::Http::Response
NotFound enum valuesf::Http::Http::Response
NotImplemented enum valuesf::Http::Http::Response
NotModified enum valuesf::Http::Http::Response
Ok enum valuesf::Http::Http::Response
Response()sf::Http::Http::Response
ServiceNotAvailable enum valuesf::Http::Http::Response
Status enum namesf::Http::Http::Response
Unauthorized enum valuesf::Http::Http::Response

+ - -
- + + -
- -
-
-sf::Http::Response
-

sf::Http::Response Class Reference

This class wraps an HTTP response, which is basically :
    +
    +

    sf::Http::Http::Response Class Reference

    This class wraps an HTTP response, which is basically :
    • a header with a status code and a set of field/value pairs
    • a body (the content of the requested resource).
    More...

    #include <Http.hpp> +

    +

    List of all members. - + - - + + - - + + - - + + - - + + - - + + - + +class 

    Public Types

    enum  Status {
    -  Ok = 200, +  Ok = 200,
    -  Created = 201, +  Created = 201,
    -  Accepted = 202, +  Accepted = 202,
    -  NoContent = 204, +  NoContent = 204,
    -  MultipleChoices = 300, +  MultipleChoices = 300,
    -  MovedPermanently = 301, +  MovedPermanently = 301,
    -  MovedTemporarily = 302, +  MovedTemporarily = 302,
    -  NotModified = 304, +  NotModified = 304,
    -  BadRequest = 400, +  BadRequest = 400,
    -  Unauthorized = 401, +  Unauthorized = 401,
    -  Forbidden = 403, +  Forbidden = 403,
    -  NotFound = 404, +  NotFound = 404,
    -  InternalServerError = 500, +  InternalServerError = 500,
    -  NotImplemented = 501, +  NotImplemented = 501,
    -  BadGateway = 502, +  BadGateway = 502,
    -  ServiceNotAvailable = 503, +  ServiceNotAvailable = 503,
    -  InvalidResponse = 1000, +  InvalidResponse = 1000,
    -  ConnectionFailed = 1001 +  ConnectionFailed = 1001
    }
     Enumerate all the valid status codes returned in a HTTP response. More...

    Public Member Functions

     Response ()
     Response ()
     Default constructor.
    const std::string & GetField (const std::string &Field) const
     Default constructor.
    const std::string & GetField (const std::string &Field) const
     Get the value of a field.
    Status GetStatus () const
     Get the value of a field.
    Status GetStatus () const
     Get the header's status code.
    unsigned int GetMajorHttpVersion () const
     Get the header's status code.
    unsigned int GetMajorHttpVersion () const
     Get the major HTTP version number of the response.
    unsigned int GetMinorHttpVersion () const
     Get the major HTTP version number of the response.
    unsigned int GetMinorHttpVersion () const
     Get the major HTTP version number of the response.
    const std::string & GetBody () const
     Get the major HTTP version number of the response.
    const std::string & GetBody () const
     Get the body of the response.
     Get the body of the response.

    Friends

    -class Http
    Http

    Detailed Description

    This class wraps an HTTP response, which is basically :
    • a header with a status code and a set of field/value pairs
    • a body (the content of the requested resource).
    -

    - -

    -Definition at line 168 of file Http.hpp.

    Member Enumeration Documentation

    +

    Definition at line 168 of file Http.hpp.

    +

    Member Enumeration Documentation

    @@ -127,60 +130,60 @@ Enumerate all the valid status codes returned in a HTTP response.

    Enumerator:
    - - - - - - - - - - - - - - - - - -
    Ok  +
    Ok  Most common code returned when operation was successful.
    Created  +
    Created  The resource has successfully been created.
    Accepted  +
    Accepted  The request has been accepted, but will be processed later by the server.
    NoContent  +
    NoContent  Sent when the server didn't send any data in return.
    MultipleChoices  +
    MultipleChoices  The requested page can be accessed from several locations.
    MovedPermanently  +
    MovedPermanently  The requested page has permanently moved to a new location.
    MovedTemporarily  +
    MovedTemporarily  The requested page has temporarily moved to a new location.
    NotModified  +
    NotModified  For conditionnal requests, means the requested page hasn't changed and doesn't need to be refreshed.
    BadRequest  +
    BadRequest  The server couldn't understand the request (syntax error).
    Unauthorized  +
    Unauthorized  The requested page needs an authentification to be accessed.
    Forbidden  +
    Forbidden  The requested page cannot be accessed at all, even with authentification.
    NotFound  +
    NotFound  The requested page doesn't exist.
    InternalServerError  +
    InternalServerError  The server encountered an unexpected error.
    NotImplemented  +
    NotImplemented  The server doesn't implement a requested feature.
    BadGateway  +
    BadGateway  The gateway server has received an error from the source server.
    ServiceNotAvailable  +
    ServiceNotAvailable  The server is temporarily unavailable (overloaded, in maintenance, ...).
    InvalidResponse  +
    InvalidResponse  Response is not a valid HTTP one.
    ConnectionFailed  +
    ConnectionFailed  Connection with server failed.
    -

    -Definition at line 176 of file Http.hpp. +

    Definition at line 176 of file Http.hpp.

    +

    Constructor & Destructor Documentation

    - +
    - + - +
    sf::Http::Response::Response sf::Http::Http::Response::Response (  ) 
    @@ -190,69 +193,80 @@ Definition at line 176 of f Default constructor.

    +

    Definition at line 169 of file Http.cpp.

    +

    Member Function Documentation

    - +
    - + - - + - +
    const std::string& sf::Http::Response::GetField const std::string & sf::Http::Http::Response::GetBody (const std::string &  Field  )  const const

    -Get the value of a field. +Get the body of the response.

    -

    Parameters:
    - - -
    Field : Name of the field to get (case-insensitive)
    -
    -
    Returns:
    Value of the field, or empty string if not found
    +The body can contain :
      +
    • the requested page (for GET requests)
    • a response from the server (for POST requests)
    • nothing (for HEAD requests)
    • an error message (in case of an error)
    +

    +

    Returns:
    The response body
    +The body can contain :
      +
    • the requested page (for GET requests)
    • a response from the server (for POST requests)
    • nothing (for HEAD requests)
    • an error message (in case of an error)
    + +

    Definition at line 230 of file Http.cpp.

    - +

    - + - + + - +
    Status sf::Http::Response::GetStatus const std::string & sf::Http::Http::Response::GetField ( const std::string &  Field  )  const const

    -Get the header's status code. +Get the value of a field.

    -

    Returns:
    Header's status code
    +
    Parameters:
    + + +
    Field : Name of the field to get (case-insensitive)
    +
    +
    Returns:
    Value of the field, or empty string if not found
    + +

    Definition at line 181 of file Http.cpp.

    - +

    - + - +
    unsigned int sf::Http::Response::GetMajorHttpVersion unsigned int sf::Http::Http::Response::GetMajorHttpVersion (  )  const const
    @@ -263,18 +277,20 @@ Get the major HTTP version number of the response.

    Returns:
    Major version number
    +

    Definition at line 208 of file Http.cpp.

    +

- +

- + - +
unsigned int sf::Http::Response::GetMinorHttpVersion unsigned int sf::Http::Http::Response::GetMinorHttpVersion (  )  const const
@@ -285,35 +301,37 @@ Get the major HTTP version number of the response.

Returns:
Major version number
+

Definition at line 217 of file Http.cpp.

+

- +

- + - +
const std::string& sf::Http::Response::GetBody Http::Response::Status sf::Http::Http::Response::GetStatus (  )  const const

-Get the body of the response. -

-The body can contain :

    -
  • the requested page (for GET requests)
  • a response from the server (for POST requests)
  • nothing (for HEAD requests)
  • an error message (in case of an error)
+Get the header's status code.

-

Returns:
The response body
+
Returns:
Header's status code
+ +

Definition at line 199 of file Http.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: +
- -
- -
-
- + + +

sf::IPAddress Member List

This is the complete list of members for sf::IPAddress, including all inherited members.

- - + + - + @@ -43,9 +46,10 @@ - - -
GetLocalAddress()sf::IPAddress [static]
GetPublicAddress()sf::IPAddress [static]
GetLocalAddress()sf::IPAddress [static]
GetPublicAddress(float Timeout=0.f)sf::IPAddress [static]
IPAddress()sf::IPAddress
IPAddress(const std::string &Address)sf::IPAddress
IPAddress(const char *Address)sf::IPAddress
IPAddress(Uint8 Byte0, Uint8 Byte1, Uint8 Byte2, Uint8 Byte3)sf::IPAddress
IPAddress(Uint32 Address)sf::IPAddress
IsValid() constsf::IPAddress
IsValid() const sf::IPAddress
LocalHostsf::IPAddress [static]
operator!=(const IPAddress &Other) const sf::IPAddress
operator<(const IPAddress &Other) const sf::IPAddress
operator==(const IPAddress &Other) const sf::IPAddress
operator>(const IPAddress &Other) const sf::IPAddress
operator>=(const IPAddress &Other) const sf::IPAddress
ToInteger() constsf::IPAddress
ToString() constsf::IPAddress
+ ToInteger() const sf::IPAddress + ToString() const sf::IPAddress +

+ - -
- -
-
- -
-
-sf::IPAddress
+ + +

sf::IPAddress Class Reference

IPAddress provides easy manipulation of IP v4 addresses. More...

#include <IPAddress.hpp> +

+

List of all members. @@ -52,15 +57,15 @@ - + - - + + - - + + - + @@ -80,12 +85,12 @@ - + - - + + - + @@ -93,10 +98,8 @@
 IPAddress (Uint32 Address)
 Construct the address from a 32-bits integer.
bool IsValid () const
bool IsValid () const
 Tell if the address is a valid one.
std::string ToString () const
 Tell if the address is a valid one.
std::string ToString () const
 Get a string representation of the address.
Uint32 ToInteger () const
 Get a string representation of the address.
Uint32 ToInteger () const
 Get an integer representation of the address.
 Get an integer representation of the address.
bool operator== (const IPAddress &Other) const
 Comparison operator ==.
 Comparison operator >=.

Static Public Member Functions

static IPAddress GetLocalAddress ()
static IPAddress GetLocalAddress ()
 Get the computer's local IP address (from the LAN point of view).
static IPAddress GetPublicAddress ()
 Get the computer's local IP address (from the LAN point of view).
static IPAddress GetPublicAddress (float Timeout=0.f)
 Get the computer's public IP address (from the web point of view).
 Get the computer's public IP address (from the web point of view).

Static Public Attributes

static const IPAddress LocalHost

Detailed Description

IPAddress provides easy manipulation of IP v4 addresses. -

- -

-Definition at line 42 of file IPAddress.hpp.

Constructor & Destructor Documentation

+

Definition at line 42 of file IPAddress.hpp.

+

Constructor & Destructor Documentation

@@ -106,7 +109,7 @@ Definition at line 42 (  )  - +
@@ -115,6 +118,8 @@ Definition at line 42

Default constructor -- constructs an invalid address.

+Default constructor. +

Definition at line 45 of file IPAddress.cpp.

@@ -128,7 +133,7 @@ Default constructor -- constructs an invalid address. const std::string &  Address  )  - +

@@ -143,6 +148,8 @@ Construct the address from a string. +

Definition at line 55 of file IPAddress.cpp.

+

@@ -155,7 +162,7 @@ Construct the address from a string. const char *  Address  )  - + @@ -164,12 +171,15 @@ Construct the address from a string.

Construct the address from a C-style string ; Needed for implicit conversions from literal strings to IPAddress to work.

+Construct the address from a C-style string ; Needed for implicit conversions from literal strings to IPAddress to work.

Parameters:
Address : IP address ("xxx.xxx.xxx.xxx") or network name
+

Definition at line 82 of file IPAddress.cpp.

+

@@ -203,7 +213,7 @@ Construct the address from a C-style string ; Needed for implicit conversions fr ) - + @@ -221,6 +231,8 @@ Construct the address from 4 bytes. +

Definition at line 108 of file IPAddress.cpp.

+

@@ -233,7 +245,7 @@ Construct the address from 4 bytes. Uint32  Address  )  - + @@ -248,285 +260,315 @@ Construct the address from a 32-bits integer. +

Definition at line 117 of file IPAddress.cpp.

+

Member Function Documentation

- +
- + - +
bool sf::IPAddress::IsValid IPAddress sf::IPAddress::GetLocalAddress (  )  const [static]

-Tell if the address is a valid one. +Get the computer's local IP address (from the LAN point of view).

-

Returns:
True if address has a valid syntax
+
Returns:
Local IP address
+ +

Definition at line 156 of file IPAddress.cpp.

- +

- + - + + - +
std::string sf::IPAddress::ToString IPAddress sf::IPAddress::GetPublicAddress ( float  Timeout = 0.f  )  const [static]

-Get a string representation of the address. +Get the computer's public IP address (from the web point of view).

-

Returns:
String representation of the IP address ("xxx.xxx.xxx.xxx")
+The only way to get a public address is to ask it to a distant website ; as a consequence, this function may be very slow -- use it as few as possible !

+

Parameters:
+ + +
Timeout : Maximum time to wait, in seconds (0 by default : no timeout)
+
+
Returns:
Public IP address
+ +

Definition at line 204 of file IPAddress.cpp.

- +

- + - +
Uint32 sf::IPAddress::ToInteger bool sf::IPAddress::IsValid (  )  const const

-Get an integer representation of the address. +Tell if the address is a valid one.

-

Returns:
32-bits integer containing the 4 bytes of the address, in system endianness
+
Returns:
True if address has a valid syntax
+ +

Definition at line 126 of file IPAddress.cpp.

- +

- + - + + - +
static IPAddress sf::IPAddress::GetLocalAddress bool sf::IPAddress::operator!= ( const IPAddress &  Other  )  [static] const

-Get the computer's local IP address (from the LAN point of view). +Comparison operator !=.

-

Returns:
Local IP address
+
Parameters:
+ + +
Other : Address to compare
+
+
Returns:
True if *this != Other
+ +

Definition at line 235 of file IPAddress.cpp.

- +

- + - + + - +
static IPAddress sf::IPAddress::GetPublicAddress bool sf::IPAddress::operator< ( const IPAddress &  Other  )  [static] const

-Get the computer's public IP address (from the web point of view). +Comparison operator <.

-The only way to get a public address is to ask it to a distant website ; as a consequence, this function may be very slow -- use it as few as possible !

-

Returns:
Public IP address
+
Parameters:
+ + +
Other : Address to compare
+
+
Returns:
True if *this < Other
+ +

Definition at line 244 of file IPAddress.cpp.

- +

- + - +
bool sf::IPAddress::operator== bool sf::IPAddress::operator<= ( const IPAddress &  Other  )  const const

-Comparison operator ==. +Comparison operator <=.

Parameters:
Other : Address to compare
-
Returns:
True if *this == Other
+
Returns:
True if *this <= Other
+ +

Definition at line 262 of file IPAddress.cpp.

- +

- + - +
bool sf::IPAddress::operator!= bool sf::IPAddress::operator== ( const IPAddress &  Other  )  const const

-Comparison operator !=. +Comparison operator ==.

Parameters:
Other : Address to compare
-
Returns:
True if *this != Other
+
Returns:
True if *this == Other
+ +

Definition at line 226 of file IPAddress.cpp.

- +

- + - +
bool sf::IPAddress::operator< bool sf::IPAddress::operator> ( const IPAddress &  Other  )  const const

-Comparison operator <. +Comparison operator >.

Parameters:
Other : Address to compare
-
Returns:
True if *this < Other
+
Returns:
True if *this > Other
+ +

Definition at line 253 of file IPAddress.cpp.

- +

- + - +
bool sf::IPAddress::operator> bool sf::IPAddress::operator>= ( const IPAddress &  Other  )  const const

-Comparison operator >. +Comparison operator >=.

Parameters:
Other : Address to compare
-
Returns:
True if *this > Other
+
Returns:
True if *this >= Other
+ +

Definition at line 271 of file IPAddress.cpp.

- +

- + - - + - +
bool sf::IPAddress::operator<= Uint32 sf::IPAddress::ToInteger (const IPAddress &  Other  )  const const

-Comparison operator <=. +Get an integer representation of the address.

-

Parameters:
- - -
Other : Address to compare
-
-
Returns:
True if *this <= Other
+
Returns:
32-bits integer containing the 4 bytes of the address, in system endianness
+ +

Definition at line 147 of file IPAddress.cpp.

- +

- + - - + - +
bool sf::IPAddress::operator>= std::string sf::IPAddress::ToString (const IPAddress &  Other  )  const const

-Comparison operator >=. +Get a string representation of the address.

-

Parameters:
- - -
Other : Address to compare
-
-
Returns:
True if *this >= Other
+
Returns:
String representation of the IP address ("xxx.xxx.xxx.xxx")
+ +

Definition at line 135 of file IPAddress.cpp.

@@ -545,13 +587,14 @@ Comparison operator >=.

Local host address (to connect to the same computer).

+Static member data. +

Definition at line 196 of file IPAddress.hpp.

-

-Definition at line 194 of file IPAddress.hpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Image Member List

This is the complete list of members for sf::Image, including all inherited members.

- - + + - - - + + + - - + + - + - - - + + + @@ -57,7 +60,8 @@ -
Bind() constsf::Image
Copy(const Image &Source, unsigned int DestX, unsigned int DestY, const IntRect &SourceRect=IntRect(0, 0, 0, 0))sf::Image
Bind() const sf::Image
Copy(const Image &Source, unsigned int DestX, unsigned int DestY, const IntRect &SourceRect=IntRect(0, 0, 0, 0), bool ApplyAlpha=false)sf::Image
CopyScreen(RenderWindow &Window, const IntRect &SourceRect=IntRect(0, 0, 0, 0))sf::Image
Create(unsigned int Width, unsigned int Height, Color Col=Color(0, 0, 0, 255))sf::Image
CreateMaskFromColor(Color ColorKey, Uint8 Alpha=0)sf::Image
GetHeight() constsf::Image
GetPixel(unsigned int X, unsigned int Y) constsf::Image
GetPixelsPtr() constsf::Image
GetHeight() const sf::Image
GetPixel(unsigned int X, unsigned int Y) const sf::Image
GetPixelsPtr() const sf::Image
GetTexCoords(const IntRect &Rect, bool Adjust=true) const sf::Image
GetValidTextureSize(unsigned int Size)sf::Image [static]
GetWidth() constsf::Image
GetValidTextureSize(unsigned int Size)sf::Image [static]
GetWidth() const sf::Image
Image()sf::Image
Image(const Image &Copy)sf::Image
Image(unsigned int Width, unsigned int Height, const Color &Col=Color(0, 0, 0, 255))sf::Image
Image(unsigned int Width, unsigned int Height, const Uint8 *Data)sf::Image
IsSmooth() constsf::Image
IsSmooth() const sf::Image
LoadFromFile(const std::string &Filename)sf::Image
LoadFromMemory(const char *Data, std::size_t SizeInBytes)sf::Image
LoadFromPixels(unsigned int Width, unsigned int Height, const Uint8 *Data)sf::Image
operator=(const Image &Other)sf::Image
sf::Resource< Image >::operator=(const Resource< Image > &Other)sf::Resource< Image > [protected]
RenderImage classsf::Image [friend]
operator=(const Image &Other)sf::Image
Resource< Image >::operator=(const Resource< Image > &Other)sf::Resource< Image > [protected]
RenderImage (defined in sf::Image)sf::Image [friend]
Resource()sf::Resource< Image > [protected]
Resource(const Resource< Image > &Copy)sf::Resource< Image > [protected]
SaveToFile(const std::string &Filename) const sf::Image
SetSmooth(bool Smooth)sf::Image
~Image()sf::Image
~Resource()sf::Resource< Image > [protected]
+

+ - -
- -
-
- -
-
-sf::Image
-

sf::Image Class Reference

Image is the low-level class for loading and manipulating images. + + +
+

sf::Image Class Reference

Image is the low-level class for loading and manipulating images. More...

#include <Image.hpp>

-

Inheritance diagram for sf::Image: +

+Inheritance diagram for sf::Image:
+
+

sf::Resource< Image > +
+ +

List of all members. @@ -75,57 +84,55 @@ - + - + - + - - + + - - + + - + - + - - + + - - + + - + - + - + - + - + +class 

Public Member Functions

void CreateMaskFromColor (Color ColorKey, Uint8 Alpha=0)
 Create transparency mask from a specified colorkey.
void Copy (const Image &Source, unsigned int DestX, unsigned int DestY, const IntRect &SourceRect=IntRect(0, 0, 0, 0))
void Copy (const Image &Source, unsigned int DestX, unsigned int DestY, const IntRect &SourceRect=IntRect(0, 0, 0, 0), bool ApplyAlpha=false)
 Copy pixels from another image onto this one.
 Copy pixels from another image onto this one.
bool CopyScreen (RenderWindow &Window, const IntRect &SourceRect=IntRect(0, 0, 0, 0))
 Create the image from the current contents of the given window.
void SetPixel (unsigned int X, unsigned int Y, const Color &Col)
 Change the color of a pixel.
const Color & GetPixel (unsigned int X, unsigned int Y) const
const Color & GetPixel (unsigned int X, unsigned int Y) const
 Get a pixel from the image.
const Uint8 * GetPixelsPtr () const
 Get a pixel from the image.
const Uint8 * GetPixelsPtr () const
 Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image.
void Bind () const
 Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image.
void Bind () const
 Bind the image for rendering.
 Bind the image for rendering.
void SetSmooth (bool Smooth)
 Enable or disable image smooth filter.
unsigned int GetWidth () const
unsigned int GetWidth () const
 Return the width of the image.
unsigned int GetHeight () const
 Return the width of the image.
unsigned int GetHeight () const
 Return the height of the image.
bool IsSmooth () const
 Return the height of the image.
bool IsSmooth () const
 Tells whether the smooth filtering is enabled or not.
 Tells whether the smooth filtering is enabled or not.
FloatRect GetTexCoords (const IntRect &Rect, bool Adjust=true) const
 Convert a subrect expressed in pixels, into float texture coordinates.
Image & operator= (const Image &Other)
Image & operator= (const Image &Other)
 Assignment operator.
 Assignment operator.

Static Public Member Functions

static unsigned int GetValidTextureSize (unsigned int Size)
static unsigned int GetValidTextureSize (unsigned int Size)
 Get a valid texture size according to hardware support.
 Get a valid texture size according to hardware support.

Friends

-class RenderImage
RenderImage

Detailed Description

Image is the low-level class for loading and manipulating images. -

- -

-Definition at line 47 of file Image.hpp.

Constructor & Destructor Documentation

+

Definition at line 47 of file Image.hpp.

+

Constructor & Destructor Documentation

@@ -135,7 +142,7 @@ Definition at line 47 of f (  )  - +
@@ -145,6 +152,8 @@ Definition at line 47 of f Default constructor.

+

Definition at line 43 of file Image.cpp.

+

@@ -157,7 +166,7 @@ Default constructor. const Image &  Copy  )  - +

@@ -172,6 +181,8 @@ Copy constructor. +

Definition at line 60 of file Image.cpp.

+

@@ -199,7 +210,7 @@ Copy constructor. ) - + @@ -216,6 +227,8 @@ Construct an empty image. +

Definition at line 79 of file Image.cpp.

+

@@ -243,7 +256,7 @@ Construct an empty image. ) - + @@ -260,6 +273,8 @@ Construct the image from pixels in memory. +

Definition at line 96 of file Image.cpp.

+

@@ -271,7 +286,7 @@ Construct the image from pixels in memory. (  )  - + @@ -281,145 +296,133 @@ Construct the image from pixels in memory. Destructor.

+

Definition at line 113 of file Image.cpp.

+

Member Function Documentation

- +
- + - - + - +
bool sf::Image::LoadFromFile void sf::Image::Bind (const std::string &  Filename  )  const

-Load the image from a file. +Bind the image for rendering.

-

Parameters:
- - -
Filename : Path of the image file to load
-
-
Returns:
True if loading was successful
+ +

Definition at line 473 of file Image.cpp.

- +

- + - - + + - - + + + - - - -
bool sf::Image::LoadFromMemory void sf::Image::Copy (const char *  Data, const Image &  Source,
std::size_t  SizeInBytes unsigned int  DestX,
)
-
-
- -

-Load the image from a file in memory. -

-

Parameters:
- - - -
Data : Pointer to the file data in memory
SizeInBytes : Size of the data to load, in bytes
-
-
Returns:
True if loading was successful
- -
-

- -

-
- - - - - + - - + + - - + + - +
bool sf::Image::LoadFromPixels ( unsigned int  Width, DestY,
unsigned int  Height, const IntRect &  SourceRect = IntRect(0, 0, 0, 0),
const Uint8 *  Data bool  ApplyAlpha = false 
)

-Load the image directly from an array of pixels. +Copy pixels from another image onto this one.

+This function does a slow pixel copy and should only be used at initialization time

Parameters:
- - - + + + + +
Width : Image width
Height : Image height
Data : Pointer to the pixels in memory (assumed format is RGBA)
Source : Source image to copy
DestX : X coordinate of the destination position
DestY : Y coordinate of the destination position
SourceRect : Sub-rectangle of the source image to copy (empty by default - entire image)
ApplyAlpha : Should the copy take in account the source transparency? (false by default)
-
Returns:
True if loading was successful
+This function does a slow pixel copy and should only be used at initialization time +

Definition at line 270 of file Image.cpp.

- +

- + - - - - + + + + + + + + + + + + +
bool sf::Image::SaveToFile bool sf::Image::CopyScreen (const std::string &  Filename  )  constRenderWindow &  Window,
const IntRect &  SourceRect = IntRect(0, 0, 0, 0) 
)

-Save the content of the image to a file. +Create the image from the current contents of the given window.

+Create the image from the current contents of the given window.

Parameters:
- + +
Filename : Path of the file to save (overwritten if already exist)
Window : Window to capture
SourceRect : Sub-rectangle of the screen to copy (empty by default - entire image)
-
Returns:
True if saving was successful
+
Returns:
True if copy was successful
+ +

Definition at line 358 of file Image.cpp.

@@ -448,7 +451,7 @@ Save the content of the image to a file. ) - + @@ -466,6 +469,8 @@ Create an empty image.

Returns:
True if creation was successful
+

Definition at line 222 of file Image.cpp.

+

@@ -487,7 +492,7 @@ Create an empty image. ) - + @@ -503,413 +508,475 @@ Create transparency mask from a specified colorkey. +

Definition at line 249 of file Image.cpp.

+

- +

- + - - + + + +
void sf::Image::Copy unsigned int sf::Image::GetHeight (const Image &  Source,  )  const
+
+
+ +

+Return the height of the image. +

+

Returns:
Height in pixels
+ +

Definition at line 526 of file Image.cpp.

+ +
+

+ +

+
+ - - + + - + - - - - - - - + - +
const Color & sf::Image::GetPixel ( unsigned int  DestX, X,
unsigned int  DestY,
const IntRect &  SourceRect = IntRect(0, 0, 0, 0)  Y 
) const

-Copy pixels from another image onto this one. +Get a pixel from the image.

-This function does a slow pixel copy and should only be used at initialization time

Parameters:
- - - - + +
Source : Source image to copy
DestX : X coordinate of the destination position
DestY : Y coordinate of the destination position
SourceRect : Sub-rectangle of the source image to copy (empty by default - entire image)
X : X coordinate of pixel in the image
Y : Y coordinate of pixel in the image
+
Returns:
Color of pixel (X, Y)
+ +

Definition at line 431 of file Image.cpp.

- +

- + - - - - - - - - - - - - - + + +
bool sf::Image::CopyScreen const Uint8 * sf::Image::GetPixelsPtr (RenderWindow &  Window,
const IntRect &  SourceRect = IntRect(0, 0, 0, 0) 
)  )  const

-Create the image from the current contents of the given window. +Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image.

-

Parameters:
- - - -
Window : Window to capture
SourceRect : Sub-rectangle of the screen to copy (empty by default - entire image)
-
-
Returns:
True if copy was successful
+Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image.

+

Returns:
Const pointer to the array of pixels
+ +

Definition at line 453 of file Image.cpp.

- +

- + - - - - - - - - + + - - + + - +
void sf::Image::SetPixel FloatRect sf::Image::GetTexCoords (unsigned int  X,
unsigned int  Y, const IntRect &  Rect,
const Color &  Col bool  Adjust = true 
) const

-Change the color of a pixel. +Convert a subrect expressed in pixels, into float texture coordinates.

+Convert a subrect expressed in pixels, into float texture coordinates.

Parameters:
- - - + +
X : X coordinate of pixel in the image
Y : Y coordinate of pixel in the image
Col : New color for pixel (X, Y)
Rect : Sub-rectangle of image to convert
Adjust : Pass true to apply the half-texel adjustment
+
Returns:
Texture coordinates corresponding to the sub-rectangle
+ +

Definition at line 545 of file Image.cpp.

- +

- + - - - - - - - - - - - - + + +
const Color& sf::Image::GetPixel unsigned int sf::Image::GetValidTextureSize ( unsigned int  X,
unsigned int  Y 
) const Size  )  [static]

-Get a pixel from the image. +Get a valid texture size according to hardware support.

Parameters:
- - +
X : X coordinate of pixel in the image
Y : Y coordinate of pixel in the image
Size : Size to convert
-
Returns:
Color of pixel (X, Y)
+
Returns:
Valid nearest size (greater than or equal to specified size)
+ +

Definition at line 570 of file Image.cpp.

- +

- + - +
const Uint8* sf::Image::GetPixelsPtr unsigned int sf::Image::GetWidth (  )  const const

-Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image. +Return the width of the image.

-

Returns:
Const pointer to the array of pixels
+
Returns:
Width in pixels
+ +

Definition at line 517 of file Image.cpp.

- +

- + - +
void sf::Image::Bind bool sf::Image::IsSmooth (  )  const const

-Bind the image for rendering. +Tells whether the smooth filtering is enabled or not.

+

Returns:
True if image smoothing is enabled
+ +

Definition at line 535 of file Image.cpp.

- +

- + - - + + - +
void sf::Image::SetSmooth bool sf::Image::LoadFromFile (bool  Smooth const std::string &  Filename  ) 

-Enable or disable image smooth filter. +Load the image from a file.

-This parameter is enabled by default

Parameters:
- +
Smooth : True to enable smoothing filter, false to disable it
Filename : Path of the image file to load
+
Returns:
True if loading was successful
+ +

Definition at line 123 of file Image.cpp.

- +

- + - - - + + + + + + + + + + + + +
unsigned int sf::Image::GetWidth bool sf::Image::LoadFromMemory (  )  constconst char *  Data,
std::size_t  SizeInBytes 
)

-Return the width of the image. +Load the image from a file in memory.

-

Returns:
Width in pixels
+
Parameters:
+ + + +
Data : Pointer to the file data in memory
SizeInBytes : Size of the data to load, in bytes
+
+
Returns:
True if loading was successful
+ +

Definition at line 145 of file Image.cpp.

- +

- + - - - + + + + + + + + + + + + + + + + + + +
unsigned int sf::Image::GetHeight bool sf::Image::LoadFromPixels (  )  constunsigned int  Width,
unsigned int  Height,
const Uint8 *  Data 
)

-Return the height of the image. +Load the image directly from an array of pixels.

-

Returns:
Height in pixels
+
Parameters:
+ + + + +
Width : Image width
Height : Image height
Data : Pointer to the pixels in memory (assumed format is RGBA)
+
+
Returns:
True if loading was successful
+ +

Definition at line 174 of file Image.cpp.

- +

- + - + + - +
bool sf::Image::IsSmooth Image & sf::Image::operator= ( const Image &  Other  )  const

-Tells whether the smooth filtering is enabled or not. +Assignment operator.

-

Returns:
True if image smoothing is enabled
+
Parameters:
+ + +
Other : instance to assign
+
+
Returns:
Reference to the image
+ +

Definition at line 595 of file Image.cpp.

- +

- + - - - - - - - - - - - - - + + + +
FloatRect sf::Image::GetTexCoords bool sf::Image::SaveToFile (const IntRect &  Rect,
bool  Adjust = true 
) constconst std::string &  Filename  )  const

-Convert a subrect expressed in pixels, into float texture coordinates. +Save the content of the image to a file.

Parameters:
- - +
Rect : Sub-rectangle of image to convert
Adjust : Pass true to apply the half-texel adjustment
Filename : Path of the file to save (overwritten if already exist)
-
Returns:
Texture coordinates corresponding to the sub-rectangle
+
Returns:
True if saving was successful
+ +

Definition at line 209 of file Image.cpp.

- +

- + - - - + + + + + + + + + + + + + + + + + +
static unsigned int sf::Image::GetValidTextureSize void sf::Image::SetPixel ( unsigned int  Size  )  [static] X,
unsigned int  Y,
const Color &  Col 
)

-Get a valid texture size according to hardware support. +Change the color of a pixel.

Parameters:
- + + +
Size : Size to convert
X : X coordinate of pixel in the image
Y : Y coordinate of pixel in the image
Col : New color for pixel (X, Y)
-
Returns:
Valid nearest size (greater than or equal to specified size)
+ +

Definition at line 408 of file Image.cpp.

- +

- + - - + + - +
Image& sf::Image::operator= void sf::Image::SetSmooth (const Image &  Other bool  Smooth  ) 

-Assignment operator. +Enable or disable image smooth filter.

+Enable or disable image smoothing filter.

+This parameter is enabled by default

Parameters:
- +
Other : instance to assign
Smooth : True to enable smoothing filter, false to disable it
-
Returns:
Reference to the image
+ +

Definition at line 490 of file Image.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Input Member List

This is the complete list of members for sf::Input, including all inherited members.

- - - + + + -
GetJoystickAxis(unsigned int JoyId, Joy::Axis Axis) constsf::Input
GetMouseX() constsf::Input
GetMouseY() constsf::Input
GetJoystickAxis(unsigned int JoyId, Joy::Axis Axis) const sf::Input
GetMouseX() const sf::Input
GetMouseY() const sf::Input
Input()sf::Input
IsJoystickButtonDown(unsigned int JoyId, unsigned int Button) const sf::Input
IsKeyDown(Key::Code KeyCode) const sf::Input
IsMouseButtonDown(Mouse::Button Button) const sf::Input
NonCopyable()sf::NonCopyable [inline, private]
~WindowListener()sf::WindowListener [inline, protected, virtual]
+

+ - -
- + + -
- -
-
-sf::Input
+

sf::Input Class Reference

Input handles real-time input from keyboard and mouse. More...

#include <Input.hpp>

-

Inheritance diagram for sf::Input: +

+Inheritance diagram for sf::Input:
+
+

sf::WindowListener sf::NonCopyable +
+ +

List of all members. @@ -49,30 +58,28 @@ - + - + - - + + - - + + - +

Public Member Functions

bool IsKeyDown (Key::Code KeyCode) const
 Get the state of a key.
bool IsMouseButtonDown (Mouse::Button Button) const
bool IsMouseButtonDown (Mouse::Button Button) const
 Get the state of a mouse button.
bool IsJoystickButtonDown (unsigned int JoyId, unsigned int Button) const
 Get the state of a joystick button.
int GetMouseX () const
int GetMouseX () const
 Get the mouse X position.
int GetMouseY () const
 Get the mouse X position.
int GetMouseY () const
 Get the mouse Y position.
float GetJoystickAxis (unsigned int JoyId, Joy::Axis Axis) const
 Get the mouse Y position.
float GetJoystickAxis (unsigned int JoyId, Joy::Axis Axis) const
 Get a joystick axis position.
 Get a joystick axis position.

Detailed Description

Input handles real-time input from keyboard and mouse.

Use it instead of events to handle continuous moves and more game-friendly inputs -

- -

-Definition at line 44 of file Input.hpp.

Constructor & Destructor Documentation

+

Definition at line 44 of file Input.hpp.

+

Constructor & Destructor Documentation

@@ -82,7 +89,7 @@ Definition at line 44 of f (  )  - +
@@ -92,62 +99,98 @@ Definition at line 44 of f Default constructor.

+

Definition at line 36 of file Input.cpp.

+

Member Function Documentation

- +
- + - - - - + + + + + + + + + + + + +
bool sf::Input::IsKeyDown float sf::Input::GetJoystickAxis (Key::Code  KeyCode  )  constunsigned int  JoyId,
Joy::Axis  Axis 
) const

-Get the state of a key. +Get a joystick axis position.

Parameters:
- + +
KeyCode : Key to check
JoyId : Identifier of the joystick to check (0 or 1)
Axis : Axis to get
-
Returns:
True if key is down, false if key is up
+
Returns:
Current axis position, in the range [-100, 100] (except for POV, which is [0, 360])
+ +

Definition at line 111 of file Input.cpp.

- +

- + - - + - +
bool sf::Input::IsMouseButtonDown int sf::Input::GetMouseX (Mouse::Button  Button  )  const const

-Get the state of a mouse button. +Get the mouse X position.

-

Parameters:
- - -
Button : Button to check
-
-
Returns:
True if button is down, false if button is up
+Get the mouse left position.

+

Returns:
Current mouse left position, relative to owner window
+ +

Definition at line 93 of file Input.cpp.

+ +
+

+ +

+
+ + + + + + + + +
int sf::Input::GetMouseY (  )  const
+
+
+ +

+Get the mouse Y position. +

+Get the mouse top position.

+

Returns:
Current mouse top position, relative to owner window
+ +

Definition at line 102 of file Input.cpp.

@@ -170,7 +213,7 @@ Get the state of a mouse button. ) - const + const

@@ -187,92 +230,73 @@ Get the state of a joystick button.
Returns:
True if button is down, false if button is up
-
-

- -

-
- - - - - - - - -
int sf::Input::GetMouseX (  )  const
-
-
- -

-Get the mouse X position. -

-

Returns:
Current mouse left position, relative to owner window
+

Definition at line 81 of file Input.cpp.

- +

- + - + + - +
int sf::Input::GetMouseY bool sf::Input::IsKeyDown ( Key::Code  KeyCode  )  const const

-Get the mouse Y position. +Get the state of a key.

-

Returns:
Current mouse top position, relative to owner window
+
Parameters:
+ + +
KeyCode : Key to check
+
+
Returns:
True if key is down, false if key is up
+ +

Definition at line 63 of file Input.cpp.

- +

- + - - - - - - - - - - - - - + + + +
float sf::Input::GetJoystickAxis bool sf::Input::IsMouseButtonDown (unsigned int  JoyId,
Joy::Axis  Axis 
) constMouse::Button  Button  )  const

-Get a joystick axis position. +Get the state of a mouse button.

Parameters:
- - +
JoyId : Identifier of the joystick to check (0 or 1)
Axis : Axis to get
Button : Button to check
-
Returns:
Current axis position, in the range [-100, 100] (except for POV, which is [0, 360])
+
Returns:
True if button is down, false if button is up
+ +

Definition at line 72 of file Input.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Listener Member List

This is the complete list of members for sf::Listener, including all inherited members.

- - - - - - - - -
GetGlobalVolume()sf::Listener [static]
GetPosition()sf::Listener [static]
GetTarget()sf::Listener [static]
SetGlobalVolume(float Volume)sf::Listener [static]
SetPosition(float X, float Y, float Z)sf::Listener [static]
SetPosition(const Vector3f &Position)sf::Listener [static]
SetTarget(float X, float Y, float Z)sf::Listener [static]
SetTarget(const Vector3f &Target)sf::Listener [static]
+ GetGlobalVolume()sf::Listener [static] + GetPosition()sf::Listener [static] + GetTarget()sf::Listener [static] + SetGlobalVolume(float Volume)sf::Listener [static] + SetPosition(float X, float Y, float Z)sf::Listener [static] + SetPosition(const Vector3f &Position)sf::Listener [static] + SetTarget(float X, float Y, float Z)sf::Listener [static] + SetTarget(const Vector3f &Target)sf::Listener [static] +

+ - -
- + + -
- -
-
-sf::Listener
+

sf::Listener Class Reference

Listener is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard. More...

#include <Listener.hpp> +

+

List of all members. - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - +

Static Public Member Functions

static void SetGlobalVolume (float Volume)
static void SetGlobalVolume (float Volume)
 Change the global volume of all the sounds.
static float GetGlobalVolume ()
 Change the global volume of all the sounds.
static float GetGlobalVolume ()
 Get the current value of the global volume of all the sounds.
static void SetPosition (float X, float Y, float Z)
 Get the current value of the global volume of all the sounds.
static void SetPosition (float X, float Y, float Z)
 Change the position of the listener (take 3 values).
static void SetPosition (const Vector3f &Position)
 Change the position of the listener (take 3 values).
static void SetPosition (const Vector3f &Position)
 Change the position of the listener (take a 3D vector).
static Vector3f GetPosition ()
 Change the position of the listener (take a 3D vector).
static Vector3f GetPosition ()
 Get the current position of the listener.
static void SetTarget (float X, float Y, float Z)
 Get the current position of the listener.
static void SetTarget (float X, float Y, float Z)
 Change the orientation of the listener (the point he must look at) (take 3 values).
static void SetTarget (const Vector3f &Target)
 Change the orientation of the listener (the point he must look at) (take 3 values).
static void SetTarget (const Vector3f &Target)
 Change the orientation of the listener (the point he must look at) (take a 3D vector).
static Vector3f GetTarget ()
 Change the orientation of the listener (the point he must look at) (take a 3D vector).
static Vector3f GetTarget ()
 Get the current orientation of the listener (the point he's looking at).
 Get the current orientation of the listener (the point he's looking at).

Detailed Description

Listener is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard. -

- -

-Definition at line 42 of file Listener.hpp.

Member Function Documentation

- +

Definition at line 42 of file Listener.hpp.

+

Member Function Documentation

+
- + - - + - +
static void sf::Listener::SetGlobalVolume float sf::Listener::GetGlobalVolume (float  Volume  )  [static] [static]

-Change the global volume of all the sounds. +Get the current value of the global volume of all the sounds.

-The default volume is 100

-

Parameters:
- - -
Volume : New global volume, in the range [0, 100]
-
+
Returns:
Current global volume, in the range [0, 100]
+ +

Definition at line 46 of file Listener.cpp.

- +

- + - +
static float sf::Listener::GetGlobalVolume Vector3f sf::Listener::GetPosition (  )  [static] [static]

-Get the current value of the global volume of all the sounds. +Get the current position of the listener.

-

Returns:
Current global volume, in the range [0, 100]
+
Returns:
Position of the listener in the world
+ +

Definition at line 76 of file Listener.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - + + +
static void sf::Listener::SetPosition Vector3f sf::Listener::GetTarget (float  X,
float  Y,
float  Z 
) [static]  )  [static]

-Change the position of the listener (take 3 values). +Get the current orientation of the listener (the point he's looking at).

-The default position is (0, 0, 0)

-

Parameters:
- - -
X,Y,Z : Position of the listener in the world
-
+Get the current orientation of the listener (the point he's looking at).

+

Returns:
: Position of the point the listener is looking at
+ +

Definition at line 110 of file Listener.cpp.

- +

- + - - + + - +
static void sf::Listener::SetPosition void sf::Listener::SetGlobalVolume (const Vector3f &  Position float  Volume  )  [static] [static]

-Change the position of the listener (take a 3D vector). +Change the global volume of all the sounds.

-The default position is (0, 0, 0)

+The default volume is 100

Parameters:
- +
Position : Position of the listener in the world
Volume : New global volume, in the range [0, 100]
+

Definition at line 37 of file Listener.cpp.

+

- +

- + - + + - +
static Vector3f sf::Listener::GetPosition void sf::Listener::SetPosition ( const Vector3f &  Position  )  [static] [static]

-Get the current position of the listener. +Change the position of the listener (take a 3D vector).

-

Returns:
Position of the listener in the world
+The default position is (0, 0, 0)

+

Parameters:
+ + +
Position : Position of the listener in the world
+
+ +

Definition at line 67 of file Listener.cpp.

- +

- + @@ -236,35 +229,37 @@ Get the current position of the listener. - +
static void sf::Listener::SetTarget void sf::Listener::SetPosition ( float  X,
) [static] [static]

-Change the orientation of the listener (the point he must look at) (take 3 values). +Change the position of the listener (take 3 values).

-The default target is (0, 0, -1)

+The default position is (0, 0, 0)

Parameters:
- +
X,Y,Z : Position of the point the listener must look at
X,Y,Z : Position of the listener in the world
+

Definition at line 58 of file Listener.cpp.

+

- +

- + - +
static void sf::Listener::SetTarget void sf::Listener::SetTarget ( const Vector3f &  Target  )  [static] [static]
@@ -273,6 +268,7 @@ The default target is (0, 0, -1)

Change the orientation of the listener (the point he must look at) (take a 3D vector).

+Change the orientation of the listener (the point he must look at) (take a 3D vector).

The default target is (0, 0, -1)

Parameters:
@@ -280,32 +276,59 @@ The default target is (0, 0, -1)

+

Definition at line 100 of file Listener.cpp.

+

- +

- + - - - + + + + + + + + + + + + + + + + + + +
static Vector3f sf::Listener::GetTarget void sf::Listener::SetTarget (  )  [static]float  X,
float  Y,
float  Z 
) [static]

-Get the current orientation of the listener (the point he's looking at). +Change the orientation of the listener (the point he must look at) (take 3 values).

-

Returns:
: Position of the point the listener is looking at
+Change the orientation of the listener (the point he must look at) (take 3 values).

+The default target is (0, 0, -1)

+

Parameters:
+ + +
X,Y,Z : Position of the point the listener must look at
+
+ +

Definition at line 89 of file Listener.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: +
- -
- -
-
- + + +

sf::Lock Member List

This is the complete list of members for sf::Lock, including all inherited members.

-
Lock(Mutex &Mutex)sf::Lock
NonCopyable()sf::NonCopyable [inline, private]
~Lock()sf::Lock
+

+ - -
- + + -
- -
-
-sf::Lock
+

sf::Lock Class Reference

Lock is an exception-safe automatic wrapper for locking and unlocking mutexes. More...

#include <Lock.hpp>

-

Inheritance diagram for sf::Lock: +

+Inheritance diagram for sf::Lock:
+
+

sf::NonCopyable +
+ +

List of all members. @@ -51,10 +60,8 @@

Public Member Functions

Detailed Description

Lock is an exception-safe automatic wrapper for locking and unlocking mutexes. -

- -

-Definition at line 42 of file Lock.hpp.

Constructor & Destructor Documentation

+

Definition at line 42 of file Lock.hpp.

+

Constructor & Destructor Documentation

@@ -65,7 +72,7 @@ Definition at line 42 of fi Mutex &  Mutex  )  - +
@@ -80,6 +87,8 @@ Construct the lock with a target mutex (lock it). +

Definition at line 37 of file Lock.cpp.

+

@@ -91,7 +100,7 @@ Construct the lock with a target mutex (lock it). (  )  - +

@@ -101,10 +110,13 @@ Construct the lock with a target mutex (lock it). Destructor (unlocks the mutex).

+

Definition at line 47 of file Lock.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Matrix3 Member List

This is the complete list of members for sf::Matrix3, including all inherited members.

- - + + - - - + + + -
Get4x4Elements() constsf::Matrix3
GetInverse() constsf::Matrix3
Get4x4Elements() const sf::Matrix3
GetInverse() const sf::Matrix3
Identitysf::Matrix3 [static]
Matrix3()sf::Matrix3
Matrix3(float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22)sf::Matrix3
operator *(const Matrix3 &Mat) const sf::Matrix3
operator *=(const Matrix3 &Mat)sf::Matrix3
operator()(unsigned int Row, unsigned int Col) constsf::Matrix3
operator()(unsigned int Row, unsigned int Col) const sf::Matrix3
operator()(unsigned int Row, unsigned int Col) (defined in sf::Matrix3)sf::Matrix3
operator*(const Matrix3 &Mat) const sf::Matrix3
operator*=(const Matrix3 &Mat)sf::Matrix3
SetFromTransformations(const Vector2f &Center, const Vector2f &Translation, float Rotation, const Vector2f &Scale)sf::Matrix3
Transform(const Vector2f &Point) const sf::Matrix3
+

+ - -
- + + -
- -
-
-sf::Matrix3
+

sf::Matrix3 Class Reference

Utility class to manipulate 3x3 matrices representing 2D transformations. More...

#include <Matrix3.hpp> +

+

List of all members. @@ -49,24 +54,24 @@ - + - - + + - - + + - + - + - - + + - + @@ -74,10 +79,8 @@ float & 
Vector2f Transform (const Vector2f &Point) const
 Transform a point by the matrix.
Matrix3 GetInverse () const
Matrix3 GetInverse () const
 Return the inverse of the matrix.
const float * Get4x4Elements () const
 Return the inverse of the matrix.
const float * Get4x4Elements () const
 Return the elements of the matrix as a 4x4, in an array of 16 floats.
float operator() (unsigned int Row, unsigned int Col) const
 Return the elements of the matrix as a 4x4, in an array of 16 floats.
float operator() (unsigned int Row, unsigned int Col) const
 Operator () overloads to access the matrix elements.
 Operator () overloads to access the matrix elements.
float & operator() (unsigned int Row, unsigned int Col)
Matrix3 operator * (const Matrix3 &Mat) const
Matrix3 operator* (const Matrix3 &Mat) const
 Operator * overload to multiply two matrices.
Matrix3 & operator *= (const Matrix3 &Mat)
 Operator * overload to multiply two matrices.
Matrix3 & operator*= (const Matrix3 &Mat)
 Operator *= overload to multiply-assign two matrices.
 Operator *= overload to multiply-assign two matrices.

Static Public Attributes

static const Matrix3 Identity
operator()

Detailed Description

Utility class to manipulate 3x3 matrices representing 2D transformations. -

- -

-Definition at line 42 of file Matrix3.hpp.

Constructor & Destructor Documentation

+

Definition at line 42 of file Matrix3.hpp.

+

Constructor & Destructor Documentation

@@ -87,7 +90,7 @@ Definition at line 42 of (  )  - +
@@ -160,7 +163,7 @@ Default constructor (builds an identity matrix). ) - +
@@ -173,86 +176,29 @@ Construct a matrix from its 9 elements.

Member Function Documentation

- +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void sf::Matrix3::SetFromTransformations (const Vector2f &  Center,
const Vector2f &  Translation,
float  Rotation,
const Vector2f &  Scale 
)
-
-
- -

-Build a matrix from a set of transformations. -

-

Parameters:
- - - - - -
Center : Origin for the transformations
Translation : Translation offset
Rotation : Rotation angle in degrees
Scale : Scaling factors
-
- -
-

- -

-
- - - + - - + - +
Vector2f sf::Matrix3::Transform const float* sf::Matrix3::Get4x4Elements (const Vector2f &  Point  )  const const

-Transform a point by the matrix. +Return the elements of the matrix as a 4x4, in an array of 16 floats.

-

Parameters:
- - -
Point : Point to transform
-
-
Returns:
Transformed point
+
Returns:
Pointer to the 4x4 matrix elements

- +

@@ -261,7 +207,7 @@ Transform a point by the matrix. - +
(  )  const const
@@ -274,29 +220,7 @@ Return the inverse of the matrix.

- -

-
- - - - - - - - -
const float* sf::Matrix3::Get4x4Elements (  )  const
-
-
- -

-Return the elements of the matrix as a 4x4, in an array of 16 floats. -

-

Returns:
Pointer to the 4x4 matrix elements
- -
-

- +

@@ -315,7 +239,7 @@ Return the elements of the matrix as a 4x4, in an array of 16 floats. - +
) const const
@@ -334,17 +258,17 @@ Operator () overloads to access the matrix elements.

- +

- + - +
Matrix3 sf::Matrix3::operator * Matrix3 sf::Matrix3::operator* ( const Matrix3 &  Mat  )  const const
@@ -362,17 +286,17 @@ Operator * overload to multiply two matrices.

- +

- + - +
Matrix3& sf::Matrix3::operator *= Matrix3& sf::Matrix3::operator*= ( const Matrix3 &  Mat  ) 
@@ -388,6 +312,85 @@ Operator *= overload to multiply-assign two matrices.
Returns:
this * Mat
+
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void sf::Matrix3::SetFromTransformations (const Vector2f &  Center,
const Vector2f &  Translation,
float  Rotation,
const Vector2f &  Scale 
)
+
+
+ +

+Build a matrix from a set of transformations. +

+

Parameters:
+ + + + + +
Center : Origin for the transformations
Translation : Translation offset
Rotation : Rotation angle in degrees
Scale : Scaling factors
+
+ +
+

+ +

+
+ + + + + + + + + +
Vector2f sf::Matrix3::Transform (const Vector2f &  Point  )  const
+
+
+ +

+Transform a point by the matrix. +

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+

Member Data Documentation

@@ -406,12 +409,13 @@ Operator *= overload to multiply-assign two matrices. Identity matrix.

-

-Definition at line 133 of file Matrix3.hpp. +

Definition at line 133 of file Matrix3.hpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Music Member List

This is the complete list of members for sf::Music, including all inherited members.

- - - - - - + + + + + + @@ -41,10 +44,12 @@ + - -
GetChannelsCount() constsf::SoundStream
GetDuration() constsf::Music
GetLoop() constsf::SoundStream
GetPlayingOffset() constsf::SoundStream
GetSampleRate() constsf::SoundStream
GetStatus() constsf::SoundStream
GetChannelsCount() const sf::SoundStream
GetDuration() const sf::Music
GetLoop() const sf::SoundStream
GetPlayingOffset() const sf::SoundStream
GetSampleRate() const sf::SoundStream
GetStatus() const sf::SoundStream
Initialize(unsigned int ChannelsCount, unsigned int SampleRate)sf::SoundStream [protected]
Music(std::size_t BufferSize=44100)sf::Music
OpenFromFile(const std::string &Filename)sf::Music
Play()sf::SoundStream
SetLoop(bool Loop)sf::SoundStream
SoundStream()sf::SoundStream [protected]
Status enum namesf::SoundStream
Stop()sf::SoundStream
~Music()sf::Music
~SoundStream()sf::SoundStream [virtual]
+ ~SoundStream()sf::SoundStream [virtual] +

+ - -
- -
-
- -
-
-sf::Music
+ + +

sf::Music Class Reference

Music defines a big sound played using streaming, so usually what we call a music :). More...

#include <Music.hpp>

-

Inheritance diagram for sf::Music: +

+Inheritance diagram for sf::Music:
+
+

sf::SoundStream sf::Thread sf::Sound +
+ +

List of all members. + + + + @@ -56,33 +69,33 @@ - + - + - + - - + + - - + + - - + + - + - + - + @@ -90,10 +103,28 @@

Public Types

enum  Status
 Enumeration of the sound states. More...

Public Member Functions

 Music (std::size_t BufferSize=44100)
bool OpenFromMemory (const char *Data, std::size_t SizeInBytes)
 Open a music file from memory (doesn't play it -- call Play() for that).
float GetDuration () const
float GetDuration () const
 Get the music duration.
 Get the music duration.
void Play ()
 Start playing the audio stream.
void Stop ()
 Stop playing the audio stream.
unsigned int GetChannelsCount () const
unsigned int GetChannelsCount () const
 Return the number of channels (1 = mono, 2 = stereo).
unsigned int GetSampleRate () const
 Return the number of channels (1 = mono, 2 = stereo).
unsigned int GetSampleRate () const
 Get the stream sample rate.
Status GetStatus () const
 Get the stream sample rate.
Status GetStatus () const
 Get the status of the stream (stopped, paused, playing).
float GetPlayingOffset () const
 Get the status of the stream (stopped, paused, playing).
float GetPlayingOffset () const
 Get the current playing position of the stream.
 Get the current playing position of the stream.
void SetLoop (bool Loop)
 Set the stream loop state.
bool GetLoop () const
bool GetLoop () const
 Tell whether or not the stream is looping.
 Tell whether or not the stream is looping.

Protected Member Functions

void Initialize (unsigned int ChannelsCount, unsigned int SampleRate)

Detailed Description

Music defines a big sound played using streaming, so usually what we call a music :). -

+

Definition at line 47 of file Music.hpp.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum sf::Sound::Status [inherited]
+
+

-Definition at line 47 of file Music.hpp.

Constructor & Destructor Documentation

+Enumeration of the sound states. +

+ +

Definition at line 52 of file Sound.hpp.

+ +
+

+

Constructor & Destructor Documentation

@@ -104,7 +135,7 @@ Definition at line 47 of f std::size_t  BufferSize = 44100  )  - +
@@ -119,6 +150,8 @@ Construct the music with a buffer size. +

Definition at line 40 of file Music.cpp.

+

@@ -130,7 +163,7 @@ Construct the music with a buffer size. (  )  - +

@@ -140,233 +173,299 @@ Construct the music with a buffer size. Destructor.

+

Definition at line 52 of file Music.cpp.

+

Member Function Documentation

- +
- + - - + - +
bool sf::Music::OpenFromFile unsigned int sf::SoundStream::GetChannelsCount (const std::string &  Filename  )  const [inherited]

-Open a music file (doesn't play it -- call Play() for that). +Return the number of channels (1 = mono, 2 = stereo).

-

Parameters:
- - -
Filename : Path of the music file to open
-
-
Returns:
True if loading has been successful
+Return the number of channels (1 = mono, 2 = stereo, .

+

Returns:
Number of channels
+..) +

Definition at line 126 of file SoundStream.cpp.

- +

- + - - - - - - - - - - - - - + + +
bool sf::Music::OpenFromMemory float sf::Music::GetDuration (const char *  Data,
std::size_t  SizeInBytes 
)  )  const

-Open a music file from memory (doesn't play it -- call Play() for that). +Get the music duration.

-

Parameters:
- - - -
Data : Pointer to the file data in memory
SizeInBytes : Size of the data to load, in bytes
-
-
Returns:
True if loading has been successful
+Get the sound duration.

+

Returns:
Music duration, in seconds
+ +

Definition at line 148 of file Music.cpp.

- +

- + - +
float sf::Music::GetDuration bool sf::SoundStream::GetLoop (  )  const const [inherited]

-Get the music duration. +Tell whether or not the stream is looping.

-

Returns:
Music duration, in seconds
+Tell whether or not the music is looping.

+

Returns:
True if the music is looping, false otherwise
+ +

Reimplemented from sf::Sound.

+ +

Definition at line 180 of file SoundStream.cpp.

- +

- + - +
void sf::SoundStream::Play float sf::SoundStream::GetPlayingOffset (  )  [inherited] const [inherited]

-Start playing the audio stream. +Get the current playing position of the stream.

+

Returns:
Current playing position, expressed in seconds

+Current playing position, expressed in seconds

+ +

Reimplemented from sf::Sound.

+ +

Definition at line 162 of file SoundStream.cpp.

-

-Reimplemented from sf::Sound.

- +

- + - +
void sf::SoundStream::Stop unsigned int sf::SoundStream::GetSampleRate (  )  [inherited] const [inherited]

-Stop playing the audio stream. +Get the stream sample rate.

+Get the sound frequency (sample rate).

+

Returns:
Stream frequency (number of samples per second)
+ +

Definition at line 135 of file SoundStream.cpp.

-

-Reimplemented from sf::Sound.

- +

- + - +
unsigned int sf::SoundStream::GetChannelsCount Sound::Status sf::SoundStream::GetStatus (  )  const [inherited] const [inherited]

-Return the number of channels (1 = mono, 2 = stereo). +Get the status of the stream (stopped, paused, playing).

-

Returns:
Number of channels
+Get the status of the sound (stopped, paused, playing).

+

Returns:
Current status of the sound
+ +

Reimplemented from sf::Sound.

+ +

Definition at line 144 of file SoundStream.cpp.

- +

- + - - - + + + + + + + + + + + + +
unsigned int sf::SoundStream::GetSampleRate void sf::SoundStream::Initialize (  )  const [inherited]unsigned int  ChannelsCount,
unsigned int  SampleRate 
) [protected, inherited]

-Get the stream sample rate. +Set the audio stream parameters, you must call it before Play().

-

Returns:
Stream frequency (number of samples per second)
+
Parameters:
+ + + +
ChannelsCount : Number of channels
SampleRate : Sample rate
+
+ +

Definition at line 64 of file SoundStream.cpp.

- +

- + - + + - +
Status sf::SoundStream::GetStatus bool sf::Music::OpenFromFile ( const std::string &  Filename  )  const [inherited]

-Get the status of the stream (stopped, paused, playing). +Open a music file (doesn't play it -- call Play() for that).

-

Returns:
Current status of the sound
+
Parameters:
+ + +
Filename : Path of the music file to open
+
+
Returns:
True if loading has been successful
+ +

Definition at line 64 of file Music.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
bool sf::Music::OpenFromMemory (const char *  Data,
std::size_t  SizeInBytes 
)
+
+

-Reimplemented from sf::Sound. +Open a music file from memory (doesn't play it -- call Play() for that). +

+

Parameters:
+ + + +
Data : Pointer to the file data in memory
SizeInBytes : Size of the data to load, in bytes
+
+
Returns:
True if loading has been successful
+ +

Definition at line 91 of file Music.cpp.

+

- +

- + - +
float sf::SoundStream::GetPlayingOffset void sf::SoundStream::Play (  )  const [inherited] [inherited]

-Get the current playing position of the stream. +Start playing the audio stream.

-

Returns:
Current playing position, expressed in seconds
-

-Reimplemented from sf::Sound. +

Reimplemented from sf::Sound.

+ +

Definition at line 85 of file SoundStream.cpp.

+

@@ -379,7 +478,7 @@ Reimplemented from bool  Loop  )  - [inherited] + [inherited] @@ -388,6 +487,7 @@ Reimplemented from @@ -395,73 +495,40 @@ This parameter is disabled by default

-

-Reimplemented from sf::Sound. +

Reimplemented from sf::Sound.

+ +

Definition at line 171 of file SoundStream.cpp.

+

- +

- + - +
bool sf::SoundStream::GetLoop void sf::SoundStream::Stop (  )  const [inherited] [inherited]

-Tell whether or not the stream is looping. +Stop playing the audio stream.

-

Returns:
True if the music is looping, false otherwise
-

-Reimplemented from sf::Sound. -

-

- -

-
- - - - - - - - - - - - - - - - - - -
void sf::SoundStream::Initialize (unsigned int  ChannelsCount,
unsigned int  SampleRate 
) [protected, inherited]
-
-
+

Reimplemented from sf::Sound.

-

-Set the audio stream parameters, you must call it before Play(). -

-

Parameters:
- - - -
ChannelsCount : Number of channels
SampleRate : Sample rate
-
+

Definition at line 115 of file SoundStream.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Mutex Member List

This is the complete list of members for sf::Mutex, including all inherited members.

-
Lock()sf::Mutex
Mutex()sf::Mutex
NonCopyable()sf::NonCopyable [inline, private]
Unlock()sf::Mutex
~Mutex()sf::Mutex
+

+ - -
- + + -
- -
-
-sf::Mutex
+

sf::Mutex Class Reference

Mutex defines a mutex (MUTual EXclusion) object, that allows a thread to lock critical instructions to avoid simultaneous access with other threads. More...

#include <Mutex.hpp>

-

Inheritance diagram for sf::Mutex: +

+Inheritance diagram for sf::Mutex:
+
+

sf::NonCopyable +
+ +

List of all members. @@ -60,10 +69,8 @@

The Win32 version uses critical sections, as it is faster than mutexes.
See Lock for an efficient way of using it. -

- -

-Definition at line 45 of file Win32/Mutex.hpp.

Constructor & Destructor Documentation

+

Definition at line 45 of file Win32/Mutex.hpp.

+

Constructor & Destructor Documentation

@@ -73,7 +80,7 @@ Definition at line 45(
- +

Public Member Functions

 ) 

@@ -83,6 +90,8 @@ Definition at line 45 +

Definition at line 36 of file Mutex.cpp.

+

@@ -94,7 +103,7 @@ Default constructor. (  )  - + @@ -104,6 +113,8 @@ Default constructor. Destructor.

+

Definition at line 45 of file Mutex.cpp.

+

Member Function Documentation

@@ -116,7 +127,7 @@ Destructor. (  )  - + @@ -126,6 +137,8 @@ Destructor. Lock the mutex.

+

Definition at line 54 of file Mutex.cpp.

+

@@ -137,7 +150,7 @@ Destructor. (  )  - + @@ -147,10 +160,13 @@ Destructor. Unlock the mutex.

+

Definition at line 63 of file Mutex.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Packet Member List

This is the complete list of members for sf::Packet, including all inherited members.

- - - - - + + + + + @@ -47,7 +50,7 @@ - + @@ -61,10 +64,11 @@ - - - -
Append(const void *Data, std::size_t SizeInBytes)sf::Packet
Clear()sf::Packet
EndOfPacket() constsf::Packet
GetData() constsf::Packet
GetDataSize() constsf::Packet
operator bool() constsf::Packet
operator<<(bool Data)sf::Packet
EndOfPacket() const sf::Packet
GetData() const sf::Packet
GetDataSize() const sf::Packet
operator bool() const sf::Packet
operator<<(bool Data)sf::Packet
operator<<(Int8 Data) (defined in sf::Packet)sf::Packet
operator<<(Uint8 Data) (defined in sf::Packet)sf::Packet
operator<<(Int16 Data) (defined in sf::Packet)sf::Packet
operator<<(const std::string &Data) (defined in sf::Packet)sf::Packet
operator<<(const wchar_t *Data) (defined in sf::Packet)sf::Packet
operator<<(const std::wstring &Data) (defined in sf::Packet)sf::Packet
operator>>(bool &Data)sf::Packet
operator>>(bool &Data)sf::Packet
operator>>(Int8 &Data) (defined in sf::Packet)sf::Packet
operator>>(Uint8 &Data) (defined in sf::Packet)sf::Packet
operator>>(Int16 &Data) (defined in sf::Packet)sf::Packet
operator>>(wchar_t *Data) (defined in sf::Packet)sf::Packet
operator>>(std::wstring &Data) (defined in sf::Packet)sf::Packet
Packet()sf::Packet
SocketTCP classsf::Packet [friend]
SocketUDP classsf::Packet [friend]
~Packet()sf::Packet [virtual]
+ SocketTCP (defined in sf::Packet)sf::Packet [friend] + SocketUDP (defined in sf::Packet)sf::Packet [friend] + ~Packet()sf::Packet [virtual] +

+ - -
- + + -
- -
-
-sf::Packet
+

sf::Packet Class Reference

Packet wraps data to send / to receive through the network. More...

#include <Packet.hpp> +

+

List of all members. @@ -40,119 +45,117 @@ - + - + - + - - + + - - + + - - + + - - + + - - + - - - - - - - - - - - - + - - + - - - - - - - - - - - +class  +class 
 Packet ()
 Default constructor.
virtual ~Packet ()
virtual ~Packet ()
 Virtual destructor.
 Virtual destructor.
void Append (const void *Data, std::size_t SizeInBytes)
 Append data to the end of the packet.
void Clear ()
 Clear the packet data.
const char * GetData () const
const char * GetData () const
 Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.
std::size_t GetDataSize () const
 Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.
std::size_t GetDataSize () const
 Get the size of the data contained in the packet.
bool EndOfPacket () const
 Get the size of the data contained in the packet.
bool EndOfPacket () const
 Tell if the reading position has reached the end of the packet.
 operator bool () const
 Tell if the reading position has reached the end of the packet.
 operator bool () const
 Return the validity of packet.
Packet & operator>> (bool &Data)
 Return the validity of packet.
Packet & operator>> (bool &Data)
 Operator >> overloads to extract data from the packet.
+
 Operator >> overloads to extract data from the packet.
Packet & operator>> (Int8 &Data)
+
Packet & operator>> (Uint8 &Data)
+
Packet & operator>> (Int16 &Data)
+
Packet & operator>> (Uint16 &Data)
+
Packet & operator>> (Int32 &Data)
+
Packet & operator>> (Uint32 &Data)
+
Packet & operator>> (float &Data)
+
Packet & operator>> (double &Data)
+
Packet & operator>> (char *Data)
+
Packet & operator>> (std::string &Data)
+
Packet & operator>> (wchar_t *Data)
+
Packet & operator>> (std::wstring &Data)
Packet & operator<< (bool Data)
Packet & operator<< (bool Data)
 Operator << overloads to put data into the packet.
+
 Operator << overloads to put data into the packet.
Packet & operator<< (Int8 Data)
+
Packet & operator<< (Uint8 Data)
+
Packet & operator<< (Int16 Data)
+
Packet & operator<< (Uint16 Data)
+
Packet & operator<< (Int32 Data)
+
Packet & operator<< (Uint32 Data)
+
Packet & operator<< (float Data)
+
Packet & operator<< (double Data)
+
Packet & operator<< (const char *Data)
+
Packet & operator<< (const std::string &Data)
+
Packet & operator<< (const wchar_t *Data)
+
Packet & operator<< (const std::wstring &Data)

Friends

-class SocketTCP
SocketTCP
-class SocketUDP
SocketUDP

Detailed Description

Packet wraps data to send / to receive through the network. -

- -

-Definition at line 41 of file Packet.hpp.

Constructor & Destructor Documentation

+

Definition at line 41 of file Packet.hpp.

+

Constructor & Destructor Documentation

@@ -162,7 +165,7 @@ Definition at line 41 of (  )  - +
@@ -172,18 +175,20 @@ Definition at line 41 of Default constructor.

+

Definition at line 38 of file Packet.cpp.

+

- +

- + - +
virtual sf::Packet::~Packet sf::Packet::~Packet (  )  [virtual] [virtual]
@@ -193,6 +198,8 @@ Default constructor. Virtual destructor.

+

Definition at line 49 of file Packet.cpp.

+

Member Function Documentation

@@ -215,7 +222,7 @@ Virtual destructor. ) - +
@@ -231,6 +238,8 @@ Append data to the end of the packet. +

Definition at line 58 of file Packet.cpp.

+

@@ -242,7 +251,7 @@ Append data to the end of the packet. (  )  - + @@ -252,75 +261,84 @@ Append data to the end of the packet. Clear the packet data.

+

Definition at line 72 of file Packet.cpp.

+

- +

- + - +
const char* sf::Packet::GetData bool sf::Packet::EndOfPacket (  )  const const

-Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet. +Tell if the reading position has reached the end of the packet.

-

Returns:
Pointer to the data
+
Returns:
True if all data have been read into the packet
+ +

Definition at line 103 of file Packet.cpp.

- +

- + - +
std::size_t sf::Packet::GetDataSize const char * sf::Packet::GetData (  )  const const

-Get the size of the data contained in the packet. +Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.

-

Returns:
Data size, in bytes
+Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.

+

Returns:
Pointer to the data
+ +

Definition at line 85 of file Packet.cpp.

- +

- + - +
bool sf::Packet::EndOfPacket std::size_t sf::Packet::GetDataSize (  )  const const

-Tell if the reading position has reached the end of the packet. +Get the size of the data contained in the packet.

-

Returns:
True if all data have been read into the packet
+
Returns:
Data size, in bytes
+ +

Definition at line 94 of file Packet.cpp.

- +

@@ -329,7 +347,7 @@ Tell if the reading position has reached the end of the packet. - +
(  )  const const
@@ -338,56 +356,64 @@ Tell if the reading position has reached the end of the packet.

Return the validity of packet.

+Tell if the packet is valid for reading.

Returns:
True if last data extraction from packet was successful
+

Definition at line 112 of file Packet.cpp.

+

- +

- + - + - +
Packet& sf::Packet::operator>> Packet & sf::Packet::operator<< (bool & bool  Data  ) 

-Operator >> overloads to extract data from the packet. +Operator << overloads to put data into the packet.

+

Definition at line 290 of file Packet.cpp.

+

- +

- + - + - +
Packet& sf::Packet::operator<< Packet & sf::Packet::operator>> (bool bool &  Data  ) 

-Operator << overloads to put data into the packet. +Operator >> overloads to extract data from the packet.

+

Definition at line 121 of file Packet.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::PostFX Member List

This is the complete list of members for sf::PostFX, including all inherited members.

- + - - - - - - - - + + + + + + + + - + - + @@ -69,9 +72,10 @@ - + -
CanUsePostFX()sf::PostFX [static]
CanUsePostFX()sf::PostFX [static]
Drawable(const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))sf::Drawable
GetBlendMode() constsf::Drawable
GetCenter() constsf::Drawable
GetColor() constsf::Drawable
GetInverseMatrix() constsf::Drawable [protected]
GetMatrix() constsf::Drawable [protected]
GetPosition() constsf::Drawable
GetRotation() constsf::Drawable
GetScale() constsf::Drawable
GetBlendMode() const sf::Drawable
GetCenter() const sf::Drawable
GetColor() const sf::Drawable
GetInverseMatrix() const sf::Drawable [protected]
GetMatrix() const sf::Drawable [protected]
GetPosition() const sf::Drawable
GetRotation() const sf::Drawable
GetScale() const sf::Drawable
LoadFromFile(const std::string &Filename)sf::PostFX
LoadFromMemory(const std::string &Effect)sf::PostFX
Move(float OffsetX, float OffsetY)sf::Drawable
Move(const Vector2f &Offset)sf::Drawable
operator=(const PostFX &Other)sf::PostFX
operator=(const PostFX &Other)sf::PostFX
PostFX()sf::PostFX
PostFX(const PostFX &Copy)sf::PostFX
Render(RenderTarget &Target) const sf::PostFX [protected, virtual]
Render(RenderTarget &Target) const sf::PostFX [protected, virtual]
Rotate(float Angle)sf::Drawable
Scale(float FactorX, float FactorY)sf::Drawable
Scale(const Vector2f &Factor)sf::Drawable
SetY(float Y)sf::Drawable
TransformToGlobal(const sf::Vector2f &Point) const sf::Drawable
TransformToLocal(const sf::Vector2f &Point) const sf::Drawable
~Drawable()sf::Drawable [virtual]
~Drawable()sf::Drawable [virtual]
~PostFX()sf::PostFX
+

+ - -
- -
-
- -
-
-sf::PostFX
+ + +

sf::PostFX Class Reference

PostFX is used to apply a post effect to a window. More...

#include <PostFX.hpp>

-

Inheritance diagram for sf::PostFX: +

+Inheritance diagram for sf::PostFX:
+
+

sf::Drawable +
+ +

List of all members. @@ -72,9 +81,9 @@ - + - + @@ -114,24 +123,24 @@ - + - - + + - - + + - - + + - - + + - - + + - + @@ -154,26 +163,24 @@ - + - + - + - - + + - - + + - +

Public Member Functions

void SetTexture (const std::string &Name, Image *Texture)
 Set a texture parameter.
PostFX & operator= (const PostFX &Other)
PostFX & operator= (const PostFX &Other)
 Assignment operator.
 Assignment operator.
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values).
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
const Vector2f & GetPosition () const
const Vector2f & GetPosition () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values).
 Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Static Public Member Functions

static bool CanUsePostFX ()
static bool CanUsePostFX ()
 Tell whether or not the system supports post-effects.
 Tell whether or not the system supports post-effects.

Protected Member Functions

virtual void Render (RenderTarget &Target) const
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the inverse transform matrix of the drawable.
 Get the inverse transform matrix of the drawable.

Detailed Description

PostFX is used to apply a post effect to a window. -

- -

-Definition at line 43 of file PostFX.hpp.

Constructor & Destructor Documentation

+

Definition at line 43 of file PostFX.hpp.

+

Constructor & Destructor Documentation

@@ -183,7 +190,7 @@ Definition at line 43 of (  )  - +
@@ -193,6 +200,8 @@ Definition at line 43 of Default constructor.

+

Definition at line 43 of file PostFX.cpp.

+

@@ -205,7 +214,7 @@ Default constructor. const PostFX &  Copy  )  - +

@@ -220,6 +229,8 @@ Copy constructor. +

Definition at line 54 of file PostFX.cpp.

+

@@ -231,7 +242,7 @@ Copy constructor. (  )  - + @@ -241,631 +252,536 @@ Copy constructor. Destructor.

+

Definition at line 73 of file PostFX.cpp.

+

Member Function Documentation

- +
- + - - + - +
bool sf::PostFX::LoadFromFile bool sf::PostFX::CanUsePostFX (const std::string &  Filename  )  [static]

-Load the effect from a file. +Tell whether or not the system supports post-effects.

-

Parameters:
- - -
Filename : Path of the effect file to load
-
-
Returns:
True on success
+
Returns:
True if the system can use post-effects
+ +

Definition at line 265 of file PostFX.cpp.

- +

- + - - + - +
bool sf::PostFX::LoadFromMemory Blend::Mode sf::Drawable::GetBlendMode (const std::string &  Effect  )  const [inherited]

-Load the effect from a text in memory. +Get the current blending mode.

-

Parameters:
- - -
Effect : String containing the effect code
-
-
Returns:
True on success
+
Returns:
Current blending mode
+ +

Definition at line 258 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::PostFX::SetParameter const Vector2f & sf::Drawable::GetCenter (const std::string &  Name,
float  X 
)  )  const [inherited]

-Change a parameter of the effect (1 float). +Get the center of the object.

-

Parameters:
- - - -
Name : Parameter name in the effect
X : Value to assign
-
+
Returns:
Current position of the center
+ +

Definition at line 231 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - + + +
void sf::PostFX::SetParameter const Color & sf::Drawable::GetColor (const std::string &  Name,
float  X,
float  Y 
)  )  const [inherited]

-Change a parameter of the effect (2 floats). +Get the color of the object.

-

Parameters:
- - - -
Name : Parameter name in the effect
X,Y : Values to assign
-
+
Returns:
Current color
+ +

Definition at line 249 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - - - - - - - + + +
void sf::PostFX::SetParameter const Matrix3 & sf::Drawable::GetInverseMatrix (const std::string &  Name,
float  X,
float  Y,
float  Z 
)  )  const [protected, inherited]

-Change a parameter of the effect (3 floats). +Get the inverse transform matrix of the drawable.

-

Parameters:
- - - -
Name : Parameter name in the effect
X,Y,Z : Values to assign
-
+
Returns:
Inverse transform matrix
+ +

Definition at line 350 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
void sf::PostFX::SetParameter const Matrix3 & sf::Drawable::GetMatrix (const std::string &  Name,
float  X,
float  Y,
float  Z,
float  W 
)  )  const [protected, inherited]

-Change a parameter of the effect (4 floats). +Get the transform matrix of the drawable.

-

Parameters:
- - - -
Name : Parameter name in the effect
X,Y,Z,W : Values to assign
-
+
Returns:
Transform matrix
+ +

Definition at line 334 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::PostFX::SetTexture const Vector2f & sf::Drawable::GetPosition (const std::string &  Name,
Image *  Texture 
)  )  const [inherited]

-Set a texture parameter. +Get the position of the object.

-

Parameters:
- - - -
Name : Texture name in the effect
Texture : Image to set (pass NULL to use content of current framebuffer)
-
+
Returns:
Current position
+ +

Definition at line 213 of file Drawable.cpp.

- +

- + - - + - +
PostFX& sf::PostFX::operator= float sf::Drawable::GetRotation (const PostFX &  Other  )  const [inherited]

-Assignment operator. +Get the orientation of the object.

-

Parameters:
- - -
Other : Instance to assign
-
-
Returns:
Reference to the post-effect
+Rotation is always in the range [0, 360]

+

Returns:
Current rotation, in degrees
+ +

Definition at line 240 of file Drawable.cpp.

- +

- + - +
static bool sf::PostFX::CanUsePostFX const Vector2f & sf::Drawable::GetScale (  )  [static] const [inherited]

-Tell whether or not the system supports post-effects. +Get the current scale of the object.

-

Returns:
True if the system can use post-effects
+
Returns:
Current scale factor (always positive)
+ +

Definition at line 222 of file Drawable.cpp.

- +

- + - - + + - +
virtual void sf::PostFX::Render bool sf::PostFX::LoadFromFile (RenderTarget &  Target const std::string &  Filename  )  const [protected, virtual]

-/see Drawable::Render +Load the effect from a file.

+

Parameters:
+ + +
Filename : Path of the effect file to load
+
+
Returns:
True on success
+ +

Definition at line 89 of file PostFX.cpp.

-

-Implements sf::Drawable.

- +

- + - - - - - - - - - - + + + - -
void sf::Drawable::SetPosition bool sf::PostFX::LoadFromMemory (float  X,
float  Y 
const std::string &  Effect  )  ) [inherited]

-Set the position of the object (take 2 values). +Load the effect from a text in memory.

Parameters:
- - +
X : New X coordinate
Y : New Y coordinate
Effect : String containing the effect code
+
Returns:
True on success
+ +

Definition at line 112 of file PostFX.cpp.

- +

- + - + - +
void sf::Drawable::SetPosition void sf::Drawable::Move ( const Vector2f &  Position Offset  )  [inherited] [inherited]

-Set the position of the object (take a 2D vector). +Move the object of a given offset (take a 2D vector).

Parameters:
- +
Position : New position
Offset : Amount of units to move the object of
+

Definition at line 278 of file Drawable.cpp.

+

- +

- + - - - + + + + + + + + + + + +
void sf::Drawable::SetX void sf::Drawable::Move ( float  X  )  [inherited] OffsetX,
float  OffsetY 
) [inherited]

-Set the X position of the object. +Move the object of a given offset (take 2 values).

Parameters:
- + +
X : New X coordinate
OffsetX : X offset
OffsetY : Y offset
+

Definition at line 268 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetY PostFX & sf::PostFX::operator= (float  Y const PostFX &  Other  )  [inherited]

-Set the Y position of the object. +Assignment operator.

Parameters:
- +
Y : New Y coordinate
Other : Instance to assign
+
Returns:
Reference to the post-effect
+ +

Definition at line 249 of file PostFX.cpp.

- +

- + - - - - - - - - - - - - - + + + +
void sf::Drawable::SetScale void sf::PostFX::Render (float  ScaleX,
float  ScaleY 
) [inherited]RenderTarget &  Target  )  const [protected, virtual]

-Set the scale of the object (take 2 values). +/see Drawable::Render

-

Parameters:
- - - -
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
-
+ +

Implements sf::Drawable.

+ +

Definition at line 280 of file PostFX.cpp.

- +

- + - - + + - +
void sf::Drawable::SetScale void sf::Drawable::Rotate (const Vector2f &  Scale float  Angle  )  [inherited] [inherited]

-Set the scale of the object (take a 2D vector). +Rotate the object.

Parameters:
- +
Scale : New scale (both values must be strictly positive)
Angle : Angle of rotation, in degrees
+

Definition at line 306 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetScaleX void sf::Drawable::Scale (float  FactorX const Vector2f &  Factor  )  [inherited] [inherited]

-Set the X scale factor of the object. +Scale the object (take a 2D vector).

Parameters:
- +
X : New X scale factor
Factor : Scaling factors (both values must be strictly positive)
+

Definition at line 297 of file Drawable.cpp.

+

- +

- + - - - + + + + + + + + + + + +
void sf::Drawable::SetScaleY void sf::Drawable::Scale ( float  FactorY  )  [inherited] FactorX,
float  FactorY 
) [inherited]

-Set the Y scale factor of the object. +Scale the object (take 2 values).

Parameters:
- + +
Y : New Y scale factor
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
+

Definition at line 287 of file Drawable.cpp.

+

- +

- + - - - - - - - - - - - - - + + + +
void sf::Drawable::SetCenter void sf::Drawable::SetBlendMode (float  CenterX,
float  CenterY 
) [inherited]Blend::Mode  Mode  )  [inherited]

-Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). +Set the blending mode for the object.

-The default center is (0, 0)

+The default blend mode is Blend::Alpha

Parameters:
- - +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
Mode : New blending mode
+The default blend mode is Blend::Alpha +

Definition at line 204 of file Drawable.cpp.

@@ -879,7 +795,7 @@ The default center is (0, 0)

const Vector2f &  Center  )  - [inherited] + [inherited] @@ -888,39 +804,56 @@ The default center is (0, 0)

Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

+Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

The default center is (0, 0)

Parameters:
- +
Center : New center
Center : New center
+The default center is (0, 0) +

Definition at line 171 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + +
void sf::Drawable::SetRotation void sf::Drawable::SetCenter ( float  Rotation  )  [inherited] CenterX,
float  CenterY 
) [inherited]

-Set the orientation of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+The default center is (0, 0)

Parameters:
- + +
Rotation : Angle of rotation, in degrees
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
+The default center is (0, 0) +

Definition at line 157 of file Drawable.cpp.

@@ -934,7 +867,7 @@ Set the orientation of the object. const Color &  Col  )  - [inherited] + [inherited] @@ -946,353 +879,523 @@ Set the color of the object. The default color is white

Parameters:
- +
Col : New color
Col : New color
+The default color is white +

Definition at line 194 of file Drawable.cpp.

- +

- + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void sf::Drawable::SetBlendMode void sf::PostFX::SetParameter (Blend::Mode  Mode  )  [inherited]const std::string &  Name,
float  X,
float  Y,
float  Z,
float  W 
)

-Set the blending mode for the object. +Change a parameter of the effect (4 floats).

-The default blend mode is Blend::Alpha

Parameters:
- + +
Mode : New blending mode
Name : Parameter name in the effect
X,Y,Z,W : Values to assign
+

Definition at line 199 of file PostFX.cpp.

+

- +

- + - - - + + + + + + + + + + + + + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetPosition void sf::PostFX::SetParameter (  )  const [inherited]const std::string &  Name,
float  X,
float  Y,
float  Z 
)

-Get the position of the object. +Change a parameter of the effect (3 floats).

-

Returns:
Current position
+
Parameters:
+ + + +
Name : Parameter name in the effect
X,Y,Z : Values to assign
+
+ +

Definition at line 176 of file PostFX.cpp.

- +

- + - - - + + + + + + + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetScale void sf::PostFX::SetParameter (  )  const [inherited]const std::string &  Name,
float  X,
float  Y 
)

-Get the current scale of the object. +Change a parameter of the effect (2 floats).

-

Returns:
Current scale factor (always positive)
+
Parameters:
+ + + +
Name : Parameter name in the effect
X,Y : Values to assign
+
+ +

Definition at line 153 of file PostFX.cpp.

- +

- + - - - + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetCenter void sf::PostFX::SetParameter (  )  const [inherited]const std::string &  Name,
float  X 
)

-Get the center of the object. +Change a parameter of the effect (1 float).

-

Returns:
Current position of the center
+
Parameters:
+ + + +
Name : Parameter name in the effect
X : Value to assign
+
+ +

Definition at line 130 of file PostFX.cpp.

- +

- + - + + - +
float sf::Drawable::GetRotation void sf::Drawable::SetPosition ( const Vector2f &  Position  )  const [inherited] [inherited]

-Get the orientation of the object. +Set the position of the object (take a 2D vector).

-Rotation is always in the range [0, 360]

-

Returns:
Current rotation, in degrees
+
Parameters:
+ + +
Position : New position
+
+ +

Definition at line 75 of file Drawable.cpp.

- +

- + - + + + + + + + + + + + + + + +
const Color& sf::Drawable::GetColor void sf::Drawable::SetPosition ( float  X,
float  Y 
) [inherited]
+
+
+ +

+Set the position of the object (take 2 values). +

+

Parameters:
+ + + +
X : New X coordinate
Y : New Y coordinate
+
+ +

Definition at line 65 of file Drawable.cpp.

+ +
+

+ +

+
+ + + + + + - +
void sf::Drawable::SetRotation (float  Rotation  )  const [inherited] [inherited]

-Get the color of the object. +Set the orientation of the object.

-

Returns:
Current color
+
Parameters:
+ + +
Rotation : Angle of rotation, in degrees
+
+ +

Definition at line 180 of file Drawable.cpp.

- +

- + - + + - +
Blend::Mode sf::Drawable::GetBlendMode void sf::Drawable::SetScale ( const Vector2f &  Scale  )  const [inherited] [inherited]

-Get the current blending mode. +Set the scale of the object (take a 2D vector).

-

Returns:
Current blending mode
+
Parameters:
+ + +
Scale : New scale (both values must be strictly positive)
+
+ +

Definition at line 117 of file Drawable.cpp.

- +

- + - + - + - +
void sf::Drawable::Move void sf::Drawable::SetScale ( float  OffsetX, ScaleX,
float  OffsetY  ScaleY 
) [inherited] [inherited]

-Move the object of a given offset (take 2 values). +Set the scale of the object (take 2 values).

Parameters:
- - + +
OffsetX : X offset
OffsetY : Y offset
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
+

Definition at line 107 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Move void sf::Drawable::SetScaleX (const Vector2f &  Offset float  FactorX  )  [inherited] [inherited]

-Move the object of a given offset (take a 2D vector). +Set the X scale factor of the object.

Parameters:
- +
Offset : Amount of units to move the object of
X : New X scale factor
+

Definition at line 127 of file Drawable.cpp.

+

- +

- + - - - - - - - - - - - - + + +
void sf::Drawable::Scale void sf::Drawable::SetScaleY ( float  FactorX,
float  FactorY 
) [inherited] FactorY  )  [inherited]

-Scale the object (take 2 values). +Set the Y scale factor of the object.

Parameters:
- - +
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
Y : New Y scale factor
+

Definition at line 141 of file Drawable.cpp.

+

- +

- + - - - - + + + + + + + + + + + + +
void sf::Drawable::Scale void sf::PostFX::SetTexture (const Vector2f &  Factor  )  [inherited]const std::string &  Name,
Image *  Texture 
)

-Scale the object (take a 2D vector). +Set a texture parameter.

Parameters:
- + +
Factor : Scaling factors (both values must be strictly positive)
Name : Texture name in the effect
Texture : Image to set (pass NULL to use content of current framebuffer)
+

Definition at line 222 of file PostFX.cpp.

+

- +

- + - + - +
void sf::Drawable::Rotate void sf::Drawable::SetX ( float  Angle X  )  [inherited] [inherited]

-Rotate the object. +Set the X position of the object.

Parameters:
- +
Angle : Angle of rotation, in degrees
X : New X coordinate
+

Definition at line 85 of file Drawable.cpp.

+

- +

- + - - + + - +
sf::Vector2f sf::Drawable::TransformToLocal void sf::Drawable::SetY (const sf::Vector2f &  Point float  Y  )  const [inherited] [inherited]

-Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point). +Set the Y position of the object.

Parameters:
- +
Point : Point to transform
Y : New Y coordinate
-
Returns:
Transformed point
+ +

Definition at line 96 of file Drawable.cpp.

@@ -1306,7 +1409,7 @@ Transform a point from global coordinates into local coordinates (ie it applies const sf::Vector2f &  Point  )  - const [inherited] + const [inherited] @@ -1315,6 +1418,7 @@ Transform a point from global coordinates into local coordinates (ie it applies

Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

+Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Parameters:
@@ -1322,54 +1426,44 @@ Transform a point from local coordinates into global coordinates (ie it applies
Returns:
Transformed point
- -

- -

-
-
Point : Point to transform
- - - - - - - -
const Matrix3& sf::Drawable::GetMatrix (  )  const [protected, inherited]
- -
- -

-Get the transform matrix of the drawable. -

-

Returns:
Transform matrix
+

Definition at line 325 of file Drawable.cpp.

- +

- + - + + - +
const Matrix3& sf::Drawable::GetInverseMatrix sf::Vector2f sf::Drawable::TransformToLocal ( const sf::Vector2f &  Point  )  const [protected, inherited] const [inherited]

-Get the inverse transform matrix of the drawable. +Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

-

Returns:
Inverse transform matrix
+Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+ +

Definition at line 316 of file Drawable.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Randomizer Member List

This is the complete list of members for sf::Randomizer, including all inherited members.

- - - - -
GetSeed()sf::Randomizer [static]
Random(float Begin, float End)sf::Randomizer [static]
Random(int Begin, int End)sf::Randomizer [static]
SetSeed(unsigned int Seed)sf::Randomizer [static]
+ GetSeed()sf::Randomizer [static] + Random(float Begin, float End)sf::Randomizer [static] + Random(int Begin, int End)sf::Randomizer [static] + SetSeed(unsigned int Seed)sf::Randomizer [static] +

+ - -
- + + -
- -
-
-sf::Randomizer
+

sf::Randomizer Class Reference

Randomizer is an utility class for generating pseudo-random numbers. More...

#include <Randomizer.hpp> +

+

List of all members. - + - - + + - - + + - - + + - +

Static Public Member Functions

static void SetSeed (unsigned int Seed)
static void SetSeed (unsigned int Seed)
 Set the seed for the generator.
static unsigned int GetSeed ()
 Set the seed for the generator.
static unsigned int GetSeed ()
 Get the seed used to generate random numbers the generator.
static float Random (float Begin, float End)
 Get the seed used to generate random numbers the generator.
static float Random (float Begin, float End)
 Get a random float number in a given range.
static int Random (int Begin, int End)
 Get a random float number in a given range.
static int Random (int Begin, int End)
 Get a random integer number in a given range.
 Get a random integer number in a given range.

Detailed Description

Randomizer is an utility class for generating pseudo-random numbers. -

- -

-Definition at line 40 of file Randomizer.hpp.

Member Function Documentation

- +

Definition at line 40 of file Randomizer.hpp.

+

Member Function Documentation

+
- + - - + - +
static void sf::Randomizer::SetSeed unsigned int sf::Randomizer::GetSeed (unsigned int  Seed  )  [static] [static]

-Set the seed for the generator. +Get the seed used to generate random numbers the generator.

-Using a known seed allows you to reproduce the same sequence of random number

-

Parameters:
- - -
Seed : Number to use as the seed
-
+
Returns:
Current seed
+ +

Definition at line 67 of file Randomizer.cpp.

- +

- + - - - + + + + + + + + + + + + +
static unsigned int sf::Randomizer::GetSeed int sf::Randomizer::Random (  )  [static]int  Begin,
int  End 
) [static]

-Get the seed used to generate random numbers the generator. +Get a random integer number in a given range.

-

Returns:
Current seed
+
Returns:
Start : Start of the range

+End : End of the range

+Random number in [Begin, End]

+ +

Definition at line 88 of file Randomizer.cpp.

- +

- + @@ -125,7 +138,7 @@ Get the seed used to generate random numbers the generator. - +
static float sf::Randomizer::Random float sf::Randomizer::Random ( float  Begin,
) [static] [static]
@@ -138,44 +151,43 @@ Get a random float number in a given range. End : End of the range

Random number in [Begin, End]

+

Definition at line 76 of file Randomizer.cpp.

+

- +

- + - - - - - - - - - - - - - + + + +
static int sf::Randomizer::Random void sf::Randomizer::SetSeed (int  Begin,
int  End 
) [static]unsigned int  Seed  )  [static]

-Get a random integer number in a given range. +Set the seed for the generator.

-

Returns:
Start : Start of the range

-End : End of the range

-Random number in [Begin, End]

+Using a known seed allows you to reproduce the same sequence of random number

+

Parameters:
+ + +
Seed : Number to use as the seed
+
+Using a known seed allows you to reproduce the same sequence of random number +

Definition at line 57 of file Randomizer.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Rect< T > Member List

This is the complete list of members for sf::Rect< T >, including all inherited members.

- - - + + + @@ -39,7 +42,8 @@ -
Bottomsf::Rect< T >
Contains(T X, T Y) constsf::Rect< T >
GetHeight() constsf::Rect< T >
GetWidth() constsf::Rect< T >
Contains(T X, T Y) const sf::Rect< T >
GetHeight() const sf::Rect< T >
GetWidth() const sf::Rect< T >
Intersects(const Rect< T > &Rectangle, Rect< T > *OverlappingRect=NULL) const sf::Rect< T >
Leftsf::Rect< T >
Offset(T OffsetX, T OffsetY)sf::Rect< T >
Rect(T LeftCoord, T TopCoord, T RightCoord, T BottomCoord)sf::Rect< T >
Rightsf::Rect< T >
Topsf::Rect< T >
+

+ - -
- + + -
- -
-
-sf::Rect
+

sf::Rect< T > Class Template Reference

Rect is an utility class for manipulating rectangles. More...

#include <Rect.hpp> +

+

List of all members. @@ -43,18 +48,18 @@ - + - - + + - + - + - + @@ -79,10 +84,8 @@ Rect is an utility class for manipulating rectangles.

Template parameter defines the type of coordinates (integer, float, ...) -

- -

-Definition at line 41 of file Rect.hpp.

Constructor & Destructor Documentation

+

Definition at line 41 of file Rect.hpp.

+

Constructor & Destructor Documentation

@@ -94,7 +97,7 @@ template<typename T>
- +
 Rect (T LeftCoord, T TopCoord, T RightCoord, T BottomCoord)
 Construct the rectangle from its coordinates.
T GetWidth () const
T GetWidth () const
 Get the width of the rectangle.
T GetHeight () const
 Get the width of the rectangle.
T GetHeight () const
 Get the height of the rectangle.
 Get the height of the rectangle.
void Offset (T OffsetX, T OffsetY)
 Move the whole rectangle by the given offset.
bool Contains (T X, T Y) const
bool Contains (T X, T Y) const
 Check if a point is inside the rectangle's area.
 Check if a point is inside the rectangle's area.
bool Intersects (const Rect< T > &Rectangle, Rect< T > *OverlappingRect=NULL) const
 Check intersection between two rectangles.
(  ) 

@@ -139,7 +142,7 @@ template<typename T>
) - +
@@ -160,31 +163,47 @@ Construct the rectangle from its coordinates.

Member Function Documentation

- +
template<typename T>
- + - - - + + + + + + + + + + + + +
T sf::Rect< T >::GetWidth bool sf::Rect< T >::Contains (  )  constT  X,
T  Y 
) const

-Get the width of the rectangle. +Check if a point is inside the rectangle's area.

-

Returns:
Width of rectangle
+
Parameters:
+ + + +
X : X coordinate of the point to test
Y : Y coordinate of the point to test
+
+
Returns:
True if the point is inside

- +

@@ -195,7 +214,7 @@ template<typename T>
(  )  - const + const
@@ -208,166 +227,150 @@ Get the height of the rectangle.

- +

template<typename T>
- + - - - - - - - - - - - - - + + +
void sf::Rect< T >::Offset T sf::Rect< T >::GetWidth (T  OffsetX,
T  OffsetY 
)  )  const

-Move the whole rectangle by the given offset. +Get the width of the rectangle.

-

Parameters:
- - - -
OffsetX : Horizontal offset
OffsetY : Vertical offset
-
+
Returns:
Width of rectangle

- +

template<typename T>
- + - - + + - - + + - +
bool sf::Rect< T >::Contains bool sf::Rect< T >::Intersects (T  X, const Rect< T > &  Rectangle,
T  Y Rect< T > *  OverlappingRect = NULL 
) const const

-Check if a point is inside the rectangle's area. +Check intersection between two rectangles.

Parameters:
- - + +
X : X coordinate of the point to test
Y : Y coordinate of the point to test
Rectangle : Rectangle to test
OverlappingRect : Rectangle to be filled with overlapping rect (NULL by default)
-
Returns:
True if the point is inside
+
Returns:
True if rectangles overlap

- +

template<typename T>
- + - - + + - - + + - +
bool sf::Rect< T >::Intersects void sf::Rect< T >::Offset (const Rect< T > &  Rectangle, T  OffsetX,
Rect< T > *  OverlappingRect = NULL T  OffsetY 
) const

-Check intersection between two rectangles. +Move the whole rectangle by the given offset.

Parameters:
- - + +
Rectangle : Rectangle to test
OverlappingRect : Rectangle to be filled with overlapping rect (NULL by default)
OffsetX : Horizontal offset
OffsetY : Vertical offset
-
Returns:
True if rectangles overlap

Member Data Documentation

- +
template<typename T>
- +
T sf::Rect< T >::Left T sf::Rect< T >::Bottom

-Left coordinate of the rectangle. +Bottom coordinate of the rectangle.

-

-Definition at line 112 of file Rect.hpp. +

Definition at line 115 of file Rect.hpp.

+

- +

template<typename T>
- +
T sf::Rect< T >::Top T sf::Rect< T >::Left

-Top coordinate of the rectangle. +Left coordinate of the rectangle.

-

-Definition at line 113 of file Rect.hpp. +

Definition at line 112 of file Rect.hpp.

+

@@ -387,33 +390,34 @@ template<typename T> Right coordinate of the rectangle.

-

-Definition at line 114 of file Rect.hpp. +

Definition at line 114 of file Rect.hpp.

+

- +

template<typename T>
- +
T sf::Rect< T >::Bottom T sf::Rect< T >::Top

-Bottom coordinate of the rectangle. +Top coordinate of the rectangle.

-

-Definition at line 115 of file Rect.hpp. +

Definition at line 113 of file Rect.hpp.

+

The documentation for this class was generated from the following file: + + + +
+

sf::RenderImage Member List

This is the complete list of members for sf::RenderImage, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
CanUseRenderImage()sf::RenderImage [static]
Clear(const Color &FillColor=Color(0, 0, 0))sf::RenderTarget
Create(unsigned int Width, unsigned int Height, bool DepthBuffer=false)sf::RenderImage
Draw(const Drawable &Object)sf::RenderTarget [virtual]
GetDefaultView()sf::RenderTarget
GetHeight() const sf::RenderImage [virtual]
GetImage() const sf::RenderImage
GetView() const sf::RenderTarget
GetWidth() const sf::RenderImage [virtual]
Initialize()sf::RenderTarget [protected]
NonCopyable()sf::NonCopyable [inline, private]
PreserveOpenGLStates(bool Preserve)sf::RenderTarget
RenderImage()sf::RenderImage
RenderTarget()sf::RenderTarget [protected]
SetActive(bool Active=true) const sf::RenderImage
SetView(const View &NewView)sf::RenderTarget
~RenderImage()sf::RenderImage [virtual]
~RenderTarget()sf::RenderTarget [virtual]

+ + + + + diff --git a/doc/html/classsf_1_1RenderImage.htm b/doc/html/classsf_1_1RenderImage.htm new file mode 100755 index 0000000..a80c474 --- /dev/null +++ b/doc/html/classsf_1_1RenderImage.htm @@ -0,0 +1,532 @@ + + + + SFML - Simple and Fast Multimedia Library + + + + + + + + +
+

sf::RenderImage Class Reference

Target for 2D rendering into an image that can be reused in a sprite. +More... +

+#include <RenderImage.hpp> +

+

+Inheritance diagram for sf::RenderImage:
+
+ +

+ +sf::RenderTarget +sf::NonCopyable + +
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 RenderImage ()
 Default constructor.
virtual ~RenderImage ()
 Destructor.
bool Create (unsigned int Width, unsigned int Height, bool DepthBuffer=false)
 Create the render image from its dimensions.
bool SetActive (bool Active=true) const
 Activate of deactivate the render-image as the current target for rendering.
virtual unsigned int GetWidth () const
 Get the width of the rendering region of the image.
virtual unsigned int GetHeight () const
 Get the height of the rendering region of the image.
const Image & GetImage () const
 Get the target image.
void Clear (const Color &FillColor=Color(0, 0, 0))
 Clear the entire target with a single color.
virtual void Draw (const Drawable &Object)
 Draw something into the target.
void SetView (const View &NewView)
 Change the current active view.
const View & GetView () const
 Get the current view.
View & GetDefaultView ()
 Get the default view of the window for read / write.
void PreserveOpenGLStates (bool Preserve)
 Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Static Public Member Functions

static bool CanUseRenderImage ()
 Check whether the system supports render images or not.

Protected Member Functions

void Initialize ()
 Called by the derived class when it's ready to be initialized.
+

Detailed Description

+Target for 2D rendering into an image that can be reused in a sprite. +

Definition at line 47 of file RenderImage.hpp.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
sf::RenderImage::RenderImage (  ) 
+
+
+ +

+Default constructor. +

+ +

Definition at line 39 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + +
sf::RenderImage::~RenderImage (  )  [virtual]
+
+
+ +

+Destructor. +

+ +

Definition at line 49 of file RenderImage.cpp.

+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
bool sf::RenderImage::CanUseRenderImage (  )  [static]
+
+
+ +

+Check whether the system supports render images or not. +

+

Returns:
True if RenderImage can be used
+ +

Definition at line 143 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void sf::RenderTarget::Clear (const Color &  FillColor = Color(0, 0, 0)  )  [inherited]
+
+
+ +

+Clear the entire target with a single color. +

+

Parameters:
+ + +
FillColor : Color to use to clear the render target
+
+ +

Definition at line 60 of file RenderTarget.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool sf::RenderImage::Create (unsigned int  Width,
unsigned int  Height,
bool  DepthBuffer = false 
)
+
+
+ +

+Create the render image from its dimensions. +

+

Parameters:
+ + + + +
Width : Width of the render image
Height : Height of the render image
DepthBuffer : Do you want a depth buffer attached ? (false by default)
+
+
Returns:
True if creation has been successful
+ +

Definition at line 59 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void sf::RenderTarget::Draw (const Drawable &  Object  )  [virtual, inherited]
+
+
+ +

+Draw something into the target. +

+Draw something on the window.

+

Parameters:
+ + +
Object : Object to draw
+
+ +

Definition at line 76 of file RenderTarget.cpp.

+ +
+

+ +

+
+ + + + + + + + +
View & sf::RenderTarget::GetDefaultView (  )  [inherited]
+
+
+ +

+Get the default view of the window for read / write. +

+

Returns:
Default view
+ +

Definition at line 147 of file RenderTarget.cpp.

+ +
+

+ +

+
+ + + + + + + + +
unsigned int sf::RenderImage::GetHeight (  )  const [virtual]
+
+
+ +

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

+

Returns:
Height in pixels
+ +

Implements sf::RenderTarget.

+ +

Definition at line 125 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + +
const Image & sf::RenderImage::GetImage (  )  const
+
+
+ +

+Get the target image. +

+

Returns:
Target image
+ +

Definition at line 134 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + +
const View & sf::RenderTarget::GetView (  )  const [inherited]
+
+
+ +

+Get the current view. +

+

Returns:
Current view active in the window
+ +

Definition at line 138 of file RenderTarget.cpp.

+ +
+

+ +

+
+ + + + + + + + +
unsigned int sf::RenderImage::GetWidth (  )  const [virtual]
+
+
+ +

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

+

Returns:
Width in pixels
+ +

Implements sf::RenderTarget.

+ +

Definition at line 116 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void sf::RenderTarget::Initialize (  )  [protected, inherited]
+
+
+ +

+Called by the derived class when it's ready to be initialized. +

+ +

Definition at line 169 of file RenderTarget.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void sf::RenderTarget::PreserveOpenGLStates (bool  Preserve  )  [inherited]
+
+
+ +

+Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. +

+Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

+Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default

+

Parameters:
+ + +
Preserve : True to preserve OpenGL states, false to let SFML optimize
+
+Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default +

Definition at line 160 of file RenderTarget.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
bool sf::RenderImage::SetActive (bool  Active = true  )  const
+
+
+ +

+Activate of deactivate the render-image as the current target for rendering. +

+Activate of deactivate the render-image as the current target for rendering.

+

Parameters:
+ + +
Active : True to activate, false to deactivate (true by default)
+
+
Returns:
True if operation was successful, false otherwise
+ +

Definition at line 107 of file RenderImage.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void sf::RenderTarget::SetView (const View &  NewView  )  [inherited]
+
+
+ +

+Change the current active view. +

+

Parameters:
+ + +
NewView : New view to use (pass GetDefaultView() to set the default view)
+
+ +

Definition at line 129 of file RenderTarget.cpp.

+ +
+

+

The documentation for this class was generated from the following files: +
+ + + + + diff --git a/doc/html/classsf_1_1RenderImage.png b/doc/html/classsf_1_1RenderImage.png new file mode 100755 index 0000000..c8b8895 Binary files /dev/null and b/doc/html/classsf_1_1RenderImage.png differ diff --git a/doc/html/classsf_1_1RenderTarget-members.htm b/doc/html/classsf_1_1RenderTarget-members.htm index 92487d9..dd1524d 100755 --- a/doc/html/classsf_1_1RenderTarget-members.htm +++ b/doc/html/classsf_1_1RenderTarget-members.htm @@ -10,36 +10,40 @@ - -
- -
-
- + + +

sf::RenderTarget Member List

This is the complete list of members for sf::RenderTarget, including all inherited members.

- - - - - + + + + + - -
Clear(const Color &FillColor=Color(0, 0, 0))sf::RenderTarget
Draw(const Drawable &Object)sf::RenderTarget [virtual]
GetDefaultView()sf::RenderTarget
GetHeight() const=0sf::RenderTarget [pure virtual]
GetView() constsf::RenderTarget
GetWidth() const=0sf::RenderTarget [pure virtual]
Draw(const Drawable &Object)sf::RenderTarget [virtual]
GetDefaultView()sf::RenderTarget
GetHeight() const =0sf::RenderTarget [pure virtual]
GetView() const sf::RenderTarget
GetWidth() const =0sf::RenderTarget [pure virtual]
Initialize()sf::RenderTarget [protected]
PreserveOpenGLStates(bool Preserve)sf::RenderTarget
RenderTarget()sf::RenderTarget [protected]
SetView(const View &NewView)sf::RenderTarget
~RenderTarget()sf::RenderTarget [virtual]
+ ~RenderTarget()sf::RenderTarget [virtual] +

+ - -
- + + -
- -
-
-sf::RenderTarget
+

sf::RenderTarget Class Reference

Base class for all render targets (window, image, . More...

#include <RenderTarget.hpp>

-

Inheritance diagram for sf::RenderTarget: +

+Inheritance diagram for sf::RenderTarget:
+
+

sf::RenderWindow +
+ +

List of all members. - + - + - + - - + + - - + + - + - + - - + + - + @@ -81,20 +90,18 @@ Base class for all render targets (window, image, .

..) -

- -

-Definition at line 43 of file RenderTarget.hpp.

Constructor & Destructor Documentation

- +

Definition at line 43 of file RenderTarget.hpp.

+

Constructor & Destructor Documentation

+

Public Member Functions

virtual ~RenderTarget ()
virtual ~RenderTarget ()
 Destructor.
 Destructor.
void Clear (const Color &FillColor=Color(0, 0, 0))
 Clear the entire target with a single color.
virtual void Draw (const Drawable &Object)
virtual void Draw (const Drawable &Object)
 Draw something into the target.
virtual unsigned int GetWidth () const=0
 Draw something into the target.
virtual unsigned int GetWidth () const =0
 Get the width of the rendering region of the target.
virtual unsigned int GetHeight () const=0
 Get the width of the rendering region of the target.
virtual unsigned int GetHeight () const =0
 Get the height of the rendering region of the target.
 Get the height of the rendering region of the target.
void SetView (const View &NewView)
 Change the current active view.
const View & GetView () const
const View & GetView () const
 Get the current view.
View & GetDefaultView ()
 Get the current view.
View & GetDefaultView ()
 Get the default view of the window for read / write.
 Get the default view of the window for read / write.
void PreserveOpenGLStates (bool Preserve)
 Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.
- + - +
virtual sf::RenderTarget::~RenderTarget sf::RenderTarget::~RenderTarget (  )  [virtual] [virtual]

@@ -104,6 +111,8 @@ Definition at line 43 +

Definition at line 51 of file RenderTarget.cpp.

+

@@ -115,7 +124,7 @@ Destructor. (  )  - [protected] + [protected] @@ -125,6 +134,8 @@ Destructor. Default constructor.

+

Definition at line 39 of file RenderTarget.cpp.

+

Member Function Documentation

@@ -138,7 +149,7 @@ Default constructor. const Color &  FillColor = Color(0, 0, 0)  )  - + @@ -153,19 +164,21 @@ Clear the entire target with a single color. +

Definition at line 60 of file RenderTarget.cpp.

+

- +

- + - +
virtual void sf::RenderTarget::Draw void sf::RenderTarget::Draw ( const Drawable &  Object  )  [virtual] [virtual]
@@ -174,39 +187,42 @@ Clear the entire target with a single color.

Draw something into the target.

+Draw something on the window.

Parameters:
Object : Object to draw
+

Definition at line 76 of file RenderTarget.cpp.

+

- +

- + - +
virtual unsigned int sf::RenderTarget::GetWidth View & sf::RenderTarget::GetDefaultView (  )  const [pure virtual]

-Get the width of the rendering region of the target. +Get the default view of the window for read / write.

-

Returns:
Width in pixels
+
Returns:
Default view
+ +

Definition at line 147 of file RenderTarget.cpp.

-

-Implemented in sf::RenderWindow.

- +

@@ -215,7 +231,7 @@ Implemented in - +
 )  const [pure virtual] const [pure virtual]
@@ -226,78 +242,78 @@ Get the height of the rendering region of the target.

Returns:
Height in pixels
-

-Implemented in sf::RenderWindow. +

Implemented in sf::RenderWindow.

+

- +

- + - - + - +
void sf::RenderTarget::SetView const View & sf::RenderTarget::GetView (const View &  NewView  )  const

-Change the current active view. +Get the current view.

-

Parameters:
- - -
NewView : New view to use (pass GetDefaultView() to set the default view)
-
+
Returns:
Current view active in the window
+ +

Definition at line 138 of file RenderTarget.cpp.

- +

- + - +
const View& sf::RenderTarget::GetView virtual unsigned int sf::RenderTarget::GetWidth (  )  const const [pure virtual]

-Get the current view. +Get the width of the rendering region of the target.

-

Returns:
Current view active in the window
+
Returns:
Width in pixels
+ +

Implemented in sf::RenderWindow.

- +

- + - +
View& sf::RenderTarget::GetDefaultView void sf::RenderTarget::Initialize (  )  [protected]

-Get the default view of the window for read / write. +Called by the derived class when it's ready to be initialized.

-

Returns:
Default view
+ +

Definition at line 170 of file RenderTarget.cpp.

@@ -311,7 +327,7 @@ Get the default view of the window for read / write. bool  Preserve  )  - + @@ -320,38 +336,50 @@ Get the default view of the window for read / write.

Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

+Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default

Parameters:
- +
Preserve : True to preserve OpenGL states, false to let SFML optimize
Preserve : True to preserve OpenGL states, false to let SFML optimize
+Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default +

Definition at line 161 of file RenderTarget.cpp.

- +

- + - + + - +
void sf::RenderTarget::Initialize void sf::RenderTarget::SetView ( const View &  NewView  )  [protected]

-Called by the derived class when it's ready to be initialized. +Change the current active view.

+

Parameters:
+ + +
NewView : New view to use (pass GetDefaultView() to set the default view)
+
+ +

Definition at line 129 of file RenderTarget.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::RenderWindow Member List

This is the complete list of members for sf::RenderWindow, including all inherited members.

- + - + - + - - - - - - + + + + + + - + @@ -66,11 +69,12 @@ - - - + + + -
Capture() constsf::RenderWindow
Capture() const sf::RenderWindow
Clear(const Color &FillColor=Color(0, 0, 0))sf::RenderTarget
Close()sf::Window
ConvertCoords(unsigned int WindowX, unsigned int WindowY, const View *TargetView=NULL) const sf::RenderWindow
Create(VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())sf::Window
Create(WindowHandle Handle, const WindowSettings &Params=WindowSettings())sf::Window
Display()sf::Window
Draw(const Drawable &Object)sf::RenderTarget [virtual]
Draw(const Drawable &Object)sf::RenderTarget [virtual]
EnableKeyRepeat(bool Enabled)sf::Window
GetDefaultView()sf::RenderTarget
GetDefaultView()sf::RenderTarget
GetEvent(Event &EventReceived)sf::Window
GetFrameTime() constsf::Window
GetHeight() constsf::RenderWindow [virtual]
GetInput() constsf::Window
GetSettings() constsf::Window
GetView() constsf::RenderTarget
GetWidth() constsf::RenderWindow [virtual]
GetFrameTime() const sf::Window
GetHeight() const sf::RenderWindow [virtual]
GetInput() const sf::Window
GetSettings() const sf::Window
GetView() const sf::RenderTarget
GetWidth() const sf::RenderWindow [virtual]
Initialize()sf::RenderTarget [protected]
IsOpened() constsf::Window
IsOpened() const sf::Window
PreserveOpenGLStates(bool Preserve)sf::RenderTarget
RenderTarget()sf::RenderTarget [protected]
RenderWindow()sf::RenderWindow
Window()sf::Window
Window(VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())sf::Window
Window(WindowHandle Handle, const WindowSettings &Params=WindowSettings())sf::Window
~RenderTarget()sf::RenderTarget [virtual]
~RenderWindow()sf::RenderWindow [virtual]
~Window()sf::Window [virtual]
~RenderTarget()sf::RenderTarget [virtual]
~RenderWindow()sf::RenderWindow [virtual]
~Window()sf::Window [virtual]
~WindowListener()sf::WindowListener [inline, protected, virtual]
+

+ - -
- -
-
- -
-
-sf::RenderWindow
+ + +

sf::RenderWindow Class Reference

Simple wrapper for sf::Window that allows easy 2D rendering. More...

#include <RenderWindow.hpp>

-

Inheritance diagram for sf::RenderWindow: +

+Inheritance diagram for sf::RenderWindow:
+
+

sf::Window @@ -42,6 +48,9 @@ sf::WindowListener sf::NonCopyable +
+ +

List of all members. @@ -54,18 +63,18 @@ - + - - + + - - + + - - + + - + @@ -78,12 +87,12 @@ - + - - + + - + @@ -117,33 +126,33 @@ - + - + - + - + - + - + - + - - + + - + @@ -154,10 +163,8 @@

Public Member Functions

 RenderWindow (WindowHandle Handle, const WindowSettings &Params=WindowSettings())
 Construct the window from an existing control.
virtual ~RenderWindow ()
virtual ~RenderWindow ()
 Destructor.
virtual unsigned int GetWidth () const
 Destructor.
virtual unsigned int GetWidth () const
 Get the width of the rendering region of the window.
virtual unsigned int GetHeight () const
 Get the width of the rendering region of the window.
virtual unsigned int GetHeight () const
 Get the height of the rendering region of the window.
Image Capture () const
 Get the height of the rendering region of the window.
Image Capture () const
 Save the content of the window to an image.
 Save the content of the window to an image.
sf::Vector2f ConvertCoords (unsigned int WindowX, unsigned int WindowY, const View *TargetView=NULL) const
 Convert a point in window coordinates into view coordinates.
void Close ()
 Close (destroy) the window.
bool IsOpened () const
bool IsOpened () const
 Tell whether or not the window is opened (ie.
const WindowSettings & GetSettings () const
 Tell whether or not the window is opened (ie.
const WindowSettings & GetSettings () const
 Get the creation settings of the window.
 Get the creation settings of the window.
bool GetEvent (Event &EventReceived)
 Get the event on top of events stack, if any, and pop it.
void Display ()
 Display the window on screen.
const Input & GetInput () const
const Input & GetInput () const
 Get the input manager of the window.
 Get the input manager of the window.
void SetFramerateLimit (unsigned int Limit)
 Limit the framerate to a maximum fixed frequency.
float GetFrameTime () const
float GetFrameTime () const
 Get time elapsed since last frame.
 Get time elapsed since last frame.
void SetJoystickThreshold (float Threshold)
 Change the joystick threshold, ie.
void Clear (const Color &FillColor=Color(0, 0, 0))
 Clear the entire target with a single color.
virtual void Draw (const Drawable &Object)
virtual void Draw (const Drawable &Object)
 Draw something into the target.
 Draw something into the target.
void SetView (const View &NewView)
 Change the current active view.
const View & GetView () const
const View & GetView () const
 Get the current view.
View & GetDefaultView ()
 Get the current view.
View & GetDefaultView ()
 Get the default view of the window for read / write.
 Get the default view of the window for read / write.
void PreserveOpenGLStates (bool Preserve)
 Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Detailed Description

Simple wrapper for sf::Window that allows easy 2D rendering. -

- -

-Definition at line 45 of file RenderWindow.hpp.

Constructor & Destructor Documentation

+

Definition at line 45 of file RenderWindow.hpp.

+

Constructor & Destructor Documentation

@@ -167,7 +174,7 @@ Definition at line 45(  )  - +
@@ -177,6 +184,8 @@ Definition at line 45 +

Definition at line 40 of file RenderWindow.cpp.

+

@@ -199,7 +208,7 @@ Default constructor. unsigned long  - WindowStyle = Style::Resize|Style::Close, + WindowStyle = Style::Resize | Style::Close, @@ -210,7 +219,7 @@ Default constructor. ) - +

@@ -228,6 +237,8 @@ Construct the window. +

Definition at line 49 of file RenderWindow.cpp.

+

@@ -249,7 +260,7 @@ Construct the window. ) - + @@ -265,18 +276,20 @@ Construct the window from an existing control. +

Definition at line 58 of file RenderWindow.cpp.

+

- +

- + - +
virtual sf::RenderWindow::~RenderWindow sf::RenderWindow::~RenderWindow (  )  [virtual] [virtual]
@@ -286,76 +299,85 @@ Construct the window from an existing control. Destructor.

+

Definition at line 67 of file RenderWindow.cpp.

+

Member Function Documentation

- +
- + - +
virtual unsigned int sf::RenderWindow::GetWidth Image sf::RenderWindow::Capture (  )  const [virtual] const

-Get the width of the rendering region of the window. +Save the content of the window to an image.

-

Returns:
Width in pixels
+
Returns:
Image instance containing the contents of the screen
+ +

Definition at line 107 of file RenderWindow.cpp.

-

-Implements sf::RenderTarget.

- +

- + - + + - +
virtual unsigned int sf::RenderWindow::GetHeight void sf::RenderTarget::Clear ( const Color &  FillColor = Color(0, 0, 0)  )  const [virtual] [inherited]

-Get the height of the rendering region of the window. +Clear the entire target with a single color.

-

Returns:
Height in pixels
+
Parameters:
+ + +
FillColor : Color to use to clear the render target
+
+ +

Definition at line 60 of file RenderTarget.cpp.

-

-Implements sf::RenderTarget.

- +

- + - +
Image sf::RenderWindow::Capture void sf::Window::Close (  )  const [inherited]

-Save the content of the window to an image. +Close (destroy) the window.

-

Returns:
Image instance containing the contents of the screen
+The sf::Window instance remains valid and you can call Create to recreate the window

+The sf::Window instance remains valid and you can call Create to recreate the window +

Definition at line 165 of file Window.cpp.

@@ -384,7 +406,7 @@ Save the content of the window to an image. ) - const + const @@ -402,6 +424,48 @@ Convert a point in window coordinates into view coordinates.

Returns:
Converted point
+

Definition at line 142 of file RenderWindow.cpp.

+ + +

+ +

+
+ + + + + + + + + + + + + + + + + + +
void sf::Window::Create (WindowHandle  Handle,
const WindowSettings &  Params = WindowSettings() 
) [inherited]
+
+
+ +

+Create (or recreate) the window from an existing control. +

+Create the window from an existing control.

+

Parameters:
+ + + +
Handle : Platform-specific handle of the control
Params : Creation parameters (see default constructor for default values)
+
+ +

Definition at line 147 of file Window.cpp.

+

@@ -424,7 +488,7 @@ Convert a point in window coordinates into view coordinates. unsigned long  - WindowStyle = Style::Resize|Style::Close, + WindowStyle = Style::Resize | Style::Close, @@ -435,7 +499,7 @@ Convert a point in window coordinates into view coordinates. ) - [inherited] + [inherited] @@ -444,6 +508,7 @@ Convert a point in window coordinates into view coordinates.

Create (or recreate) the window.

+Create the window.

Parameters:
@@ -453,108 +518,114 @@ Create (or recreate) the window.
Mode : Video mode to use
+

Definition at line 104 of file Window.cpp.

+

- +

- + - - - - - - - - - - - - - + + +
void sf::Window::Create void sf::Window::Display (WindowHandle  Handle,
const WindowSettings &  Params = WindowSettings() 
) [inherited]  )  [inherited]

-Create (or recreate) the window from an existing control. +Display the window on screen.

-

Parameters:
- - - -
Handle : Platform-specific handle of the control
Params : Creation parameters (see default constructor for default values)
-
+ +

Definition at line 353 of file Window.cpp.

- +

- + - + + - +
void sf::Window::Close void sf::RenderTarget::Draw ( const Drawable &  Object  )  [inherited] [virtual, inherited]

-Close (destroy) the window. +Draw something into the target.

-The sf::Window instance remains valid and you can call Create to recreate the window +Draw something on the window.

+

Parameters:
+ + +
Object : Object to draw
+
+ +

Definition at line 76 of file RenderTarget.cpp.

+

- +

- + - + + - +
bool sf::Window::IsOpened void sf::Window::EnableKeyRepeat ( bool  Enabled  )  const [inherited] [inherited]

-Tell whether or not the window is opened (ie. +Enable or disable automatic key-repeat.

-has been created). Note that a hidden window (Show(false)) will still return true

-

Returns:
True if the window is opened
+Automatic key-repeat is enabled by default

+

Parameters:
+ + +
Enabled : True to enable, false to disable
+
+Automatic key-repeat is enabled by default +

Definition at line 317 of file Window.cpp.

- +

- + - +
const WindowSettings& sf::Window::GetSettings View & sf::RenderTarget::GetDefaultView (  )  const [inherited] [inherited]

-Get the creation settings of the window. +Get the default view of the window for read / write.

-

Returns:
Structure containing the creation settings
+
Returns:
Default view
+ +

Definition at line 147 of file RenderTarget.cpp.

@@ -568,7 +639,7 @@ Get the creation settings of the window. Event &  EventReceived  )  - [inherited] + [inherited] @@ -577,6 +648,7 @@ Get the creation settings of the window.

Get the event on top of events stack, if any, and pop it.

+Get the event on top of events stack, if any.

Parameters:
@@ -584,341 +656,304 @@ Get the event on top of events stack, if any, and pop it.
Returns:
True if an event was returned, false if events stack was empty
+

Definition at line 218 of file Window.cpp.

+

- +

EventReceived : Event to fill, if any
- + - - + - +
void sf::Window::UseVerticalSync float sf::Window::GetFrameTime (bool  Enabled  )  [inherited] const [inherited]

-Enable / disable vertical synchronization. +Get time elapsed since last frame.

-

Parameters:
- - -
Enabled : True to enable v-sync, false to deactivate
-
+
Returns:
Time elapsed, in seconds
+ +

Definition at line 394 of file Window.cpp.

- +

- + - - + - +
void sf::Window::ShowMouseCursor unsigned int sf::RenderWindow::GetHeight (bool  Show  )  [inherited] const [virtual]

-Show or hide the mouse cursor. +Get the height of the rendering region of the window.

-

Parameters:
- - -
Show : True to show, false to hide
-
+
Returns:
Height in pixels
+ +

Implements sf::RenderTarget.

+ +

Definition at line 98 of file RenderWindow.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::Window::SetCursorPosition const Input & sf::Window::GetInput (unsigned int  Left,
unsigned int  Top 
) [inherited]  )  const [inherited]

-Change the position of the mouse cursor. +Get the input manager of the window.

-

Parameters:
- - - -
Left : Left coordinate of the cursor, relative to the window
Top : Top coordinate of the cursor, relative to the window
-
+
Returns:
Reference to the input
+ +

Definition at line 376 of file Window.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::Window::SetPosition const WindowSettings & sf::Window::GetSettings (int  Left,
int  Top 
) [inherited]  )  const [inherited]

-Change the position of the window on screen. +Get the creation settings of the window.

-Only works for top-level windows

-

Parameters:
- - - -
Left : Left position
Top : Top position
-
+
Returns:
Structure containing the creation settings
+ +

Definition at line 209 of file Window.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::Window::SetSize const View & sf::RenderTarget::GetView (unsigned int  Width,
unsigned int  Height 
) [inherited]  )  const [inherited]

-Change the size of the rendering region of the window. +Get the current view.

-

Parameters:
- - - -
Width : New width
Height : New height
-
+
Returns:
Current view active in the window
+ +

Definition at line 138 of file RenderTarget.cpp.

- +

- + - - + - +
void sf::Window::Show unsigned int sf::RenderWindow::GetWidth (bool  State  )  [inherited] const [virtual]

-Show or hide the window. +Get the width of the rendering region of the window.

-

Parameters:
- - -
State : True to show, false to hide
-
+
Returns:
Width in pixels
+ +

Implements sf::RenderTarget.

+ +

Definition at line 89 of file RenderWindow.cpp.

- +

- + - - + - +
void sf::Window::EnableKeyRepeat void sf::RenderTarget::Initialize (bool  Enabled  )  [inherited] [protected, inherited]

-Enable or disable automatic key-repeat. +Called by the derived class when it's ready to be initialized.

-Automatic key-repeat is enabled by default

-

Parameters:
- - -
Enabled : True to enable, false to disable
-
+ +

Definition at line 170 of file RenderTarget.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - + + +
void sf::Window::SetIcon bool sf::Window::IsOpened (unsigned int  Width,
unsigned int  Height,
const Uint8 *  Pixels 
) [inherited]  )  const [inherited]

-Change the window's icon. +Tell whether or not the window is opened (ie.

-

Parameters:
- - - - -
Width : Icon's width, in pixels
Height : Icon's height, in pixels
Pixels : Pointer to the pixels in memory, format must be RGBA 32 bits
-
+has been created). Note that a hidden window (Show(false)) will still return true

+

Returns:
True if the window is opened
+has been created). Note that a hidden window (Show(false)) will still return true +

Definition at line 182 of file Window.cpp.

- +

- + - + - +
bool sf::Window::SetActive void sf::RenderTarget::PreserveOpenGLStates ( bool  Active = true Preserve  )  const [inherited] [inherited]

-Activate of deactivate the window as the current target for rendering. +Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

+Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

+Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default

Parameters:
- +
Active : True to activate, false to deactivate (true by default)
Preserve : True to preserve OpenGL states, false to let SFML optimize
-
Returns:
True if operation was successful, false otherwise
+Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default +

Definition at line 161 of file RenderTarget.cpp.

- +

- + - + + - +
void sf::Window::Display bool sf::Window::SetActive ( bool  Active = true  )  [inherited] const [inherited]

-Display the window on screen. +Activate of deactivate the window as the current target for rendering.

+Activate of deactivate the window as the current target for rendering.

+

Parameters:
+ + +
Active : True to activate, false to deactivate (true by default)
+
+
Returns:
True if operation was successful, false otherwise
+ +

Definition at line 338 of file Window.cpp.

- +

- + - - - + + + + + + + + + + + + +
const Input& sf::Window::GetInput void sf::Window::SetCursorPosition (  )  const [inherited]unsigned int  Left,
unsigned int  Top 
) [inherited]

-Get the input manager of the window. +Change the position of the mouse cursor.

-

Returns:
Reference to the input
+
Parameters:
+ + + +
Left : Left coordinate of the cursor, relative to the window
Top : Top coordinate of the cursor, relative to the window
+
+ +

Definition at line 260 of file Window.cpp.

@@ -932,7 +967,7 @@ Get the input manager of the window. unsigned int  Limit  )  - [inherited] + [inherited] @@ -941,33 +976,60 @@ Get the input manager of the window.

Limit the framerate to a maximum fixed frequency.

+Set the framerate at a fixed frequency.

Parameters:
Limit : Framerate limit, in frames per seconds (use 0 to disable limit)
+

Definition at line 385 of file Window.cpp.

+

- +

- + - - - + + + + + + + + + + + + + + + + + + +
float sf::Window::GetFrameTime void sf::Window::SetIcon (  )  const [inherited]unsigned int  Width,
unsigned int  Height,
const Uint8 *  Pixels 
) [inherited]

-Get time elapsed since last frame. +Change the window's icon.

-

Returns:
Time elapsed, in seconds
+
Parameters:
+ + + + +
Width : Icon's width, in pixels
Height : Icon's height, in pixels
Pixels : Pointer to the pixels in memory, format must be RGBA 32 bits
+
+ +

Definition at line 327 of file Window.cpp.

@@ -981,7 +1043,7 @@ Get time elapsed since last frame. float  Threshold  )  - [inherited] + [inherited] @@ -993,64 +1055,91 @@ Change the joystick threshold, ie. the value below which no move event will be generated

Parameters:
- +
Threshold : New threshold, in range [0, 100]
Threshold : New threshold, in range [0, 100]
+the value below which no move event will be generated +

Definition at line 404 of file Window.cpp.

- +

- + - - - - + + + + + + + + + + + + +
void sf::RenderTarget::Clear void sf::Window::SetPosition (const Color &  FillColor = Color(0, 0, 0)  )  [inherited]int  Left,
int  Top 
) [inherited]

-Clear the entire target with a single color. +Change the position of the window on screen.

+Only works for top-level windows

Parameters:
- + +
FillColor : Color to use to clear the render target
Left : Left position
Top : Top position
+

Definition at line 276 of file Window.cpp.

+

- +

- + - - - - + + + + + + + + + + + + +
virtual void sf::RenderTarget::Draw void sf::Window::SetSize (const Drawable &  Object  )  [virtual, inherited]unsigned int  Width,
unsigned int  Height 
) [inherited]

-Draw something into the target. +Change the size of the rendering region of the window.

Parameters:
- + +
Object : Object to draw
Width : New width
Height : New height
+

Definition at line 293 of file Window.cpp.

+

@@ -1063,7 +1152,7 @@ Draw something into the target. const View &  NewView  )  - [inherited] + [inherited] @@ -1074,107 +1163,104 @@ Change the current active view.

Parameters:
- +
NewView : New view to use (pass GetDefaultView() to set the default view)
NewView : New view to use (pass GetDefaultView() to set the default view)
- -

- -

-
- - - - - - - - -
const View& sf::RenderTarget::GetView (  )  const [inherited]
-
-
- -

-Get the current view. -

-

Returns:
Current view active in the window
+

Definition at line 129 of file RenderTarget.cpp.

- +

- + - + + - +
View& sf::RenderTarget::GetDefaultView void sf::Window::Show ( bool  State  )  [inherited] [inherited]

-Get the default view of the window for read / write. +Show or hide the window.

-

Returns:
Default view
+
Parameters:
+ + +
State : True to show, false to hide
+
+ +

Definition at line 303 of file Window.cpp.

- +

- + - + - +
void sf::RenderTarget::PreserveOpenGLStates void sf::Window::ShowMouseCursor ( bool  Preserve Show  )  [inherited] [inherited]

-Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. +Show or hide the mouse cursor.

-Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default

Parameters:
- +
Preserve : True to preserve OpenGL states, false to let SFML optimize
Show : True to show, false to hide
+

Definition at line 250 of file Window.cpp.

+

- +

- + - + + - +
void sf::RenderTarget::Initialize void sf::Window::UseVerticalSync ( bool  Enabled  )  [protected, inherited] [inherited]

-Called by the derived class when it's ready to be initialized. +Enable / disable vertical synchronization.

+

Parameters:
+ + +
Enabled : True to enable v-sync, false to deactivate
+
+ +

Definition at line 240 of file Window.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Resource< T > Member List

This is the complete list of members for sf::Resource< T >, including all inherited members.

- + -
operator=(const Resource< T > &Other)sf::Resource< T > [protected]
Resource()sf::Resource< T > [protected]
Resource(const Resource< T > &Copy)sf::Resource< T > [protected]
ResourcePtr< T > classsf::Resource< T > [friend]
ResourcePtr< T > (defined in sf::Resource< T >)sf::Resource< T > [friend]
~Resource()sf::Resource< T > [protected]
+

+ - -
- + + -
- -
-
-sf::Resource
+

sf::Resource< T > Class Template Reference

Base class for every resource that needs to notify dependent classes about its destruction. More...

#include <Resource.hpp> +

+

List of all members. @@ -51,7 +56,7 @@ +class 
 Assignment operator.

Friends

-class ResourcePtr< T >
ResourcePtr< T >

Detailed Description

@@ -59,10 +64,8 @@ class 50 of file Resource.hpp.

Constructor & Destructor Documentation

+

Definition at line 50 of file Resource.hpp.

+

Constructor & Destructor Documentation

@@ -74,7 +77,7 @@ template<typename T>
(  )  - [protected] + [protected]
@@ -98,7 +101,7 @@ template<typename T>
const Resource< T > &  Copy  )  - [protected] + [protected]
@@ -126,7 +129,7 @@ template<typename T>
(  )  - [protected] + [protected] @@ -151,7 +154,7 @@ template<typename T> const Resource< T > &  Other  )  - [protected] + [protected] @@ -171,6 +174,7 @@ Assignment operator.

The documentation for this class was generated from the following file: + - -
- -
-
- + + +

sf::ResourcePtr< T > Member List

This is the complete list of members for sf::ResourcePtr< T >, including all inherited members.

- - - + + + -
OnResourceDestroyed()sf::ResourcePtr< T >
operator *() constsf::ResourcePtr< T >
operator const T *() constsf::ResourcePtr< T >
operator->() constsf::ResourcePtr< T >
operator const T *() const sf::ResourcePtr< T >
operator*() const sf::ResourcePtr< T >
operator->() const sf::ResourcePtr< T >
operator=(const ResourcePtr< T > &Other)sf::ResourcePtr< T >
operator=(const T *Resource)sf::ResourcePtr< T >
ResourcePtr()sf::ResourcePtr< T >
ResourcePtr(const T *Resource)sf::ResourcePtr< T >
ResourcePtr(const ResourcePtr< T > &Copy)sf::ResourcePtr< T >
~ResourcePtr()sf::ResourcePtr< T >
+

+ - -
- + + -
- -
-
-sf::ResourcePtr
+

sf::ResourcePtr< T > Class Template Reference

Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed. More...

#include <Resource.hpp> +

+

List of all members. @@ -51,19 +56,19 @@ - + - + - - + + - - + + - + @@ -73,10 +78,8 @@ class sf::ResourcePtr< T > Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed. -

- -

-Definition at line 116 of file Resource.hpp.

Constructor & Destructor Documentation

+

Definition at line 116 of file Resource.hpp.

+

Constructor & Destructor Documentation

@@ -88,7 +91,7 @@ template<typename T>
- +
 Destructor.
ResourcePtr< T > & operator= (const ResourcePtr< T > &Other)
 Assignment operator from another ResourcePtr.
 Assignment operator from another ResourcePtr.
ResourcePtr< T > & operator= (const T *Resource)
 Assignment operator from a raw resource.
 operator const T * () const
 operator const T * () const
 Cast operator to implicitely convert the resource pointer to its raw pointer type.
const T & operator * () const
 Cast operator to implicitely convert the resource pointer to its raw pointer type.
const T & operator* () const
 Operator * overload to return a reference to the actual resource.
const T * operator-> () const
 Operator * overload to return a reference to the actual resource.
const T * operator-> () const
 Operator -> overload to return a pointer to the actual resource.
 Operator -> overload to return a pointer to the actual resource.
void OnResourceDestroyed ()
 Function called when the observed resource is about to be destroyed.
(  ) 

@@ -112,7 +115,7 @@ template<typename T>
const T *  Resource  )  - +
@@ -141,7 +144,7 @@ template<typename T> const ResourcePtr< T > &  Copy  )  - + @@ -169,7 +172,7 @@ template<typename T> (  )  - + @@ -182,164 +185,165 @@ Destructor.

Member Function Documentation

- +
template<typename T>
- + - - + - +
ResourcePtr<T>& sf::ResourcePtr< T >::operator= void sf::ResourcePtr< T >::OnResourceDestroyed (const ResourcePtr< T > &  Other  ) 

-Assignment operator from another ResourcePtr. +Function called when the observed resource is about to be destroyed.

-

Parameters:
- - -
Other : Resource pointer to assign
-
-
Returns:
Reference to this

- +

template<typename T>
- + - - + - +
ResourcePtr<T>& sf::ResourcePtr< T >::operator= sf::ResourcePtr< T >::operator const T * (const T *  Resource  )  const

-Assignment operator from a raw resource. +Cast operator to implicitely convert the resource pointer to its raw pointer type.

-

Parameters:
- - -
Resource : Resource to assign
-
-
Returns:
Reference to this
+This might be dangerous in the general case, but in this context it is safe enough to define this operator

+

Returns:
Pointer to the actual resource

- +

template<typename T>
- + - +
sf::ResourcePtr< T >::operator const T * const T& sf::ResourcePtr< T >::operator* (  )  const const

-Cast operator to implicitely convert the resource pointer to its raw pointer type. +Operator * overload to return a reference to the actual resource.

-This might be dangerous in the general case, but in this context it is safe enough to define this operator

-

Returns:
Pointer to the actual resource
+
Returns:
Reference to the internal resource

- +

template<typename T>
- + - +
const T& sf::ResourcePtr< T >::operator * const T* sf::ResourcePtr< T >::operator-> (  )  const const

-Operator * overload to return a reference to the actual resource. +Operator -> overload to return a pointer to the actual resource.

-

Returns:
Reference to the internal resource
+
Returns:
Pointer to the internal resource

- +

template<typename T>
- + - + + - +
const T* sf::ResourcePtr< T >::operator-> ResourcePtr<T>& sf::ResourcePtr< T >::operator= ( const T *  Resource  )  const

-Operator -> overload to return a pointer to the actual resource. +Assignment operator from a raw resource.

-

Returns:
Pointer to the internal resource
+
Parameters:
+ + +
Resource : Resource to assign
+
+
Returns:
Reference to this

- +

template<typename T>
- + - + + - +
void sf::ResourcePtr< T >::OnResourceDestroyed ResourcePtr<T>& sf::ResourcePtr< T >::operator= ( const ResourcePtr< T > &  Other  ) 

-Function called when the observed resource is about to be destroyed. +Assignment operator from another ResourcePtr.

+

Parameters:
+ + +
Other : Resource pointer to assign
+
+
Returns:
Reference to this

The documentation for this class was generated from the following file: + - -
- -
-
- + + +

sf::Selector< Type > Member List

This is the complete list of members for sf::Selector< Type >, including all inherited members.

@@ -36,7 +39,8 @@ -
Add(Type Socket)sf::Selector< Type >
sf::SelectorBase::Add(SocketHelper::SocketType Socket)sf::SelectorBase [private]
sf::SelectorBase::Remove(SocketHelper::SocketType Socket)sf::SelectorBase [private]
SelectorBase()sf::SelectorBase [private]
Wait(float Timeout=0.f)sf::Selector< Type >
+

+ - -
- + + -
- -
-
-sf::Selector
+

sf::Selector< Type > Class Template Reference

Selector allow reading from multiple sockets without blocking. More...

#include <Selector.hpp>

-

Inheritance diagram for sf::Selector< Type >: +

+Inheritance diagram for sf::Selector< Type >:
+
+

sf::SelectorBase +
+ +

List of all members. @@ -57,6 +66,13 @@ + + + + + + +

Public Member Functions

Type GetSocketReady (unsigned int Index)
 After a call to Wait(), get the Index-th socket which is ready for reading.

Private Member Functions

void Add (SocketHelper::SocketType Socket)
 Add a socket to watch.
void Remove (SocketHelper::SocketType Socket)
 Remove a socket.

Detailed Description

template<typename Type>
@@ -65,15 +81,13 @@ Selector allow reading from multiple sockets without blocking.

It's a kind of multiplexer -

- -

-Definition at line 44 of file Selector.hpp.

Member Function Documentation

+

Definition at line 44 of file Selector.hpp.

+

Member Function Documentation

-template<typename Type>
+template<typename Type >
@@ -81,7 +95,7 @@ template<typename Type> - +
void sf::Selector< Type >::Add Type  Socket  ) 
@@ -92,134 +106,135 @@ Add a socket to watch.

Parameters:
- +
Socket : Socket to add
Socket : Socket to add

- +

-template<typename Type>
+template<typename Type >
- + - - + - +
void sf::Selector< Type >::Remove void sf::Selector< Type >::Clear (Type  Socket  ) 

-Remove a socket. +Remove all sockets.

-

Parameters:
- - -
Socket : Socket to remove
-
+ +

Reimplemented from sf::SelectorBase.

- +

-template<typename Type>
+template<typename Type >
- + - + + - +
void sf::Selector< Type >::Clear Type sf::Selector< Type >::GetSocketReady ( unsigned int  Index  ) 

-Remove all sockets. +After a call to Wait(), get the Index-th socket which is ready for reading.

+The total number of sockets ready is the integer returned by the previous call to Wait()

+

Parameters:
+ + +
Index : Index of the socket to get
+
+
Returns:
The Index-th socket
+ +

Reimplemented from sf::SelectorBase.

-

-Reimplemented from sf::SelectorBase.

- +

-template<typename Type>
+template<typename Type >
- + - - + + - +
unsigned int sf::Selector< Type >::Wait void sf::Selector< Type >::Remove (float  Timeout = 0.f Type  Socket  ) 

-Wait and collect sockets which are ready for reading. +Remove a socket.

-This functions will return either when at least one socket is ready, or when the given time is out

Parameters:
- +
Timeout : Timeout, in seconds (0 by default : no timeout)
Socket : Socket to remove
-
Returns:
Number of sockets ready to be read
-

-Reimplemented from sf::SelectorBase.

- +

-template<typename Type>
+template<typename Type >
- + - - + + - +
Type sf::Selector< Type >::GetSocketReady unsigned int sf::Selector< Type >::Wait (unsigned int  Index float  Timeout = 0.f  ) 

-After a call to Wait(), get the Index-th socket which is ready for reading. +Wait and collect sockets which are ready for reading.

-The total number of sockets ready is the integer returned by the previous call to Wait()

+This functions will return either when at least one socket is ready, or when the given time is out

Parameters:
- +
Index : Index of the socket to get
Timeout : Timeout, in seconds (0 by default : no timeout)
-
Returns:
The Index-th socket
+
Returns:
Number of sockets ready to be read
+ +

Reimplemented from sf::SelectorBase.

-

-Reimplemented from sf::SelectorBase.

The documentation for this class was generated from the following file: + - -
- -
-
- + + +

sf::SelectorBase Member List

This is the complete list of members for sf::SelectorBase, including all inherited members.

@@ -34,7 +37,8 @@ -
Add(SocketHelper::SocketType Socket)sf::SelectorBase
Clear()sf::SelectorBase
Remove(SocketHelper::SocketType Socket)sf::SelectorBase
SelectorBase()sf::SelectorBase
Wait(float Timeout=0.f)sf::SelectorBase
+

+ - -
- + + -
- -
-
-sf::SelectorBase
+

sf::SelectorBase Class Reference

Private base class for selectors. More...

#include <SelectorBase.hpp>

-

Inheritance diagram for sf::SelectorBase: +

+Inheritance diagram for sf::SelectorBase:
+
+

sf::Selector< Type > +
+ +

List of all members. - + - + @@ -57,7 +66,7 @@ - +

Public Member Functions

 SelectorBase ()
 Default constructor.
void Add (SocketHelper::SocketType Socket)
void Add (SocketHelper::SocketType Socket)
 Add a socket to watch.
void Remove (SocketHelper::SocketType Socket)
void Remove (SocketHelper::SocketType Socket)
 Remove a socket.
void Clear ()
unsigned int Wait (float Timeout=0.f)
 Wait and collect sockets which are ready for reading.
SocketHelper::SocketType GetSocketReady (unsigned int Index)
SocketHelper::SocketType GetSocketReady (unsigned int Index)
 After a call to Wait(), get the Index-th socket which is ready for reading.
@@ -65,10 +74,8 @@ Private base class for selectors.

As Selector is a template class, this base is needed so that every system call get compiled in SFML (not inlined) -

- -

-Definition at line 43 of file SelectorBase.hpp.

Constructor & Destructor Documentation

+

Definition at line 43 of file SelectorBase.hpp.

+

Constructor & Destructor Documentation

@@ -78,7 +85,7 @@ Definition at line 43(  )  - +
@@ -88,6 +95,8 @@ Definition at line 43 +

Definition at line 40 of file SelectorBase.cpp.

+

Member Function Documentation

@@ -98,10 +107,10 @@ Default constructor. void sf::SelectorBase::Add ( - SocketHelper::SocketType  + SocketHelper::SocketType  Socket  )  - +
@@ -112,126 +121,138 @@ Add a socket to watch.

Parameters:
- +
Socket : Socket to add
Socket : Socket to add
+

Definition at line 50 of file SelectorBase.cpp.

+

- +

- + - - + - +
void sf::SelectorBase::Remove void sf::SelectorBase::Clear (SocketHelper::SocketType  Socket  ) 

-Remove a socket. +Remove all sockets.

-

Parameters:
- - -
Socket : Socket to remove
-
+ +

Reimplemented in sf::Selector< Type >.

+ +

Definition at line 72 of file SelectorBase.cpp.

- +

- + - + + - +
void sf::SelectorBase::Clear SocketHelper::SocketType sf::SelectorBase::GetSocketReady ( unsigned int  Index  ) 

-Remove all sockets. +After a call to Wait(), get the Index-th socket which is ready for reading.

+After a call to Wait(), get the Index-th socket which is ready for reading.

+The total number of sockets ready is the integer returned by the previous call to Wait()

+

Parameters:
+ + +
Index : Index of the socket to get
+
+
Returns:
The Index-th socket
+The total number of sockets ready is the integer returned by the previous call to Wait() +

Reimplemented in sf::Selector< Type >.

+ +

Definition at line 108 of file SelectorBase.cpp.

-

-Reimplemented in sf::Selector< Type >.

- +

- + - - + + - +
unsigned int sf::SelectorBase::Wait void sf::SelectorBase::Remove (float  Timeout = 0.f SocketHelper::SocketType  Socket  ) 

-Wait and collect sockets which are ready for reading. +Remove a socket.

-This functions will return either when at least one socket is ready, or when the given time is out

Parameters:
- +
Timeout : Timeout, in seconds (0 by default : no timeout)
Socket : Socket to remove
-
Returns:
Number of sockets ready to be read
-

-Reimplemented in sf::Selector< Type >. +

Definition at line 63 of file SelectorBase.cpp.

+

- +

- + - - + + - +
SocketHelper::SocketType sf::SelectorBase::GetSocketReady unsigned int sf::SelectorBase::Wait (unsigned int  Index float  Timeout = 0.f  ) 

-After a call to Wait(), get the Index-th socket which is ready for reading. +Wait and collect sockets which are ready for reading.

-The total number of sockets ready is the integer returned by the previous call to Wait()

+This functions will return either when at least one socket is ready, or when the given time is out

Parameters:
- +
Index : Index of the socket to get
Timeout : Timeout, in seconds (0 by default : no timeout)
-
Returns:
The Index-th socket
+
Returns:
Number of sockets ready to be read
+This functions will return either when at least one socket is ready, or when the given time is out +

Reimplemented in sf::Selector< Type >.

+ +

Definition at line 86 of file SelectorBase.cpp.

-

-Reimplemented in sf::Selector< Type >.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Shape Member List

This is the complete list of members for sf::Shape, including all inherited members.

- - + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + - - - + + + @@ -79,8 +82,9 @@ - -
AddPoint(float X, float Y, const Color &Col=Color(255, 255, 255), const Color &OutlineCol=Color(0, 0, 0))sf::Shape
AddPoint(const Vector2f &Position, const Color &Col=Color(255, 255, 255), const Color &OutlineCol=Color(0, 0, 0))sf::Shape
Circle(float X, float Y, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Circle(const Vector2f &Center, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Circle(float X, float Y, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Circle(const Vector2f &Center, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Drawable(const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))sf::Drawable
EnableFill(bool Enable)sf::Shape
EnableOutline(bool Enable)sf::Shape
GetBlendMode() constsf::Drawable
GetCenter() constsf::Drawable
GetColor() constsf::Drawable
GetInverseMatrix() constsf::Drawable [protected]
GetMatrix() constsf::Drawable [protected]
GetNbPoints() constsf::Shape
GetOutlineWidth() constsf::Shape
GetPointColor(unsigned int Index) const sf::Shape
GetPointOutlineColor(unsigned int Index) const sf::Shape
GetPointPosition(unsigned int Index) const sf::Shape
GetPosition() constsf::Drawable
GetRotation() constsf::Drawable
GetScale() constsf::Drawable
Line(float P1X, float P1Y, float P2X, float P2Y, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Line(const Vector2f &P1, const Vector2f &P2, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
GetBlendMode() const sf::Drawable
GetCenter() const sf::Drawable
GetColor() const sf::Drawable
GetInverseMatrix() const sf::Drawable [protected]
GetMatrix() const sf::Drawable [protected]
GetNbPoints() const sf::Shape
GetOutlineWidth() const sf::Shape
GetPointColor(unsigned int Index) const sf::Shape
GetPointOutlineColor(unsigned int Index) const sf::Shape
GetPointPosition(unsigned int Index) const sf::Shape
GetPosition() const sf::Drawable
GetRotation() const sf::Drawable
GetScale() const sf::Drawable
Line(float P1X, float P1Y, float P2X, float P2Y, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Line(const Vector2f &P1, const Vector2f &P2, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Move(float OffsetX, float OffsetY)sf::Drawable
Move(const Vector2f &Offset)sf::Drawable
Rectangle(float P1X, float P1Y, float P2X, float P2Y, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Rectangle(const Vector2f &P1, const Vector2f &P2, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Render(RenderTarget &Target) const sf::Shape [protected, virtual]
Rectangle(float P1X, float P1Y, float P2X, float P2Y, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Rectangle(const Vector2f &P1, const Vector2f &P2, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))sf::Shape [static]
Render(RenderTarget &Target) const sf::Shape [protected, virtual]
Rotate(float Angle)sf::Drawable
Scale(float FactorX, float FactorY)sf::Drawable
Scale(const Vector2f &Factor)sf::Drawable
Shape()sf::Shape
TransformToGlobal(const sf::Vector2f &Point) const sf::Drawable
TransformToLocal(const sf::Vector2f &Point) const sf::Drawable
~Drawable()sf::Drawable [virtual]
+ ~Drawable()sf::Drawable [virtual] +

+ - -
- -
-
- -
-
-sf::Shape
+ + +

sf::Shape Class Reference

Shape defines a drawable convex shape ; it also defines helper functions to draw simple shapes like lines, rectangles, circles, etc. More...

#include <Shape.hpp>

-

Inheritance diagram for sf::Shape: +

+Inheritance diagram for sf::Shape:
+
+

sf::Drawable +
+ +

List of all members. + + + + @@ -51,9 +64,9 @@ - + - + @@ -75,18 +88,18 @@ - + - - + + - - + + - - + + - + @@ -126,24 +139,24 @@ - + - - + + - - + + - - + + - - + + - - + + - + @@ -166,45 +179,39 @@ - + - - + + - - + + - - + + - - + + - - + + - + - + - - + + - - + + - - - - - +

Classes

struct  Point
 Defines a simple 2D point.

Public Member Functions

 Shape ()
void AddPoint (const Vector2f &Position, const Color &Col=Color(255, 255, 255), const Color &OutlineCol=Color(0, 0, 0))
 Add a point to the shape.
unsigned int GetNbPoints () const
unsigned int GetNbPoints () const
 Get the number of points composing the shape.
 Get the number of points composing the shape.
void EnableFill (bool Enable)
 Enable or disable filling the shape.
void SetOutlineWidth (float Width)
 Change the width of the shape outline.
const Vector2f & GetPointPosition (unsigned int Index) const
const Vector2f & GetPointPosition (unsigned int Index) const
 Get the position of a point.
const Color & GetPointColor (unsigned int Index) const
 Get the position of a point.
const Color & GetPointColor (unsigned int Index) const
 Get the color of a point.
const Color & GetPointOutlineColor (unsigned int Index) const
 Get the color of a point.
const Color & GetPointOutlineColor (unsigned int Index) const
 Get the outline color of a point.
float GetOutlineWidth () const
 Get the outline color of a point.
float GetOutlineWidth () const
 Get the width of the shape outline.
 Get the width of the shape outline.
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values).
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
const Vector2f & GetPosition () const
const Vector2f & GetPosition () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values).
 Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Static Public Member Functions

static Shape Line (float P1X, float P1Y, float P2X, float P2Y, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
static Shape Line (float P1X, float P1Y, float P2X, float P2Y, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single line (use floats).
static Shape Line (const Vector2f &P1, const Vector2f &P2, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single line (use floats).
static Shape Line (const Vector2f &P1, const Vector2f &P2, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single line (use vectors).
static Shape Rectangle (float P1X, float P1Y, float P2X, float P2Y, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single line (use vectors).
static Shape Rectangle (float P1X, float P1Y, float P2X, float P2Y, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single rectangle (use floats).
static Shape Rectangle (const Vector2f &P1, const Vector2f &P2, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single rectangle (use floats).
static Shape Rectangle (const Vector2f &P1, const Vector2f &P2, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single rectangle (use vectors).
static Shape Circle (float X, float Y, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single rectangle (use vectors).
static Shape Circle (float X, float Y, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single circle (use floats).
static Shape Circle (const Vector2f &Center, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single circle (use floats).
static Shape Circle (const Vector2f &Center, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single circle (use vectors).
 Create a shape made of a single circle (use vectors).

Protected Member Functions

virtual void Render (RenderTarget &Target) const
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the inverse transform matrix of the drawable.

Classes

struct  Point
 Defines a simple 2D point.
 Get the inverse transform matrix of the drawable.

Detailed Description

Shape defines a drawable convex shape ; it also defines helper functions to draw simple shapes like lines, rectangles, circles, etc. -

- -

-Definition at line 43 of file Shape.hpp.

Constructor & Destructor Documentation

+

Definition at line 43 of file Shape.hpp.

+

Constructor & Destructor Documentation

@@ -214,7 +221,7 @@ Definition at line 43 of f (  )  - +
@@ -224,9 +231,57 @@ Definition at line 43 of f Default constructor.

+

Definition at line 38 of file Shape.cpp.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void sf::Shape::AddPoint (const Vector2f &  Position,
const Color &  Col = Color(255, 255, 255),
const Color &  OutlineCol = Color(0, 0, 0) 
)
+
+
+ +

+Add a point to the shape. +

+

Parameters:
+ + + + +
Position : Position of the point
Col : Color of the point (white by default)
OutlineCol : Outline color of the point (black by default)
+
+ +

Definition at line 61 of file Shape.cpp.

+ +
+

@@ -258,7 +313,7 @@ Default constructor. ) - +
@@ -275,76 +330,135 @@ Add a point to the shape.
+

Definition at line 52 of file Shape.cpp.

+

- +

- + - + + + + + + + - + + + + + + + - + - +
void sf::Shape::AddPoint Shape sf::Shape::Circle ( const Vector2f &  Position, Center,
float  Radius,
const Color &  Col = Color(255, 255, 255), Col,
float  Outline = 0.f,
const Color &  OutlineCol = Color(0, 0, 0)  OutlineCol = sf::Color(0, 0, 0) 
) [static]

-Add a point to the shape. +Create a shape made of a single circle (use vectors).

Parameters:
- - - + + + + +
Position : Position of the point
Col : Color of the point (white by default)
OutlineCol : Outline color of the point (black by default)
Center : Position of the center
Radius : Radius
Col : Color used to fill the circle
Outline : Outline width (0 by default)
OutlineCol : Color used to draw the outline (black by default)
+

Definition at line 276 of file Shape.cpp.

+

- +

- + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
unsigned int sf::Shape::GetNbPoints Shape sf::Shape::Circle (  )  constfloat  X,
float  Y,
float  Radius,
const Color &  Col,
float  Outline = 0.f,
const Color &  OutlineCol = sf::Color(0, 0, 0) 
) [static]

-Get the number of points composing the shape. +Create a shape made of a single circle (use floats).

+Create a shape made of a single circle.

Parameters:
- + + + + +
Total number of points
X,Y : Position of the center
Radius : Radius
Col : Color used to fill the circle
Outline : Outline width (0 by default)
OutlineCol : Color used to draw the outline (black by default)
+

Definition at line 250 of file Shape.cpp.

+

@@ -357,7 +471,7 @@ Get the number of points composing the shape. bool  Enable  )  - + @@ -369,9 +483,11 @@ Enable or disable filling the shape. Fill is enabled by default

Parameters:
- +
Enable : True to enable, false to disable
Enable : True to enable, false to disable
+Fill is enabled by default +

Definition at line 81 of file Shape.cpp.

@@ -385,7 +501,7 @@ Fill is enabled by default

bool  Enable  )  - + @@ -397,327 +513,364 @@ Enable or disable drawing the shape outline. Outline is enabled by default

Parameters:
- +
Enable : True to enable, false to disable
Enable : True to enable, false to disable
+Outline is enabled by default +

Definition at line 91 of file Shape.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::Shape::SetPointPosition Blend::Mode sf::Drawable::GetBlendMode (unsigned int  Index,
const Vector2f &  Position 
)  )  const [inherited]

-Set the position of a point. +Get the current blending mode.

-

Parameters:
- - - -
Index : Index of the point, in range [0, GetNbPoints() - 1]
Position : New position of the Index-th point
-
+
Returns:
Current blending mode
+ +

Definition at line 258 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - + + +
void sf::Shape::SetPointPosition const Vector2f & sf::Drawable::GetCenter (unsigned int  Index,
float  X,
float  Y 
)  )  const [inherited]

-Set the position of a point. +Get the center of the object.

-

Parameters:
- - - - -
Index : Index of the point, in range [0, GetNbPoints() - 1]
X : New X coordinate of the Index-th point
Y : New Y coordinate of the Index-th point
-
+
Returns:
Current position of the center
+ +

Definition at line 231 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::Shape::SetPointColor const Color & sf::Drawable::GetColor (unsigned int  Index,
const Color &  Col 
)  )  const [inherited]

-Set the color of a point. +Get the color of the object.

-

Parameters:
- - - -
Index : Index of the point, in range [0, GetNbPoints() - 1]
Col : New color of the Index-th point
-
+
Returns:
Current color
+ +

Definition at line 249 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - - + + +
void sf::Shape::SetPointOutlineColor const Matrix3 & sf::Drawable::GetInverseMatrix (unsigned int  Index,
const Color &  OutlineCol 
)  )  const [protected, inherited]

-Set the outline color of a point. +Get the inverse transform matrix of the drawable.

-

Parameters:
- - - -
Index : Index of the point, in range [0, GetNbPoints() - 1]
OutlineCol : New outline color of the Index-th point
-
+
Returns:
Inverse transform matrix
+ +

Definition at line 350 of file Drawable.cpp.

- +

- + - - + - +
void sf::Shape::SetOutlineWidth const Matrix3 & sf::Drawable::GetMatrix (float  Width  )  const [protected, inherited]

-Change the width of the shape outline. +Get the transform matrix of the drawable. +

+

Returns:
Transform matrix
+ +

Definition at line 334 of file Drawable.cpp.

+ +
+

+ +

+
+ + + + + + + + +
unsigned int sf::Shape::GetNbPoints (  )  const
+
+
+ +

+Get the number of points composing the shape.

Parameters:
- +
Width : New width
Total number of points
+

Definition at line 71 of file Shape.cpp.

+ +
+

+ +

+
+ + + + + + + + +
float sf::Shape::GetOutlineWidth (  )  const
+
+
+ +

+Get the width of the shape outline. +

+

Returns:
Current outline width
+ +

Definition at line 175 of file Shape.cpp.

+

- +

- + - +
const Vector2f& sf::Shape::GetPointPosition const Color & sf::Shape::GetPointColor ( unsigned int  Index  )  const const

-Get the position of a point. +Get the color of a point.

Parameters:
- +
Index : Index of the point, in range [0, GetNbPoints() - 1]
Index : Index of the point, in range [0, GetNbPoints() - 1]
-
Returns:
Position of the Index-th point
+
Returns:
Color of the Index-th point
+ +

Definition at line 157 of file Shape.cpp.

- +

- + - +
const Color& sf::Shape::GetPointColor const Color & sf::Shape::GetPointOutlineColor ( unsigned int  Index  )  const const

-Get the color of a point. +Get the outline color of a point.

Parameters:
- +
Index : Index of the point, in range [0, GetNbPoints() - 1]
Index : Index of the point, in range [0, GetNbPoints() - 1]
-
Returns:
Color of the Index-th point
+
Returns:
Outline color of the Index-th point
+ +

Definition at line 166 of file Shape.cpp.

- +

- + - +
const Color& sf::Shape::GetPointOutlineColor const Vector2f & sf::Shape::GetPointPosition ( unsigned int  Index  )  const const

-Get the outline color of a point. +Get the position of a point.

Parameters:
- +
Index : Index of the point, in range [0, GetNbPoints() - 1]
Index : Index of the point, in range [0, GetNbPoints() - 1]
-
Returns:
Outline color of the Index-th point
+
Returns:
Position of the Index-th point
+ +

Definition at line 148 of file Shape.cpp.

- +

- + - +
float sf::Shape::GetOutlineWidth const Vector2f & sf::Drawable::GetPosition (  )  const const [inherited]

-Get the width of the shape outline. +Get the position of the object.

-

Returns:
Current outline width
+
Returns:
Current position
+ +

Definition at line 213 of file Drawable.cpp.

- +

- + - - + + + +
static Shape sf::Shape::Line float sf::Drawable::GetRotation (float  P1X,  )  const [inherited]
+
+
+ +

+Get the orientation of the object. +

+Rotation is always in the range [0, 360]

+

Returns:
Current rotation, in degrees
+ +

Definition at line 240 of file Drawable.cpp.

+ +
+

+ +

+
+ - - - - + + + + + +
float  P1Y, const Vector2f & sf::Drawable::GetScale (  )  const [inherited]
+
+
+ +

+Get the current scale of the object. +

+

Returns:
Current scale factor (always positive)
+ +

Definition at line 222 of file Drawable.cpp.

+ +
+

+ +

+
+ - - - - + + + + - - + + @@ -746,14 +899,14 @@ Get the width of the shape outline. - +
float  P2X, Shape sf::Shape::Line (const Vector2f &  P1,
float  P2Y, const Vector2f &  P2,
) [static] [static]

-Create a shape made of a single line (use floats). +Create a shape made of a single line (use vectors).

Parameters:
@@ -766,23 +919,37 @@ Create a shape made of a single line (use floats).
+

Definition at line 212 of file Shape.cpp.

+

- +

- + - - + + - - + + + + + + + + + + + + + + @@ -811,15 +978,16 @@ Create a shape made of a single line (use floats). - +
static Shape sf::Shape::Line Shape sf::Shape::Line (const Vector2f &  P1, float  P1X,
const Vector2f &  P2, float  P1Y,
float  P2X,
float  P2Y,
) [static] [static]

-Create a shape made of a single line (use vectors). +Create a shape made of a single line (use floats).

+Create a shape made of a single line.

Parameters:
@@ -831,84 +999,84 @@ Create a shape made of a single line (use vectors).
P1X,P1Y : Position of the first point
+

Definition at line 184 of file Shape.cpp.

+

- +

- + - - - - - - - - - - - - - - + + + + +
static Shape sf::Shape::Rectangle void sf::Drawable::Move (float  P1X,
float  P1Y,
float  P2X, const Vector2f &  Offset  )  [inherited]
+
+
+ +

+Move the object of a given offset (take a 2D vector). +

+

Parameters:
+ + +
Offset : Amount of units to move the object of
+
+ +

Definition at line 278 of file Drawable.cpp.

+ +
+

+ +

+
+ - - + + - - - - - - - + - - - - - - - + - +
void sf::Drawable::Move ( float  P2Y,
const Color &  Col, OffsetX,
float  Outline = 0.f,
const Color &  OutlineCol = sf::Color(0, 0, 0)  OffsetY 
) [static] [inherited]

-Create a shape made of a single rectangle (use floats). +Move the object of a given offset (take 2 values).

Parameters:
- - - - - + +
P1X,P1Y : Position of the first point
P2X,P2Y : Position second point
Col : Color used to fill the rectangle
Outline : Outline width (0 by default)
OutlineCol : Color used to draw the outline (black by default)
OffsetX : X offset
OffsetY : Y offset
+

Definition at line 268 of file Drawable.cpp.

+

- +

- + @@ -940,7 +1108,7 @@ Create a shape made of a single rectangle (use floats). - +
static Shape sf::Shape::Rectangle Shape sf::Shape::Rectangle ( const Vector2f &  P1,
) [static] [static]
@@ -959,29 +1127,37 @@ Create a shape made of a single rectangle (use vectors). +

Definition at line 241 of file Shape.cpp.

+

- +

- + - + - + - + + + + + + + @@ -1004,96 +1180,41 @@ Create a shape made of a single rectangle (use vectors). - +
static Shape sf::Shape::Circle Shape sf::Shape::Rectangle ( float  X, P1X,
float  Y, P1Y,
float  Radius, P2X,
float  P2Y,
) [static] [static]

-Create a shape made of a single circle (use floats). +Create a shape made of a single rectangle (use floats).

+Create a shape made of a single rectangle.

Parameters:
- - - + + +
X,Y : Position of the center
Radius : Radius
Col : Color used to fill the circle
P1X,P1Y : Position of the first point
P2X,P2Y : Position second point
Col : Color used to fill the rectangle
Outline : Outline width (0 by default)
OutlineCol : Color used to draw the outline (black by default)
+

Definition at line 221 of file Shape.cpp.

+

- +

- + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
static Shape sf::Shape::Circle void sf::Shape::Render (const Vector2f &  Center,
float  Radius,
const Color &  Col,
float  Outline = 0.f,
const Color &  OutlineCol = sf::Color(0, 0, 0) 
) [static]
-
-
- -

-Create a shape made of a single circle (use vectors). -

-

Parameters:
- - - - - - -
Center : Position of the center
Radius : Radius
Col : Color used to fill the circle
Outline : Outline width (0 by default)
OutlineCol : Color used to draw the outline (black by default)
-
- -
-

- -

-
- - - - - - - - + + + +
virtual void sf::Shape::Render (RenderTarget &  Target  )  const [protected, virtual]RenderTarget &  Target  )  const [protected, virtual]
@@ -1103,243 +1224,167 @@ Create a shape made of a single circle (use vectors). /see Drawable::Render

-

-Implements sf::Drawable. -

-

- -

-
- - - - - - - - - - - - - - - - - - -
void sf::Drawable::SetPosition (float  X,
float  Y 
) [inherited]
-
-
- -

-Set the position of the object (take 2 values). -

-

Parameters:
- - - -
X : New X coordinate
Y : New Y coordinate
-
- -
-

- -

-
- - - - - - - - - -
void sf::Drawable::SetPosition (const Vector2f &  Position  )  [inherited]
-
-
+

Implements sf::Drawable.

-

-Set the position of the object (take a 2D vector). -

-

Parameters:
- - -
Position : New position
-
+

Definition at line 285 of file Shape.cpp.

- +

- + - + - +
void sf::Drawable::SetX void sf::Drawable::Rotate ( float  X Angle  )  [inherited] [inherited]

-Set the X position of the object. +Rotate the object.

Parameters:
- +
X : New X coordinate
Angle : Angle of rotation, in degrees
+

Definition at line 306 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetY void sf::Drawable::Scale (float  Y const Vector2f &  Factor  )  [inherited] [inherited]

-Set the Y position of the object. +Scale the object (take a 2D vector).

Parameters:
- +
Y : New Y coordinate
Factor : Scaling factors (both values must be strictly positive)
+

Definition at line 297 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::SetScale void sf::Drawable::Scale ( float  ScaleX, FactorX,
float  ScaleY  FactorY 
) [inherited] [inherited]

-Set the scale of the object (take 2 values). +Scale the object (take 2 values).

Parameters:
- - + +
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
-
-

- -

-
- - - - - - - - - -
void sf::Drawable::SetScale (const Vector2f &  Scale  )  [inherited]
-
-
- -

-Set the scale of the object (take a 2D vector). -

-

Parameters:
- - -
Scale : New scale (both values must be strictly positive)
-
+

Definition at line 287 of file Drawable.cpp.

- +

- + - - + + - +
void sf::Drawable::SetScaleX void sf::Drawable::SetBlendMode (float  FactorX Blend::Mode  Mode  )  [inherited] [inherited]

-Set the X scale factor of the object. +Set the blending mode for the object.

+The default blend mode is Blend::Alpha

Parameters:
- +
X : New X scale factor
Mode : New blending mode
+The default blend mode is Blend::Alpha +

Definition at line 204 of file Drawable.cpp.

- +

- + - - + + - +
void sf::Drawable::SetScaleY void sf::Drawable::SetCenter (float  FactorY const Vector2f &  Center  )  [inherited] [inherited]

-Set the Y scale factor of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

+Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

+The default center is (0, 0)

Parameters:
- +
Y : New Y scale factor
Center : New center
+The default center is (0, 0) +

Definition at line 171 of file Drawable.cpp.

@@ -1362,7 +1407,7 @@ Set the Y scale factor of the object. ) - [inherited] + [inherited] @@ -1371,434 +1416,542 @@ Set the Y scale factor of the object.

Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

The default center is (0, 0)

Parameters:
- +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
CenterY : Y coordinate of the center
+The default center is (0, 0) +

Definition at line 157 of file Drawable.cpp.

- +

- + - - + + - +
void sf::Drawable::SetCenter void sf::Drawable::SetColor (const Vector2f &  Center const Color &  Col  )  [inherited] [inherited]

-Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector). +Set the color of the object.

-The default center is (0, 0)

+The default color is white

Parameters:
- +
Center : New center
Col : New color
+The default color is white +

Definition at line 194 of file Drawable.cpp.

- +

- + - + - +
void sf::Drawable::SetRotation void sf::Shape::SetOutlineWidth ( float  Rotation Width  )  [inherited]

-Set the orientation of the object. +Change the width of the shape outline.

Parameters:
- +
Rotation : Angle of rotation, in degrees
Width : New width
+

Definition at line 139 of file Shape.cpp.

+

- +

- + + + + + + + - - - + + + + + +
void sf::Drawable::SetColor void sf::Shape::SetPointColor (unsigned int  Index,
const Color &  Col  )  [inherited] Col 
)

-Set the color of the object. +Set the color of a point.

-The default color is white

Parameters:
- + +
Col : New color
Index : Index of the point, in range [0, GetNbPoints() - 1]
Col : New color of the Index-th point
+

Definition at line 119 of file Shape.cpp.

+

- +

- + - - - - + + + + + + + + + + + + +
void sf::Drawable::SetBlendMode void sf::Shape::SetPointOutlineColor (Blend::Mode  Mode  )  [inherited]unsigned int  Index,
const Color &  OutlineCol 
)

-Set the blending mode for the object. +Set the outline color of a point.

-The default blend mode is Blend::Alpha

Parameters:
- + +
Mode : New blending mode
Index : Index of the point, in range [0, GetNbPoints() - 1]
OutlineCol : New outline color of the Index-th point
+

Definition at line 129 of file Shape.cpp.

+

- +

- + - - - + + + + + + + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetPosition void sf::Shape::SetPointPosition (  )  const [inherited]unsigned int  Index,
float  X,
float  Y 
)

-Get the position of the object. +Set the position of a point.

-

Returns:
Current position
+
Parameters:
+ + + + +
Index : Index of the point, in range [0, GetNbPoints() - 1]
X : New X coordinate of the Index-th point
Y : New Y coordinate of the Index-th point
+
+ +

Definition at line 110 of file Shape.cpp.

- +

- + - - - + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetScale void sf::Shape::SetPointPosition (  )  const [inherited]unsigned int  Index,
const Vector2f &  Position 
)

-Get the current scale of the object. +Set the position of a point.

-

Returns:
Current scale factor (always positive)
+
Parameters:
+ + + +
Index : Index of the point, in range [0, GetNbPoints() - 1]
Position : New position of the Index-th point
+
+ +

Definition at line 100 of file Shape.cpp.

- +

- + - + + - +
const Vector2f& sf::Drawable::GetCenter void sf::Drawable::SetPosition ( const Vector2f &  Position  )  const [inherited] [inherited]

-Get the center of the object. +Set the position of the object (take a 2D vector).

-

Returns:
Current position of the center
+
Parameters:
+ + +
Position : New position
+
+ +

Definition at line 75 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + + +
float sf::Drawable::GetRotation void sf::Drawable::SetPosition (  )  const [inherited]float  X,
float  Y 
) [inherited]

-Get the orientation of the object. +Set the position of the object (take 2 values).

-Rotation is always in the range [0, 360]

-

Returns:
Current rotation, in degrees
+
Parameters:
+ + + +
X : New X coordinate
Y : New Y coordinate
+
+ +

Definition at line 65 of file Drawable.cpp.

- +

- + - + + - +
const Color& sf::Drawable::GetColor void sf::Drawable::SetRotation ( float  Rotation  )  const [inherited] [inherited]

-Get the color of the object. +Set the orientation of the object.

-

Returns:
Current color
+
Parameters:
+ + +
Rotation : Angle of rotation, in degrees
+
+ +

Definition at line 180 of file Drawable.cpp.

- +

- + - + + - +
Blend::Mode sf::Drawable::GetBlendMode void sf::Drawable::SetScale ( const Vector2f &  Scale  )  const [inherited] [inherited]

-Get the current blending mode. +Set the scale of the object (take a 2D vector).

-

Returns:
Current blending mode
+
Parameters:
+ + +
Scale : New scale (both values must be strictly positive)
+
+ +

Definition at line 117 of file Drawable.cpp.

- +

- + - + - + - +
void sf::Drawable::Move void sf::Drawable::SetScale ( float  OffsetX, ScaleX,
float  OffsetY  ScaleY 
) [inherited] [inherited]

-Move the object of a given offset (take 2 values). +Set the scale of the object (take 2 values).

Parameters:
- - + +
OffsetX : X offset
OffsetY : Y offset
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
+

Definition at line 107 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Move void sf::Drawable::SetScaleX (const Vector2f &  Offset float  FactorX  )  [inherited] [inherited]

-Move the object of a given offset (take a 2D vector). +Set the X scale factor of the object.

Parameters:
- +
Offset : Amount of units to move the object of
X : New X scale factor
+

Definition at line 127 of file Drawable.cpp.

+

- +

- + - - - - - - - - - - - - + + +
void sf::Drawable::Scale void sf::Drawable::SetScaleY ( float  FactorX,
float  FactorY 
) [inherited] FactorY  )  [inherited]

-Scale the object (take 2 values). +Set the Y scale factor of the object.

Parameters:
- - +
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
Y : New Y scale factor
+

Definition at line 141 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Scale void sf::Drawable::SetX (const Vector2f &  Factor float  X  )  [inherited] [inherited]

-Scale the object (take a 2D vector). +Set the X position of the object.

Parameters:
- +
Factor : Scaling factors (both values must be strictly positive)
X : New X coordinate
+

Definition at line 85 of file Drawable.cpp.

+

- +

- + - + - +
void sf::Drawable::Rotate void sf::Drawable::SetY ( float  Angle Y  )  [inherited] [inherited]

-Rotate the object. +Set the Y position of the object.

Parameters:
- +
Angle : Angle of rotation, in degrees
Y : New Y coordinate
+

Definition at line 96 of file Drawable.cpp.

+

- +

- + - +
sf::Vector2f sf::Drawable::TransformToLocal sf::Vector2f sf::Drawable::TransformToGlobal ( const sf::Vector2f &  Point  )  const [inherited] const [inherited]

-Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point). +Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

+Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Parameters:
@@ -1806,27 +1959,30 @@ Transform a point from global coordinates into local coordinates (ie it applies
Returns:
Transformed point
+

Definition at line 325 of file Drawable.cpp.

+

- +

Point : Point to transform
- + - +
sf::Vector2f sf::Drawable::TransformToGlobal sf::Vector2f sf::Drawable::TransformToLocal ( const sf::Vector2f &  Point  )  const [inherited] const [inherited]

-Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point). +Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

+Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

Parameters:
@@ -1834,54 +1990,13 @@ Transform a point from local coordinates into global coordinates (ie it applies
Returns:
Transformed point
- -

- -

-
-
Point : Point to transform
- - - - - - - -
const Matrix3& sf::Drawable::GetMatrix (  )  const [protected, inherited]
-
-
- -

-Get the transform matrix of the drawable. -

-

Returns:
Transform matrix
+

Definition at line 316 of file Drawable.cpp.

- -

-
- - - - - - - - -
const Matrix3& sf::Drawable::GetInverseMatrix (  )  const [protected, inherited]
-
-
- -

-Get the inverse transform matrix of the drawable. -

-

Returns:
Inverse transform matrix
- +
The documentation for this class was generated from the following files:
-

-

The documentation for this class was generated from the following file: - -
- -
-
- + + +

sf::SocketHelper Member List

This is the complete list of members for sf::SocketHelper, including all inherited members.

- - - - - - -
Close(SocketType Socket)sf::SocketHelper [static]
GetErrorStatus()sf::SocketHelper [static]
InvalidSocket()sf::SocketHelper [static]
LengthType typedefsf::SocketHelper
SetBlocking(SocketType Socket, bool Block)sf::SocketHelper [static]
SocketType typedefsf::SocketHelper
+ Close(SocketType Socket)sf::SocketHelper [static] + GetErrorStatus()sf::SocketHelper [static] + InvalidSocket()sf::SocketHelper [static] + LengthType typedef (defined in sf::SocketHelper)sf::SocketHelper + SetBlocking(SocketType Socket, bool Block)sf::SocketHelper [static] + SocketType typedef (defined in sf::SocketHelper)sf::SocketHelper +

+ - -
- + + -
- -
-
-sf::SocketHelper
+

sf::SocketHelper Class Reference

This class defines helper functions to do all the non-portable socket stuff. More...

#include <SocketHelper.hpp> +

+

List of all members. +typedef SOCKET  +typedef int  - + - - + + - - + + - - + + - +

Public Types

-typedef SOCKET SocketType
SocketType
-typedef int LengthType
LengthType

Static Public Member Functions

static SocketType InvalidSocket ()
static SocketType InvalidSocket ()
 Return the value of the invalid socket.
static bool Close (SocketType Socket)
 Return the value of the invalid socket.
static bool Close (SocketType Socket)
 Close / destroy a socket.
static void SetBlocking (SocketType Socket, bool Block)
 Close / destroy a socket.
static void SetBlocking (SocketType Socket, bool Block)
 Set a socket as blocking or non-blocking.
static Socket::Status GetErrorStatus ()
 Set a socket as blocking or non-blocking.
static Socket::Status GetErrorStatus ()
 Get the last socket error status.
 Get the last socket error status.

Detailed Description

This class defines helper functions to do all the non-portable socket stuff.

This class is meant for internal use only -

+

Definition at line 41 of file Win32/SocketHelper.hpp.

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
bool sf::SocketHelper::Close (SocketHelper::SocketType  Socket  )  [static]
+
+

-Definition at line 41 of file Win32/SocketHelper.hpp.

Member Function Documentation

- +Close / destroy a socket. +

+

Parameters:
+ + +
Socket : Socket to close
+
+
Returns:
True on success
+ +

Definition at line 45 of file SocketHelper.cpp.

+ +
+

+

- + - +
static SocketType sf::SocketHelper::InvalidSocket Socket::Status sf::SocketHelper::GetErrorStatus (  )  [static] [static]

-Return the value of the invalid socket. +Get the last socket error status.

-

Returns:
Unique value of the invalid socket
+
Returns:
Status corresponding to the last socket error
+ +

Definition at line 64 of file SocketHelper.cpp.

- +

- + - - + - +
static bool sf::SocketHelper::Close SocketHelper::SocketType sf::SocketHelper::InvalidSocket (SocketType  Socket  )  [static] [static]

-Close / destroy a socket. +Return the value of the invalid socket.

-

Parameters:
- - -
Socket : Socket to close
-
-
Returns:
True on success
+
Returns:
Unique value of the invalid socket
+ +

Definition at line 36 of file SocketHelper.cpp.

- +

- + - + @@ -134,7 +165,7 @@ Close / destroy a socket. - +
static void sf::SocketHelper::SetBlocking void sf::SocketHelper::SetBlocking (SocketType SocketHelper::SocketType  Socket,
) [static] [static]
@@ -145,37 +176,18 @@ Set a socket as blocking or non-blocking.

Parameters:
- +
Socket : Socket to modify
Socket : Socket to modify
Block : New blocking state of the socket
-
-

- -

-
- - - - - - - - -
static Socket::Status sf::SocketHelper::GetErrorStatus (  )  [static]
-
-
- -

-Get the last socket error status. -

-

Returns:
Status corresponding to the last socket error
+

Definition at line 54 of file SocketHelper.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: +
- -
- -
-
- + + +

sf::SocketTCP Member List

This is the complete list of members for sf::SocketTCP, including all inherited members.

- + - + -
Accept(SocketTCP &Connected, IPAddress *Address=NULL)sf::SocketTCP
Close()sf::SocketTCP
Connect(unsigned short Port, const IPAddress &HostAddress, float Timeout=0.f)sf::SocketTCP
IsValid() constsf::SocketTCP
IsValid() const sf::SocketTCP
Listen(unsigned short Port)sf::SocketTCP
operator!=(const SocketTCP &Other) const sf::SocketTCP
operator<(const SocketTCP &Other) const sf::SocketTCP
operator==(const SocketTCP &Other) const sf::SocketTCP
Receive(char *Data, std::size_t MaxSize, std::size_t &SizeReceived)sf::SocketTCP
Receive(Packet &PacketToReceive)sf::SocketTCP
Selector< SocketTCP > classsf::SocketTCP [friend]
Selector< SocketTCP > (defined in sf::SocketTCP)sf::SocketTCP [friend]
Send(const char *Data, std::size_t Size)sf::SocketTCP
Send(Packet &PacketToSend)sf::SocketTCP
SetBlocking(bool Blocking)sf::SocketTCP
SocketTCP()sf::SocketTCP
+

+ - -
- + + -
- -
-
-sf::SocketTCP
+

sf::SocketTCP Class Reference

SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower). More...

#include <SocketTCP.hpp> +

+

List of all members. @@ -43,33 +48,33 @@ - + - + - + - + - + - + - + - + @@ -81,15 +86,13 @@ +class 
void SetBlocking (bool Blocking)
 Change the blocking state of the socket.
Socket::Status Connect (unsigned short Port, const IPAddress &HostAddress, float Timeout=0.f)
Socket::Status Connect (unsigned short Port, const IPAddress &HostAddress, float Timeout=0.f)
 Connect to another computer on a specified port.
bool Listen (unsigned short Port)
 Listen to a specified port for incoming data or connections.
Socket::Status Accept (SocketTCP &Connected, IPAddress *Address=NULL)
Socket::Status Accept (SocketTCP &Connected, IPAddress *Address=NULL)
 Wait for a connection (must be listening to a port).
Socket::Status Send (const char *Data, std::size_t Size)
Socket::Status Send (const char *Data, std::size_t Size)
 Send an array of bytes to the host (must be connected first).
Socket::Status Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived)
Socket::Status Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived)
 Receive an array of bytes from the host (must be connected first).
Socket::Status Send (Packet &PacketToSend)
Socket::Status Send (Packet &PacketToSend)
 Send a packet of data to the host (must be connected first).
Socket::Status Receive (Packet &PacketToReceive)
Socket::Status Receive (Packet &PacketToReceive)
 Receive a packet from the host (must be connected first).
bool Close ()
 Close the socket.
bool IsValid () const
bool IsValid () const
 Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
 Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
bool operator== (const SocketTCP &Other) const
 Comparison operator ==.
 Comparison operator <.

Friends

-class Selector< SocketTCP >
Selector< SocketTCP >

Detailed Description

SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower). -

- -

-Definition at line 45 of file SocketTCP.hpp.

Constructor & Destructor Documentation

+

Definition at line 45 of file SocketTCP.hpp.

+

Constructor & Destructor Documentation

@@ -99,7 +102,7 @@ Definition at line 45 (  )  - +
@@ -109,34 +112,73 @@ Definition at line 45 Default constructor.

+

Definition at line 47 of file SocketTCP.cpp.

+

Member Function Documentation

- +
- + - - - - + + + + + + + + + + + + +
void sf::SocketTCP::SetBlocking Socket::Status sf::SocketTCP::Accept (bool  Blocking  ) SocketTCP &  Connected,
IPAddress *  Address = NULL 
)

-Change the blocking state of the socket. +Wait for a connection (must be listening to a port).

-The default behaviour of a socket is blocking

+This function will block if the socket is blocking

Parameters:
- + +
Blocking : Pass true to set the socket as blocking, or false for non-blocking
Connected : Socket containing the connection with the connected client
Address : Pointer to an address to fill with client infos (NULL by default)
+
Returns:
Status code
+This function will block if the socket is blocking +

Definition at line 195 of file SocketTCP.cpp.

+ +
+

+ +

+
+ + + + + + + + +
bool sf::SocketTCP::Close (  ) 
+
+
+ +

+Close the socket. +

+

Returns:
True if operation has been successful
+ +

Definition at line 386 of file SocketTCP.cpp.

@@ -145,7 +187,7 @@ The default behaviour of a socket is blocking

- + @@ -165,7 +207,7 @@ The default behaviour of a socket is blocking

- +
Socket::Status sf::SocketTCP::Connect Socket::Status sf::SocketTCP::Connect ( unsigned short  Port,
)
@@ -183,184 +225,153 @@ Connect to another computer on a specified port.
Returns:
True if operation has been successful
+

Definition at line 70 of file SocketTCP.cpp.

+

- +

- + - - + - +
bool sf::SocketTCP::Listen bool sf::SocketTCP::IsValid (unsigned short  Port  )  const

-Listen to a specified port for incoming data or connections. +Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

-

Parameters:
- - -
Port : Port to listen to
-
-
Returns:
True if operation has been successful
+Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

+

Returns:
True if the socket is valid
+ +

Definition at line 409 of file SocketTCP.cpp.

- +

- + - - - - - - - - - - + + + - -
Socket::Status sf::SocketTCP::Accept bool sf::SocketTCP::Listen (SocketTCP &  Connected,
IPAddress *  Address = NULL 
unsigned short  Port  )  )

-Wait for a connection (must be listening to a port). +Listen to a specified port for incoming data or connections.

-This function will block if the socket is blocking

Parameters:
- - +
Connected : Socket containing the connection with the connected client
Address : Pointer to an address to fill with client infos (NULL by default)
Port : Port to listen to
-
Returns:
Status code
+
Returns:
True if operation has been successful
+ +

Definition at line 158 of file SocketTCP.cpp.

- +

- + - - - - - - - - - - - - - + + + +
Socket::Status sf::SocketTCP::Send bool sf::SocketTCP::operator!= (const char *  Data,
std::size_t  Size 
)const SocketTCP &  Other  )  const

-Send an array of bytes to the host (must be connected first). +Comparison operator !=.

Parameters:
- - +
Data : Pointer to the bytes to send
Size : Number of bytes to send
Other : Socket to compare
-
Returns:
Status code
+
Returns:
True if *this != Other
+ +

Definition at line 427 of file SocketTCP.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - + + + +
Socket::Status sf::SocketTCP::Receive bool sf::SocketTCP::operator< (char *  Data,
std::size_t  MaxSize,
std::size_t &  SizeReceived 
)const SocketTCP &  Other  )  const

-Receive an array of bytes from the host (must be connected first). +Comparison operator <.

-This function will block if the socket is blocking

+Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

Parameters:
- - - +
Data : Pointer to a byte array to fill (make sure it is big enough)
MaxSize : Maximum number of bytes to read
SizeReceived : Number of bytes received
Other : Socket to compare
-
Returns:
Status code
+
Returns:
True if *this < Other
+Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense... +

Definition at line 438 of file SocketTCP.cpp.

- +

- + - - + + - +
Socket::Status sf::SocketTCP::Send bool sf::SocketTCP::operator== (Packet &  PacketToSend const SocketTCP &  Other  )  const

-Send a packet of data to the host (must be connected first). +Comparison operator ==.

Parameters:
- +
PacketToSend : Packet to send
Other : Socket to compare
-
Returns:
Status code
+
Returns:
True if *this == Other
+ +

Definition at line 418 of file SocketTCP.cpp.

@@ -369,12 +380,12 @@ Send a packet of data to the host (must be connected first).

- + - +
Socket::Status sf::SocketTCP::Receive Socket::Status sf::SocketTCP::Receive ( Packet &  PacketToReceive  ) 
@@ -389,141 +400,163 @@ This function will block if the socket is blocking

PacketToReceive : Packet to fill with received data -

Returns:
Status code
+
Returns:
Status code
+This function will block if the socket is blocking +

Definition at line 329 of file SocketTCP.cpp.

- +

- + - - - + + -
bool sf::SocketTCP::Close Socket::Status sf::SocketTCP::Receive (  ) char *  Data,
-
-
- -

-Close the socket. -

-

Returns:
True if operation has been successful
- -
-

- -

-
- - - - - - + + + + + + + + + + + + + + +
bool sf::SocketTCP::IsValid (  )  conststd::size_t  MaxSize,
std::size_t &  SizeReceived 
)

-Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK. +Receive an array of bytes from the host (must be connected first).

-

Returns:
True if the socket is valid
+This function will block if the socket is blocking

+

Parameters:
+ + + + +
Data : Pointer to a byte array to fill (make sure it is big enough)
MaxSize : Maximum number of bytes to read
SizeReceived : Number of bytes received
+
+
Returns:
Status code
+This function will block if the socket is blocking +

Definition at line 261 of file SocketTCP.cpp.

- +

- + - - + + - +
bool sf::SocketTCP::operator== Socket::Status sf::SocketTCP::Send (const SocketTCP &  Other Packet &  PacketToSend  )  const

-Comparison operator ==. +Send a packet of data to the host (must be connected first).

Parameters:
- +
Other : Socket to compare
PacketToSend : Packet to send
-
Returns:
True if *this == Other
+
Returns:
Status code
+ +

Definition at line 303 of file SocketTCP.cpp.

- +

- + - - - - + + + + + + + + + + + + +
bool sf::SocketTCP::operator!= Socket::Status sf::SocketTCP::Send (const SocketTCP &  Other  )  constconst char *  Data,
std::size_t  Size 
)

-Comparison operator !=. +Send an array of bytes to the host (must be connected first).

Parameters:
- + +
Other : Socket to compare
Data : Pointer to the bytes to send
Size : Number of bytes to send
-
Returns:
True if *this != Other
+
Returns:
Status code
+ +

Definition at line 224 of file SocketTCP.cpp.

- +

- + - - + + - +
bool sf::SocketTCP::operator< void sf::SocketTCP::SetBlocking (const SocketTCP &  Other bool  Blocking  )  const

-Comparison operator <. +Change the blocking state of the socket.

-Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

+The default behaviour of a socket is blocking

Parameters:
- +
Other : Socket to compare
Blocking : Pass true to set the socket as blocking, or false for non-blocking
-
Returns:
True if *this < Other
+ +

Definition at line 56 of file SocketTCP.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::SocketUDP Member List

This is the complete list of members for sf::SocketUDP, including all inherited members.

- - + + - - - + + + -
Bind(unsigned short Port)sf::SocketUDP
Close()sf::SocketUDP
GetPort() constsf::SocketUDP
IsValid() constsf::SocketUDP
GetPort() const sf::SocketUDP
IsValid() const sf::SocketUDP
operator!=(const SocketUDP &Other) const sf::SocketUDP
operator<(const SocketUDP &Other) const sf::SocketUDP
operator==(const SocketUDP &Other) const sf::SocketUDP
Receive(char *Data, std::size_t MaxSize, std::size_t &SizeReceived, IPAddress &Address)sf::SocketUDP
Receive(Packet &PacketToReceive, IPAddress &Address)sf::SocketUDP
Selector< SocketUDP > classsf::SocketUDP [friend]
Receive(char *Data, std::size_t MaxSize, std::size_t &SizeReceived, IPAddress &Address, unsigned short &Port)sf::SocketUDP
Receive(Packet &PacketToReceive, IPAddress &Address, unsigned short &Port)sf::SocketUDP
Selector< SocketUDP > (defined in sf::SocketUDP)sf::SocketUDP [friend]
Send(const char *Data, std::size_t Size, const IPAddress &Address, unsigned short Port)sf::SocketUDP
Send(Packet &PacketToSend, const IPAddress &Address, unsigned short Port)sf::SocketUDP
SetBlocking(bool Blocking)sf::SocketUDP
SocketUDP()sf::SocketUDP
Unbind()sf::SocketUDP
+

+ - -
- + + -
- -
-
-sf::SocketUDP
+

sf::SocketUDP Class Reference

SocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety). More...

#include <SocketUDP.hpp> +

+

List of all members. @@ -49,27 +54,27 @@ - + - + - - + + - + - + - + - - + + - + @@ -81,15 +86,13 @@ +class 
bool Unbind ()
 Unbind the socket from its previous port, if any.
Socket::Status Send (const char *Data, std::size_t Size, const IPAddress &Address, unsigned short Port)
Socket::Status Send (const char *Data, std::size_t Size, const IPAddress &Address, unsigned short Port)
 Send an array of bytes.
Socket::Status Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived, IPAddress &Address)
Socket::Status Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived, IPAddress &Address, unsigned short &Port)
 Receive an array of bytes.
Socket::Status Send (Packet &PacketToSend, const IPAddress &Address, unsigned short Port)
 Receive an array of bytes.
Socket::Status Send (Packet &PacketToSend, const IPAddress &Address, unsigned short Port)
 Send a packet of data.
Socket::Status Receive (Packet &PacketToReceive, IPAddress &Address)
Socket::Status Receive (Packet &PacketToReceive, IPAddress &Address, unsigned short &Port)
 Receive a packet.
 Receive a packet.
bool Close ()
 Close the socket.
bool IsValid () const
bool IsValid () const
 Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
unsigned short GetPort () const
 Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
unsigned short GetPort () const
 Get the port the socket is currently bound to.
 Get the port the socket is currently bound to.
bool operator== (const SocketUDP &Other) const
 Comparison operator ==.
 Comparison operator <.

Friends

-class Selector< SocketUDP >
Selector< SocketUDP >

Detailed Description

SocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety). -

- -

-Definition at line 45 of file SocketUDP.hpp.

Constructor & Destructor Documentation

+

Definition at line 45 of file SocketUDP.hpp.

+

Constructor & Destructor Documentation

@@ -99,7 +102,7 @@ Definition at line 45 (  )  - +
@@ -109,145 +112,259 @@ Definition at line 45 Default constructor.

+

Definition at line 41 of file SocketUDP.cpp.

+

Member Function Documentation

- +
- + - - + + - +
void sf::SocketUDP::SetBlocking bool sf::SocketUDP::Bind (bool  Blocking unsigned short  Port  ) 

-Change the blocking state of the socket. +Bind the socket to a specific port.

-The default behaviour of a socket is blocking

Parameters:
- +
Blocking : Pass true to set the socket as blocking, or false for non-blocking
Port : Port to bind the socket to
+
Returns:
True if operation has been successful
+ +

Definition at line 64 of file SocketUDP.cpp.

- +

- + - - + - +
bool sf::SocketUDP::Bind bool sf::SocketUDP::Close (unsigned short  Port  ) 

-Bind the socket to a specific port. +Close the socket. +

+

Returns:
True if operation has been successful
+ +

Definition at line 314 of file SocketUDP.cpp.

+ +
+

+ +

+
+ + + + + + + + +
unsigned short sf::SocketUDP::GetPort (  )  const
+
+
+ +

+Get the port the socket is currently bound to. +

+

Returns:
Current port (0 means the socket is not bound)
+ +

Definition at line 347 of file SocketUDP.cpp.

+ +
+

+ +

+
+ + + + + + + + +
bool sf::SocketUDP::IsValid (  )  const
+
+
+ +

+Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK. +

+Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

+

Returns:
True if the socket is valid
+ +

Definition at line 338 of file SocketUDP.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
bool sf::SocketUDP::operator!= (const SocketUDP &  Other  )  const
+
+
+ +

+Comparison operator !=.

Parameters:
- +
Port : Port to bind the socket to
Other : Socket to compare
-
Returns:
True if operation has been successful
+
Returns:
True if *this != Other
+ +

Definition at line 365 of file SocketUDP.cpp.

- +

- + - + + - +
bool sf::SocketUDP::Unbind bool sf::SocketUDP::operator< ( const SocketUDP &  Other  )  const

-Unbind the socket from its previous port, if any. +Comparison operator <.

-

Returns:
True if operation has been successful
+Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

+

Parameters:
+ + +
Other : Socket to compare
+
+
Returns:
True if *this < Other
+Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense... +

Definition at line 376 of file SocketUDP.cpp.

- +

- + - - + + + + +
Socket::Status sf::SocketUDP::Send bool sf::SocketUDP::operator== (const char *  Data, const SocketUDP &  Other  )  const
+
+
+ +

+Comparison operator ==. +

+

Parameters:
+ + +
Other : Socket to compare
+
+
Returns:
True if *this == Other
+ +

Definition at line 356 of file SocketUDP.cpp.

+ +
+

+ +

+
+ - - - - + + + + - + - + - +
std::size_t  Size, Socket::Status sf::SocketUDP::Receive (Packet &  PacketToReceive,
const IPAddress & IPAddress &  Address,
unsigned short unsigned short &  Port 
)

-Send an array of bytes. +Receive a packet.

+This function will block if the socket is blocking

Parameters:
- - - - + + +
Data : Pointer to the bytes to send
Size : Number of bytes to send
Address : Address of the computer to send the packet to
Port : Port to send the data to
PacketToReceive : Packet to fill with received data
Address : Address of the computer which sent the packet
Port : Port on which the remote computer sent the data
-
Returns:
Status code
+
Returns:
Status code
+This function will block if the socket is blocking +

Definition at line 245 of file SocketUDP.cpp.

- +

- + @@ -268,12 +385,18 @@ Send an array of bytes. - + + + + + + + - +
Socket::Status sf::SocketUDP::Receive Socket::Status sf::SocketUDP::Receive ( char *  Data, IPAddress &  Address  Address,
unsigned short &  Port 
)
@@ -288,10 +411,13 @@ This function will block if the socket is blocking

Data : Pointer to a byte array to fill (make sure it is big enough) MaxSize : Maximum number of bytes to read SizeReceived : Number of bytes received - Address : Address of the computer which sent the data + Address : Address of the computer which sent the data + Port : Port on which the remote computer sent the data -

Returns:
Status code
+
Returns:
Status code
+This function will block if the socket is blocking +

Definition at line 162 of file SocketUDP.cpp.

@@ -300,7 +426,7 @@ This function will block if the socket is blocking

- + @@ -320,7 +446,7 @@ This function will block if the socket is blocking

- +
Socket::Status sf::SocketUDP::Send Socket::Status sf::SocketUDP::Send ( Packet &  PacketToSend,
)
@@ -338,200 +464,122 @@ Send a packet of data.
Returns:
Status code
+

Definition at line 219 of file SocketUDP.cpp.

+

- +

- + - - + + - - + + + - - - -
Socket::Status sf::SocketUDP::Receive Socket::Status sf::SocketUDP::Send (Packet &  PacketToReceive, const char *  Data,
IPAddress &  Address std::size_t  Size,
)
-
-
- -

-Receive a packet. -

-This function will block if the socket is blocking

-

Parameters:
- - - -
PacketToReceive : Packet to fill with received data
Address : Address of the computer which sent the packet
-
-
Returns:
Status code
- -
-

- -

-
- - - - - - - - -
bool sf::SocketUDP::Close (  ) 
-
-
- -

-Close the socket. -

-

Returns:
True if operation has been successful
- -
-

- -

-
- - - - - - - + + -
bool sf::SocketUDP::IsValid (  )  constconst IPAddress &  Address,
-
-
- -

-Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK. -

-

Returns:
True if the socket is valid
- -
-

- -

-
- - - - - - + + + + -
unsigned short sf::SocketUDP::GetPort (  )  constunsigned short  Port 
-
-
- -

-Get the port the socket is currently bound to. -

-

Returns:
Current port (0 means the socket is not bound)
- -
-

- -

-
- - - - - - - + + +
bool sf::SocketUDP::operator== (const SocketUDP &  Other  )  const)

-Comparison operator ==. +Send an array of bytes.

Parameters:
- + + + +
Other : Socket to compare
Data : Pointer to the bytes to send
Size : Number of bytes to send
Address : Address of the computer to send the packet to
Port : Port to send the data to
-
Returns:
True if *this == Other
+
Returns:
Status code
+ +

Definition at line 118 of file SocketUDP.cpp.

- +

- + - - + + - +
bool sf::SocketUDP::operator!= void sf::SocketUDP::SetBlocking (const SocketUDP &  Other bool  Blocking  )  const

-Comparison operator !=. +Change the blocking state of the socket.

+The default behaviour of a socket is blocking

Parameters:
- +
Other : Socket to compare
Blocking : Pass true to set the socket as blocking, or false for non-blocking
-
Returns:
True if *this != Other
+ +

Definition at line 50 of file SocketUDP.cpp.

- +

- + - - + - +
bool sf::SocketUDP::operator< bool sf::SocketUDP::Unbind (const SocketUDP &  Other  )  const

-Comparison operator <. +Unbind the socket from its previous port, if any.

-Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

-

Parameters:
- - -
Other : Socket to compare
-
-
Returns:
True if *this < Other
+Unbind the socket to its previous port.

+

Returns:
True if operation has been successful
+ +

Definition at line 101 of file SocketUDP.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Sound Member List

This is the complete list of members for sf::Sound, including all inherited members.

- - - - - - - - - - + + + + + + + + + + + @@ -52,17 +56,19 @@ + - + - + -
AudioResource()sf::AudioResource [protected]
AudioResource(const AudioResource &)sf::AudioResource [protected]
GetAttenuation() constsf::Sound
GetBuffer() constsf::Sound
GetLoop() constsf::Sound
GetMinDistance() constsf::Sound
GetPitch() constsf::Sound
GetPlayingOffset() constsf::Sound
GetPosition() constsf::Sound
GetStatus() constsf::Sound
GetVolume() constsf::Sound
operator=(const Sound &Other)sf::Sound
GetAttenuation() const sf::Sound
GetBuffer() const sf::Sound
GetLoop() const sf::Sound
GetMinDistance() const sf::Sound
GetPitch() const sf::Sound
GetPlayingOffset() const sf::Sound
GetPosition() const sf::Sound
GetStatus() const sf::Sound
GetVolume() const sf::Sound
IsRelativeToListener() const sf::Sound
operator=(const Sound &Other)sf::Sound
Pause()sf::Sound
Paused enum valuesf::Sound
Play()sf::Sound
SetPlayingOffset(float TimeOffset)sf::Sound
SetPosition(float X, float Y, float Z)sf::Sound
SetPosition(const Vector3f &Position)sf::Sound
SetRelativeToListener(bool Relative)sf::Sound
SetVolume(float Volume)sf::Sound
Sound()sf::Sound
Sound(const SoundBuffer &Buffer, bool Loop=false, float Pitch=1.f, float Volume=100.f, const Vector3f &Position=Vector3f(0, 0, 0))sf::Sound
Sound(const Sound &Copy)sf::Sound
SoundStream classsf::Sound [friend]
SoundStream (defined in sf::Sound)sf::Sound [friend]
Status enum namesf::Sound
Stop()sf::Sound
Stopped enum valuesf::Sound
~AudioResource()sf::AudioResource [protected, virtual]
~AudioResource()sf::AudioResource [protected, virtual]
~Sound()sf::Sound
+

+ - -
- -
-
- -
-
-sf::Sound
+ + +

sf::Sound Class Reference

Sound defines the properties of a sound such as position, volume, pitch, etc. More...

#include <Sound.hpp>

-

Inheritance diagram for sf::Sound: +

+Inheritance diagram for sf::Sound:
+
+

sf::AudioResource sf::SoundStream sf::Music +
+ +

List of all members. @@ -94,6 +103,9 @@ + + + @@ -103,47 +115,48 @@ - + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + +class 

Public Types

void SetPosition (const Vector3f &Position)
 Set the sound position (take a 3D vector).
void SetRelativeToListener (bool Relative)
 Make the sound's position relative to the listener's position, or absolute.
void SetMinDistance (float MinDistance)
 Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.
void SetPlayingOffset (float TimeOffset)
 Set the current playing position of the sound.
const SoundBuffer * GetBuffer () const
const SoundBuffer * GetBuffer () const
 Get the source buffer.
bool GetLoop () const
 Get the source buffer.
bool GetLoop () const
 Tell whether or not the sound is looping.
float GetPitch () const
 Tell whether or not the sound is looping.
float GetPitch () const
 Get the pitch.
float GetVolume () const
 Get the pitch.
float GetVolume () const
 Get the volume.
Vector3f GetPosition () const
 Get the volume.
Vector3f GetPosition () const
 Get the sound position.
bool IsRelativeToListener () const
 Get the sound position.
float GetMinDistance () const
 Tell if the sound's position is relative to the listener's position, or if it's absolute.
float GetMinDistance () const
 Get the minimum distance.
float GetAttenuation () const
 Get the minimum distance.
float GetAttenuation () const
 Get the attenuation factor.
Status GetStatus () const
 Get the attenuation factor.
Status GetStatus () const
 Get the status of the sound (stopped, paused, playing).
float GetPlayingOffset () const
 Get the status of the sound (stopped, paused, playing).
float GetPlayingOffset () const
 Get the current playing position of the sound.
Sound & operator= (const Sound &Other)
 Get the current playing position of the sound.
Sound & operator= (const Sound &Other)
 Assignment operator.
 Assignment operator.

Friends

-class SoundStream
SoundStream

Detailed Description

Sound defines the properties of a sound such as position, volume, pitch, etc. -

- -

-Definition at line 45 of file Sound.hpp.

Member Enumeration Documentation

+

Definition at line 45 of file Sound.hpp.

+

Member Enumeration Documentation

@@ -169,8 +182,8 @@ Enumeration of the sound states. -

-Definition at line 52 of file Sound.hpp. +

Definition at line 52 of file Sound.hpp.

+

Constructor & Destructor Documentation

@@ -183,7 +196,7 @@ Definition at line 52 of f (  )  - +
@@ -193,6 +206,8 @@ Definition at line 52 of f Default constructor.

+

Definition at line 38 of file Sound.cpp.

+

@@ -232,7 +247,7 @@ Default constructor. ) - + @@ -251,6 +266,8 @@ Construct the sound from its parameters. +

Definition at line 48 of file Sound.cpp.

+

@@ -263,7 +280,7 @@ Construct the sound from its parameters. const Sound &  Copy  )  - + @@ -278,6 +295,8 @@ Copy constructor. +

Definition at line 64 of file Sound.cpp.

+

@@ -289,7 +308,7 @@ Copy constructor. (  )  - + @@ -299,577 +318,682 @@ Copy constructor. Destructor.

+

Definition at line 81 of file Sound.cpp.

+

Member Function Documentation

- +
- + - +
void sf::Sound::Play float sf::Sound::GetAttenuation (  )  const

-Play the sound. +Get the attenuation factor.

+

Returns:
Attenuation factor of the sound
+ +

Definition at line 305 of file Sound.cpp.

-

-Reimplemented in sf::SoundStream.

- +

- + - +
void sf::Sound::Pause const SoundBuffer * sf::Sound::GetBuffer (  )  const

-Pause the sound. +Get the source buffer.

+

Returns:
Sound buffer bound to the sound (can be NULL)
+ +

Definition at line 223 of file Sound.cpp.

- +

- + - +
void sf::Sound::Stop bool sf::Sound::GetLoop (  )  const

-Stop the sound. +Tell whether or not the sound is looping.

+

Returns:
True if the sound is looping, false otherwise
+ +

Reimplemented in sf::SoundStream.

+ +

Definition at line 232 of file Sound.cpp.

-

-Reimplemented in sf::SoundStream.

- +

- + - - + - +
void sf::Sound::SetBuffer float sf::Sound::GetMinDistance (const SoundBuffer &  Buffer  )  const

-Set the source buffer. +Get the minimum distance.

-

Parameters:
- - -
Buffer : New sound buffer to bind to the sound
-
+
Returns:
Minimum distance for the sound
+ +

Definition at line 293 of file Sound.cpp.

- +

- + - - + - +
void sf::Sound::SetLoop float sf::Sound::GetPitch (bool  Loop  )  const

-Set the sound loop state. +Get the pitch.

-This parameter is disabled by default

-

Parameters:
- - -
Loop : True to play in loop, false to play once
-
+
Returns:
Pitch value
+ +

Definition at line 244 of file Sound.cpp.

-

-Reimplemented in sf::SoundStream.

- +

- + - - + - +
void sf::Sound::SetPitch float sf::Sound::GetPlayingOffset (float  Pitch  )  const

-Set the sound pitch. +Get the current playing position of the sound.

-The default pitch is 1

-

Parameters:
- - -
Pitch : New pitch
-
+
Returns:
Current playing position, expressed in seconds
+ +

Reimplemented in sf::SoundStream.

+ +

Definition at line 317 of file Sound.cpp.

- +

- + - - + - +
void sf::Sound::SetVolume Vector3f sf::Sound::GetPosition (float  Volume  )  const

-Set the sound volume. +Get the sound position.

-The default volume is 100

-

Parameters:
- - -
Volume : Volume (in range [0, 100])
-
+
Returns:
Position of the sound in the world
+ +

Definition at line 268 of file Sound.cpp.

- +

- + - - - - - - - - + + + +
void sf::Sound::SetPosition Sound::Status sf::Sound::GetStatus (float  X,
float  Y,  )  const
+
+
+ +

+Get the status of the sound (stopped, paused, playing). +

+

Returns:
Current status of the sound
+ +

Reimplemented in sf::SoundStream.

+ +

Definition at line 329 of file Sound.cpp.

+ +
+

+ +

+
+ - - - - + + + + + +
float  Z float sf::Sound::GetVolume (  )  const
+
+
+ +

+Get the volume. +

+

Returns:
Volume value (in range [1, 100])
+ +

Definition at line 256 of file Sound.cpp.

+ +
+

+ +

+
+ - - - + + + + +
)bool sf::Sound::IsRelativeToListener (  )  const

-Set the sound position (take 3 values). +Tell if the sound's position is relative to the listener's position, or if it's absolute.

-The default position is (0, 0, 0)

-

Parameters:
- - -
X,Y,Z : Position of the sound in the world
-
+Tell if the sound's position is relative to the listener's position, or if it's absolute.

+

Returns:
True if the position is relative, false if it's absolute
+ +

Definition at line 281 of file Sound.cpp.

- +

- + - - + + - +
void sf::Sound::SetPosition Sound & sf::Sound::operator= (const Vector3f &  Position const Sound &  Other  ) 

-Set the sound position (take a 3D vector). +Assignment operator.

-The default position is (0, 0, 0)

Parameters:
- +
Position : Position of the sound in the world
Other : Instance to assign
+
Returns:
Reference to the sound
+ +

Definition at line 349 of file Sound.cpp.

- +

- + - - + - +
void sf::Sound::SetMinDistance void sf::Sound::Pause (float  MinDistance  ) 

-Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume. +Pause the sound.

-The default minimum distance is 1.0

-

Parameters:
- - -
MinDistance : New minimum distance for the sound
-
+ +

Definition at line 107 of file Sound.cpp.

- +

- + - - + - +
void sf::Sound::SetAttenuation void sf::Sound::Play (float  Attenuation  ) 

-Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener. +Play the sound.

-The default attenuation factor 1.0

-

Parameters:
- - -
Attenuation : New attenuation factor for the sound
-
+ +

Reimplemented in sf::SoundStream.

+ +

Definition at line 98 of file Sound.cpp.

- +

- + - + - +
void sf::Sound::SetPlayingOffset void sf::Sound::SetAttenuation ( float  TimeOffset Attenuation  ) 

-Set the current playing position of the sound. +Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener.

+Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener.

+The default attenuation factor 1.0

Parameters:
- +
TimeOffset : New playing position, expressed in seconds
Attenuation : New attenuation factor for the sound
+The default attenuation factor 1.0 +

Definition at line 205 of file Sound.cpp.

- +

- + - + + - +
const SoundBuffer* sf::Sound::GetBuffer void sf::Sound::SetBuffer ( const SoundBuffer &  Buffer  )  const

-Get the source buffer. +Set the source buffer.

-

Returns:
Sound buffer bound to the sound (can be NULL)
+
Parameters:
+ + +
Buffer : New sound buffer to bind to the sound
+
+ +

Definition at line 125 of file Sound.cpp.

- +

- + - + + - +
bool sf::Sound::GetLoop void sf::Sound::SetLoop ( bool  Loop  )  const

-Tell whether or not the sound is looping. +Set the sound loop state.

-

Returns:
True if the sound is looping, false otherwise
+This parameter is disabled by default

+

Parameters:
+ + +
Loop : True to play in loop, false to play once
+
+ +

Reimplemented in sf::SoundStream.

+ +

Definition at line 135 of file Sound.cpp.

-

-Reimplemented in sf::SoundStream.

- +

- + - + + - +
float sf::Sound::GetPitch void sf::Sound::SetMinDistance ( float  MinDistance  )  const

-Get the pitch. +Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.

-

Returns:
Pitch value
+Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.

+The default minimum distance is 1.0

+

Parameters:
+ + +
MinDistance : New minimum distance for the sound
+
+The default minimum distance is 1.0 +

Definition at line 194 of file Sound.cpp.

- +

- + - + + - +
float sf::Sound::GetVolume void sf::Sound::SetPitch ( float  Pitch  )  const

-Get the volume. +Set the sound pitch.

-

Returns:
Volume value (in range [1, 100])
+The default pitch is 1

+

Parameters:
+ + +
Pitch : New pitch
+
+ +

Definition at line 144 of file Sound.cpp.

- +

- + - + + - +
Vector3f sf::Sound::GetPosition void sf::Sound::SetPlayingOffset ( float  TimeOffset  )  const

-Get the sound position. +Set the current playing position of the sound.

-

Returns:
Position of the sound in the world
+
Parameters:
+ + +
TimeOffset : New playing position, expressed in seconds
+
+ +

Definition at line 214 of file Sound.cpp.

- +

- + - + + - +
float sf::Sound::GetMinDistance void sf::Sound::SetPosition ( const Vector3f &  Position  )  const

-Get the minimum distance. +Set the sound position (take a 3D vector).

-

Returns:
Minimum distance for the sound
+The default position is (0, 0, 0)

+

Parameters:
+ + +
Position : Position of the sound in the world
+
+The default position is (0, 0, 0) +

Definition at line 172 of file Sound.cpp.

- +

- + - - - + + + + + + + + + + + + + + + + + + +
float sf::Sound::GetAttenuation void sf::Sound::SetPosition (  )  constfloat  X,
float  Y,
float  Z 
)

-Get the attenuation factor. +Set the sound position (take 3 values).

-

Returns:
Attenuation factor of the sound
+The default position is (0, 0, 0)

+

Parameters:
+ + +
X,Y,Z : Position of the sound in the world
+
+The default position is (0, 0, 0) +

Definition at line 162 of file Sound.cpp.

- +

- + - + + - +
Status sf::Sound::GetStatus void sf::Sound::SetRelativeToListener ( bool  Relative  )  const

-Get the status of the sound (stopped, paused, playing). +Make the sound's position relative to the listener's position, or absolute.

-

Returns:
Current status of the sound
+Make the sound's position relative to the listener's position, or absolute.

+The default value is false (absolute)

+

Parameters:
+ + +
Relative : True to set the position relative, false to set it absolute
+
+The default value is false (absolute) +

Definition at line 183 of file Sound.cpp.

-

-Reimplemented in sf::SoundStream.

- +

- + - + + - +
float sf::Sound::GetPlayingOffset void sf::Sound::SetVolume ( float  Volume  )  const

-Get the current playing position of the sound. +Set the sound volume.

-

Returns:
Current playing position, expressed in seconds
+The default volume is 100

+

Parameters:
+ + +
Volume : Volume (in range [0, 100])
+
+ +

Definition at line 153 of file Sound.cpp.

-

-Reimplemented in sf::SoundStream.

- +

- + - - + - +
Sound& sf::Sound::operator= void sf::Sound::Stop (const Sound &  Other  ) 

-Assignment operator. +Stop the sound.

-

Parameters:
- - -
Other : Instance to assign
-
-
Returns:
Reference to the sound
+ +

Reimplemented in sf::SoundStream.

+ +

Definition at line 116 of file Sound.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::SoundBuffer Member List

This is the complete list of members for sf::SoundBuffer, including all inherited members.

- - - - - + + + + + - - + + - + - + -
AudioResource()sf::AudioResource [protected]
AudioResource(const AudioResource &)sf::AudioResource [protected]
GetChannelsCount() constsf::SoundBuffer
GetDuration() constsf::SoundBuffer
GetSampleRate() constsf::SoundBuffer
GetSamples() constsf::SoundBuffer
GetSamplesCount() constsf::SoundBuffer
GetChannelsCount() const sf::SoundBuffer
GetDuration() const sf::SoundBuffer
GetSampleRate() const sf::SoundBuffer
GetSamples() const sf::SoundBuffer
GetSamplesCount() const sf::SoundBuffer
LoadFromFile(const std::string &Filename)sf::SoundBuffer
LoadFromMemory(const char *Data, std::size_t SizeInBytes)sf::SoundBuffer
LoadFromSamples(const Int16 *Samples, std::size_t SamplesCount, unsigned int ChannelsCount, unsigned int SampleRate)sf::SoundBuffer
operator=(const SoundBuffer &Other)sf::SoundBuffer
sf::Resource< SoundBuffer >::operator=(const Resource< SoundBuffer > &Other)sf::Resource< SoundBuffer > [protected]
operator=(const SoundBuffer &Other)sf::SoundBuffer
Resource< SoundBuffer >::operator=(const Resource< SoundBuffer > &Other)sf::Resource< SoundBuffer > [protected]
Resource()sf::Resource< SoundBuffer > [protected]
Resource(const Resource< SoundBuffer > &Copy)sf::Resource< SoundBuffer > [protected]
SaveToFile(const std::string &Filename) const sf::SoundBuffer
Sound classsf::SoundBuffer [friend]
Sound (defined in sf::SoundBuffer)sf::SoundBuffer [friend]
SoundBuffer()sf::SoundBuffer
SoundBuffer(const SoundBuffer &Copy)sf::SoundBuffer
~AudioResource()sf::AudioResource [protected, virtual]
~AudioResource()sf::AudioResource [protected, virtual]
~Resource()sf::Resource< SoundBuffer > [protected]
~SoundBuffer()sf::SoundBuffer
+

+ - -
- + + -
- -
-
-sf::SoundBuffer
-

sf::SoundBuffer Class Reference

SoundBuffer is the low-level for loading and manipulating sound buffers. +
+

sf::SoundBuffer Class Reference

SoundBuffer is the low-level for loading and manipulating sound buffers. More...

#include <SoundBuffer.hpp>

-

Inheritance diagram for sf::SoundBuffer: +

+Inheritance diagram for sf::SoundBuffer:
+
+

sf::AudioResource sf::Resource< SoundBuffer > +
+ +

List of all members. @@ -64,35 +73,33 @@ - + - - + + - - + + - - + + - - + + - - + + - + +class 

Public Member Functions

bool SaveToFile (const std::string &Filename) const
 Save the sound buffer to a file.
const Int16 * GetSamples () const
const Int16 * GetSamples () const
 Return the sound samples.
std::size_t GetSamplesCount () const
 Return the sound samples.
std::size_t GetSamplesCount () const
 Return the samples count.
unsigned int GetSampleRate () const
 Return the samples count.
unsigned int GetSampleRate () const
 Get the sample rate.
unsigned int GetChannelsCount () const
 Get the sample rate.
unsigned int GetChannelsCount () const
 Return the number of channels (1 = mono, 2 = stereo, .
float GetDuration () const
 Return the number of channels (1 = mono, 2 = stereo, .
float GetDuration () const
 Get the sound duration.
SoundBuffer & operator= (const SoundBuffer &Other)
 Get the sound duration.
SoundBuffer & operator= (const SoundBuffer &Other)
 Assignment operator.
 Assignment operator.

Friends

-class Sound
Sound

Detailed Description

SoundBuffer is the low-level for loading and manipulating sound buffers. -

- -

-Definition at line 43 of file SoundBuffer.hpp.

Constructor & Destructor Documentation

+

Definition at line 43 of file SoundBuffer.hpp.

+

Constructor & Destructor Documentation

@@ -102,7 +109,7 @@ Definition at line 43(  )  - +
@@ -112,6 +119,8 @@ Definition at line 43 +

Definition at line 41 of file SoundBuffer.cpp.

+

@@ -124,7 +133,7 @@ Default constructor. const SoundBuffer &  Copy  )  - +

@@ -139,6 +148,8 @@ Copy constructor. +

Definition at line 53 of file SoundBuffer.cpp.

+

@@ -150,7 +161,7 @@ Copy constructor. (  )  - + @@ -160,296 +171,320 @@ Copy constructor. Destructor.

+

Definition at line 71 of file SoundBuffer.cpp.

+

Member Function Documentation

- +
- + - - + - +
bool sf::SoundBuffer::LoadFromFile unsigned int sf::SoundBuffer::GetChannelsCount (const std::string &  Filename  )  const

-Load the sound buffer from a file. +Return the number of channels (1 = mono, 2 = stereo, .

-

Parameters:
- - -
Filename : Path of the sound file to load
-
-
Returns:
True if loading has been successful
+..)

+

Returns:
Number of channels
+..) +

Definition at line 246 of file SoundBuffer.cpp.

- +

- + - - - - - - - - - - - - - + + +
bool sf::SoundBuffer::LoadFromMemory float sf::SoundBuffer::GetDuration (const char *  Data,
std::size_t  SizeInBytes 
)  )  const

-Load the sound buffer from a file in memory. +Get the sound duration.

-

Parameters:
- - - -
Data : Pointer to the file data in memory
SizeInBytes : Size of the data to load, in bytes
-
-
Returns:
True if loading has been successful
+
Returns:
Sound duration, in seconds
+ +

Definition at line 258 of file SoundBuffer.cpp.

- +

- + - - - - - - - - - - - - - - - - - - - - - - - - - + + +
bool sf::SoundBuffer::LoadFromSamples unsigned int sf::SoundBuffer::GetSampleRate (const Int16 *  Samples,
std::size_t  SamplesCount,
unsigned int  ChannelsCount,
unsigned int  SampleRate 
)  )  const

-Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer. +Get the sample rate.

-

Parameters:
- - - - - -
Samples : Pointer to the samples in memory
SamplesCount : Number of samples pointed by Samples
ChannelsCount : Number of channels (1 = mono, 2 = stereo, ...)
SampleRate : Frequency (number of samples to play per second)
-
-
Returns:
True if loading has been successful
+
Returns:
Sound frequency (number of samples per second)
+ +

Definition at line 234 of file SoundBuffer.cpp.

- +

- + - - + - +
bool sf::SoundBuffer::SaveToFile const Int16 * sf::SoundBuffer::GetSamples (const std::string &  Filename  )  const const

-Save the sound buffer to a file. +Return the sound samples.

-

Parameters:
- - -
Filename : Path of the sound file to write
-
-
Returns:
True if saving has been successful
+
Returns:
Pointer to the array of sound samples, in 16 bits signed integer format
+ +

Definition at line 216 of file SoundBuffer.cpp.

- +

- + - +
const Int16* sf::SoundBuffer::GetSamples std::size_t sf::SoundBuffer::GetSamplesCount (  )  const const

-Return the sound samples. +Return the samples count.

-

Returns:
Pointer to the array of sound samples, in 16 bits signed integer format
+
Returns:
Number of samples
+ +

Definition at line 225 of file SoundBuffer.cpp.

- +

- + - + + - +
std::size_t sf::SoundBuffer::GetSamplesCount bool sf::SoundBuffer::LoadFromFile ( const std::string &  Filename  )  const

-Return the samples count. +Load the sound buffer from a file.

-

Returns:
Number of samples
+
Parameters:
+ + +
Filename : Path of the sound file to load
+
+
Returns:
True if loading has been successful
+ +

Definition at line 81 of file SoundBuffer.cpp.

- +

- + - - - + + + + + + + + + + + + +
unsigned int sf::SoundBuffer::GetSampleRate bool sf::SoundBuffer::LoadFromMemory (  )  constconst char *  Data,
std::size_t  SizeInBytes 
)

-Get the sample rate. +Load the sound buffer from a file in memory.

-

Returns:
Sound frequency (number of samples per second)
+
Parameters:
+ + + +
Data : Pointer to the file data in memory
SizeInBytes : Size of the data to load, in bytes
+
+
Returns:
True if loading has been successful
+ +

Definition at line 122 of file SoundBuffer.cpp.

- +

- + - - - + + + + + + + + + + + + + + + + + + + + + + + + +
unsigned int sf::SoundBuffer::GetChannelsCount bool sf::SoundBuffer::LoadFromSamples (  )  constconst Int16 *  Samples,
std::size_t  SamplesCount,
unsigned int  ChannelsCount,
unsigned int  SampleRate 
)

-Return the number of channels (1 = mono, 2 = stereo, . +Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.

-..)

-

Returns:
Number of channels
+Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.

+

Parameters:
+ + + + + +
Samples : Pointer to the samples in memory
SamplesCount : Number of samples pointed by Samples
ChannelsCount : Number of channels (1 = mono, 2 = stereo, ...)
SampleRate : Frequency (number of samples to play per second)
+
+
Returns:
True if loading has been successful
+ +

Definition at line 164 of file SoundBuffer.cpp.

- +

- + - + + - +
float sf::SoundBuffer::GetDuration SoundBuffer & sf::SoundBuffer::operator= ( const SoundBuffer &  Other  )  const

-Get the sound duration. +Assignment operator.

-

Returns:
Sound duration, in seconds
+
Parameters:
+ + +
Other : Instance to assign
+
+
Returns:
Reference to the sound buffer
+ +

Definition at line 267 of file SoundBuffer.cpp.

- +

- + - - + + - +
SoundBuffer& sf::SoundBuffer::operator= bool sf::SoundBuffer::SaveToFile (const SoundBuffer &  Other const std::string &  Filename  )  const

-Assignment operator. +Save the sound buffer to a file.

Parameters:
- +
Other : Instance to assign
Filename : Path of the sound file to write
-
Returns:
Reference to the sound buffer
+
Returns:
True if saving has been successful
+ +

Definition at line 192 of file SoundBuffer.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::SoundBufferRecorder Member List

This is the complete list of members for sf::SoundBufferRecorder, including all inherited members.

- - - + + + - -
CanCapture()sf::SoundRecorder [static]
GetBuffer() constsf::SoundBufferRecorder
GetSampleRate() constsf::SoundRecorder
CanCapture()sf::SoundRecorder [static]
GetBuffer() const sf::SoundBufferRecorder
GetSampleRate() const sf::SoundRecorder
SoundRecorder()sf::SoundRecorder [protected]
Start(unsigned int SampleRate=44100)sf::SoundRecorder
Stop()sf::SoundRecorder
~SoundRecorder()sf::SoundRecorder [virtual]
+ ~SoundRecorder()sf::SoundRecorder [virtual] +

+ - -
- + + -
- -
-
-sf::SoundBufferRecorder
+

sf::SoundBufferRecorder Class Reference

Specialized SoundRecorder which saves the captured audio data into a sound buffer. More...

#include <SoundBufferRecorder.hpp>

-

Inheritance diagram for sf::SoundBufferRecorder: +

+Inheritance diagram for sf::SoundBufferRecorder:
+
+

sf::SoundRecorder sf::Thread +
+ +

List of all members. - + - + - + - + - + - +

Public Member Functions

const SoundBuffer & GetBuffer () const
const SoundBuffer & GetBuffer () const
 Get the sound buffer containing the captured audio data.
 Get the sound buffer containing the captured audio data.
void Start (unsigned int SampleRate=44100)
 Start the capture.
void Stop ()
 Stop the capture.
unsigned int GetSampleRate () const
unsigned int GetSampleRate () const
 Get the sample rate.
 Get the sample rate.

Static Public Member Functions

static bool CanCapture ()
static bool CanCapture ()
 Tell if the system supports sound capture.
 Tell if the system supports sound capture.

Detailed Description

Specialized SoundRecorder which saves the captured audio data into a sound buffer. -

- -

-Definition at line 42 of file SoundBufferRecorder.hpp.

Member Function Documentation

- +

Definition at line 42 of file SoundBufferRecorder.hpp.

+

Member Function Documentation

+
- + - +
const SoundBuffer& sf::SoundBufferRecorder::GetBuffer bool sf::SoundRecorder::CanCapture (  )  const [static, inherited]

-Get the sound buffer containing the captured audio data. +Tell if the system supports sound capture.

-

Returns:
Constant reference to the sound buffer
+If not, this class won't be usable

+

Returns:
True if audio capture is supported
+If not, this class won't be usable +

Definition at line 136 of file SoundRecorder.cpp.

- +

- + - - + - +
void sf::SoundRecorder::Start const SoundBuffer & sf::SoundBufferRecorder::GetBuffer (unsigned int  SampleRate = 44100  )  [inherited] const

-Start the capture. +Get the sound buffer containing the captured audio data.

-Warning : only one capture can happen at the same time

-

Parameters:
- - -
SampleRate : Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)
-
+
Returns:
Constant reference to the sound buffer
+ +

Definition at line 70 of file SoundBufferRecorder.cpp.

- +

- + - +
void sf::SoundRecorder::Stop unsigned int sf::SoundRecorder::GetSampleRate (  )  [inherited] const [inherited]

-Stop the capture. +Get the sample rate.

+

Returns:
Frequency, in samples per second
+ +

Definition at line 126 of file SoundRecorder.cpp.

- +

- + - + + - +
unsigned int sf::SoundRecorder::GetSampleRate void sf::SoundRecorder::Start ( unsigned int  SampleRate = 44100  )  const [inherited] [inherited]

-Get the sample rate. +Start the capture.

-

Returns:
Frequency, in samples per second
+Warning : only one capture can happen at the same time

+

Parameters:
+ + +
SampleRate : Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)
+
+Warning : only one capture can happen at the same time +

Definition at line 69 of file SoundRecorder.cpp.

- +

- + - +
static bool sf::SoundRecorder::CanCapture void sf::SoundRecorder::Stop (  )  [static, inherited] [inherited]

-Tell if the system supports sound capture. +Stop the capture.

-If not, this class won't be usable

-

Returns:
True if audio capture is supported
+ +

Definition at line 115 of file SoundRecorder.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: +
- -
- -
-
- + + +

sf::SoundRecorder Member List

This is the complete list of members for sf::SoundRecorder, including all inherited members.

- - - + + + @@ -39,9 +42,10 @@ - - -
CanCapture()sf::SoundRecorder [static]
FuncType typedefsf::Thread [private]
GetSampleRate() constsf::SoundRecorder
CanCapture()sf::SoundRecorder [static]
FuncType typedef (defined in sf::Thread)sf::Thread [private]
GetSampleRate() const sf::SoundRecorder
Launch()sf::Thread [private]
SoundRecorder()sf::SoundRecorder [protected]
Start(unsigned int SampleRate=44100)sf::SoundRecorder
Thread(FuncType Function, void *UserData=NULL)sf::Thread [private]
Thread()sf::Thread [private]
Wait()sf::Thread [private]
~SoundRecorder()sf::SoundRecorder [virtual]
~Thread()sf::Thread [private, virtual]
+ ~SoundRecorder()sf::SoundRecorder [virtual] + ~Thread()sf::Thread [private, virtual] +

+ - -
- + + -
- -
-
-sf::SoundRecorder
+

sf::SoundRecorder Class Reference

SoundRecorder is an interface for capturing sound data, it is meant to be used as a base class. More...

#include <SoundRecorder.hpp>

-

Inheritance diagram for sf::SoundRecorder: +

+Inheritance diagram for sf::SoundRecorder:
+
+

sf::Thread sf::SoundBufferRecorder +
+ +

List of all members. - + - + - + - + - + - + + + + + + + + + + + + + +

Public Member Functions

virtual ~SoundRecorder ()
virtual ~SoundRecorder ()
 Virtual destructor.
 Virtual destructor.
void Start (unsigned int SampleRate=44100)
 Start the capture.
void Stop ()
 Stop the capture.
unsigned int GetSampleRate () const
unsigned int GetSampleRate () const
 Get the sample rate.
 Get the sample rate.

Static Public Member Functions

static bool CanCapture ()
static bool CanCapture ()
 Tell if the system supports sound capture.
 Tell if the system supports sound capture.

Protected Member Functions

 SoundRecorder ()
 Default constructor.

Private Types

+typedef void(* FuncType )(void *)

Private Member Functions

void Launch ()
 Create and run the thread.
void Wait ()
 Wait until the thread finishes.
void Terminate ()
 Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.

Detailed Description

SoundRecorder is an interface for capturing sound data, it is meant to be used as a base class. -

- -

-Definition at line 41 of file SoundRecorder.hpp.

Constructor & Destructor Documentation

- +

Definition at line 41 of file SoundRecorder.hpp.

+

Constructor & Destructor Documentation

+
- + - +
virtual sf::SoundRecorder::~SoundRecorder sf::SoundRecorder::~SoundRecorder (  )  [virtual] [virtual]
@@ -89,6 +110,8 @@ Definition at line 41< Virtual destructor.

+

Definition at line 59 of file SoundRecorder.cpp.

+

@@ -100,7 +123,7 @@ Virtual destructor. (  )  - [protected] + [protected]

@@ -110,105 +133,116 @@ Virtual destructor. Default constructor.

+

Definition at line 48 of file SoundRecorder.cpp.

+

Member Function Documentation

- +
- + - - + - +
void sf::SoundRecorder::Start bool sf::SoundRecorder::CanCapture (unsigned int  SampleRate = 44100  )  [static]

-Start the capture. +Tell if the system supports sound capture.

-Warning : only one capture can happen at the same time

-

Parameters:
- - -
SampleRate : Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)
-
+If not, this class won't be usable

+

Returns:
True if audio capture is supported
+If not, this class won't be usable +

Definition at line 136 of file SoundRecorder.cpp.

- +

- + - +
void sf::SoundRecorder::Stop unsigned int sf::SoundRecorder::GetSampleRate (  )  const

-Stop the capture. +Get the sample rate.

+

Returns:
Frequency, in samples per second
+ +

Definition at line 126 of file SoundRecorder.cpp.

- +

- + - + + - +
unsigned int sf::SoundRecorder::GetSampleRate void sf::SoundRecorder::Start ( unsigned int  SampleRate = 44100  )  const

-Get the sample rate. +Start the capture.

-

Returns:
Frequency, in samples per second
+Warning : only one capture can happen at the same time

+

Parameters:
+ + +
SampleRate : Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)
+
+Warning : only one capture can happen at the same time +

Definition at line 69 of file SoundRecorder.cpp.

- +

- + - +
static bool sf::SoundRecorder::CanCapture void sf::SoundRecorder::Stop (  )  [static]

-Tell if the system supports sound capture. +Stop the capture.

-If not, this class won't be usable

-

Returns:
True if audio capture is supported
+ +

Definition at line 115 of file SoundRecorder.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: +
- -
- -
-
- + + +

sf::SoundStream Member List

This is the complete list of members for sf::SoundStream, including all inherited members.

- - - - - - - - - - - - + + + + + + + + + + + + + - + @@ -57,23 +61,25 @@ + - + - + - - -
AudioResource()sf::AudioResource [private]
AudioResource(const AudioResource &)sf::AudioResource [private]
FuncType typedefsf::Thread [private]
GetAttenuation() constsf::Sound [private]
GetBuffer() constsf::Sound [private]
GetChannelsCount() constsf::SoundStream
GetLoop() constsf::SoundStream
GetMinDistance() constsf::Sound [private]
GetPitch() constsf::Sound [private]
GetPlayingOffset() constsf::SoundStream
GetPosition() constsf::Sound [private]
GetSampleRate() constsf::SoundStream
GetStatus() constsf::SoundStream
GetVolume() constsf::Sound [private]
FuncType typedef (defined in sf::Thread)sf::Thread [private]
GetAttenuation() const sf::Sound [private]
GetBuffer() const sf::Sound [private]
GetChannelsCount() const sf::SoundStream
GetLoop() const sf::SoundStream
GetMinDistance() const sf::Sound [private]
GetPitch() const sf::Sound [private]
GetPlayingOffset() const sf::SoundStream
GetPosition() const sf::Sound [private]
GetSampleRate() const sf::SoundStream
GetStatus() const sf::SoundStream
GetVolume() const sf::Sound [private]
Initialize(unsigned int ChannelsCount, unsigned int SampleRate)sf::SoundStream [protected]
IsRelativeToListener() const sf::Sound [private]
Launch()sf::Thread [private]
operator=(const Sound &Other)sf::Sound [private]
operator=(const Sound &Other)sf::Sound [private]
Pause()sf::Sound [private]
Paused enum valuesf::Sound [private]
Play()sf::SoundStream
SetPlayingOffset(float TimeOffset)sf::Sound [private]
SetPosition(float X, float Y, float Z)sf::Sound [private]
SetPosition(const Vector3f &Position)sf::Sound [private]
SetRelativeToListener(bool Relative)sf::Sound [private]
SetVolume(float Volume)sf::Sound [private]
Sound()sf::Sound [private]
Sound(const SoundBuffer &Buffer, bool Loop=false, float Pitch=1.f, float Volume=100.f, const Vector3f &Position=Vector3f(0, 0, 0))sf::Sound [private]
Sound(const Sound &Copy)sf::Sound [private]
SoundStream()sf::SoundStream [protected]
Status enum namesf::Sound [private]
Status enum namesf::SoundStream
Stop()sf::SoundStream
Stopped enum valuesf::Sound [private]
Terminate()sf::Thread [private]
Thread(FuncType Function, void *UserData=NULL)sf::Thread [private]
Thread()sf::Thread [private]
Wait()sf::Thread [private]
~AudioResource()sf::AudioResource [private, virtual]
~AudioResource()sf::AudioResource [private, virtual]
~Sound()sf::Sound [private]
~SoundStream()sf::SoundStream [virtual]
~Thread()sf::Thread [private, virtual]
+ ~SoundStream()sf::SoundStream [virtual] + ~Thread()sf::Thread [private, virtual] +

+ - -
- + + -
- -
-
-sf::SoundStream
+

sf::SoundStream Class Reference

SoundStream is a streamed sound, ie samples are acquired while the sound is playing. More...

#include <SoundStream.hpp>

-

Inheritance diagram for sf::SoundStream: +

+Inheritance diagram for sf::SoundStream:
+
+

sf::Thread sf::Sound sf::Music +
+ +

List of all members. + + + + + + + + - + - + - + - - + + - - + + - - + + - + - + - + @@ -78,29 +95,108 @@ - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

struct  Chunk
 Structure defining a chunk of audio data to stream. More...

Public Types

enum  Status
 Enumeration of the sound states. More...

Public Member Functions

virtual ~SoundStream ()
virtual ~SoundStream ()
 Virtual destructor.
 Virtual destructor.
void Play ()
 Start playing the audio stream.
void Stop ()
 Stop playing the audio stream.
unsigned int GetChannelsCount () const
unsigned int GetChannelsCount () const
 Return the number of channels (1 = mono, 2 = stereo).
unsigned int GetSampleRate () const
 Return the number of channels (1 = mono, 2 = stereo).
unsigned int GetSampleRate () const
 Get the stream sample rate.
Status GetStatus () const
 Get the stream sample rate.
Status GetStatus () const
 Get the status of the stream (stopped, paused, playing).
float GetPlayingOffset () const
 Get the status of the stream (stopped, paused, playing).
float GetPlayingOffset () const
 Get the current playing position of the stream.
 Get the current playing position of the stream.
void SetLoop (bool Loop)
 Set the stream loop state.
bool GetLoop () const
bool GetLoop () const
 Tell whether or not the stream is looping.
 Tell whether or not the stream is looping.

Protected Member Functions

 SoundStream ()
void Initialize (unsigned int ChannelsCount, unsigned int SampleRate)
 Set the audio stream parameters, you must call it before Play().

Classes

struct  Chunk

Private Types

+typedef void(* FuncType )(void *)
 Structure defining a chunk of audio data to stream. More...

Private Member Functions

void Launch ()
 Create and run the thread.
void Wait ()
 Wait until the thread finishes.
void Terminate ()
 Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.
void Pause ()
 Pause the sound.
void SetBuffer (const SoundBuffer &Buffer)
 Set the source buffer.
void SetPitch (float Pitch)
 Set the sound pitch.
void SetVolume (float Volume)
 Set the sound volume.
void SetPosition (float X, float Y, float Z)
 Set the sound position (take 3 values).
void SetPosition (const Vector3f &Position)
 Set the sound position (take a 3D vector).
void SetRelativeToListener (bool Relative)
 Make the sound's position relative to the listener's position, or absolute.
void SetMinDistance (float MinDistance)
 Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.
void SetAttenuation (float Attenuation)
 Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener.
void SetPlayingOffset (float TimeOffset)
 Set the current playing position of the sound.
const SoundBuffer * GetBuffer () const
 Get the source buffer.
float GetPitch () const
 Get the pitch.
float GetVolume () const
 Get the volume.
Vector3f GetPosition () const
 Get the sound position.
bool IsRelativeToListener () const
 Tell if the sound's position is relative to the listener's position, or if it's absolute.
float GetMinDistance () const
 Get the minimum distance.
float GetAttenuation () const
 Get the attenuation factor.

Detailed Description

SoundStream is a streamed sound, ie samples are acquired while the sound is playing.

Use it for big sounds that would require hundreds of MB in memory (see Music), or for streaming sound from the network -

+

Definition at line 44 of file SoundStream.hpp.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum sf::Sound::Status
+
+

-Definition at line 44 of file SoundStream.hpp.

Constructor & Destructor Documentation

- +Enumeration of the sound states. +

+ +

Definition at line 52 of file Sound.hpp.

+ +
+

+

Constructor & Destructor Documentation

+
- + - +
virtual sf::SoundStream::~SoundStream sf::SoundStream::~SoundStream (  )  [virtual] [virtual]
@@ -110,6 +206,8 @@ Definition at line 44 +

Definition at line 54 of file SoundStream.cpp.

+

@@ -121,7 +219,7 @@ Virtual destructor. (  )  - [protected] + [protected]

@@ -131,78 +229,91 @@ Virtual destructor. Default constructor.

+

Definition at line 39 of file SoundStream.cpp.

+

Member Function Documentation

- +
- + - +
void sf::SoundStream::Play unsigned int sf::SoundStream::GetChannelsCount (  )  const

-Start playing the audio stream. +Return the number of channels (1 = mono, 2 = stereo).

+Return the number of channels (1 = mono, 2 = stereo, .

+

Returns:
Number of channels
+..) +

Definition at line 126 of file SoundStream.cpp.

-

-Reimplemented from sf::Sound.

- +

- + - +
void sf::SoundStream::Stop bool sf::SoundStream::GetLoop (  )  const

-Stop playing the audio stream. +Tell whether or not the stream is looping.

+Tell whether or not the music is looping.

+

Returns:
True if the music is looping, false otherwise
+ +

Reimplemented from sf::Sound.

+ +

Definition at line 180 of file SoundStream.cpp.

-

-Reimplemented from sf::Sound.

- +

- + - +
unsigned int sf::SoundStream::GetChannelsCount float sf::SoundStream::GetPlayingOffset (  )  const const

-Return the number of channels (1 = mono, 2 = stereo). +Get the current playing position of the stream.

-

Returns:
Number of channels
+
Returns:
Current playing position, expressed in seconds

+Current playing position, expressed in seconds

+ +

Reimplemented from sf::Sound.

+ +

Definition at line 162 of file SoundStream.cpp.

- +

@@ -211,7 +322,7 @@ Return the number of channels (1 = mono, 2 = stereo). - +
(  )  const const
@@ -220,20 +331,23 @@ Return the number of channels (1 = mono, 2 = stereo).

Get the stream sample rate.

+Get the sound frequency (sample rate).

Returns:
Stream frequency (number of samples per second)
+

Definition at line 135 of file SoundStream.cpp.

+

- +

- + - +
Status sf::SoundStream::GetStatus Sound::Status sf::SoundStream::GetStatus (  )  const const
@@ -242,34 +356,77 @@ Get the stream sample rate.

Get the status of the stream (stopped, paused, playing).

+Get the status of the sound (stopped, paused, playing).

Returns:
Current status of the sound
+

Reimplemented from sf::Sound.

+ +

Definition at line 144 of file SoundStream.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void sf::SoundStream::Initialize (unsigned int  ChannelsCount,
unsigned int  SampleRate 
) [protected]
+
+
+

-Reimplemented from sf::Sound. +Set the audio stream parameters, you must call it before Play(). +

+

Parameters:
+ + + +
ChannelsCount : Number of channels
SampleRate : Sample rate
+
+ +

Definition at line 64 of file SoundStream.cpp.

+

- +

- + - +
float sf::SoundStream::GetPlayingOffset void sf::SoundStream::Play (  )  const

-Get the current playing position of the stream. +Start playing the audio stream.

-

Returns:
Current playing position, expressed in seconds
-

-Reimplemented from sf::Sound. +

Reimplemented from sf::Sound.

+ +

Definition at line 85 of file SoundStream.cpp.

+

@@ -282,7 +439,7 @@ Reimplemented from bool  Loop  )  - + @@ -291,6 +448,7 @@ Reimplemented from @@ -298,73 +456,40 @@ This parameter is disabled by default

-

-Reimplemented from sf::Sound. +

Reimplemented from sf::Sound.

+ +

Definition at line 171 of file SoundStream.cpp.

+

- +

- + - +
bool sf::SoundStream::GetLoop void sf::SoundStream::Stop (  )  const

-Tell whether or not the stream is looping. +Stop playing the audio stream.

-

Returns:
True if the music is looping, false otherwise
-

-Reimplemented from sf::Sound. -

-

- -

-
- - - - - - - - - - - - - - - - - - -
void sf::SoundStream::Initialize (unsigned int  ChannelsCount,
unsigned int  SampleRate 
) [protected]
-
-
+

Reimplemented from sf::Sound.

-

-Set the audio stream parameters, you must call it before Play(). -

-

Parameters:
- - - -
ChannelsCount : Number of channels
SampleRate : Sample rate
-
+

Definition at line 115 of file SoundStream.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Sprite Member List

This is the complete list of members for sf::Sprite, including all inherited members.

- - - - - - - - - - - - + + + + + + + + + + + + - + @@ -70,8 +73,9 @@ - -
Drawable(const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))sf::Drawable
FlipX(bool Flipped)sf::Sprite
FlipY(bool Flipped)sf::Sprite
GetBlendMode() constsf::Drawable
GetCenter() constsf::Drawable
GetColor() constsf::Drawable
GetImage() constsf::Sprite
GetInverseMatrix() constsf::Drawable [protected]
GetMatrix() constsf::Drawable [protected]
GetPixel(unsigned int X, unsigned int Y) constsf::Sprite
GetPosition() constsf::Drawable
GetRotation() constsf::Drawable
GetScale() constsf::Drawable
GetSize() constsf::Sprite
GetSubRect() constsf::Sprite
GetBlendMode() const sf::Drawable
GetCenter() const sf::Drawable
GetColor() const sf::Drawable
GetImage() const sf::Sprite
GetInverseMatrix() const sf::Drawable [protected]
GetMatrix() const sf::Drawable [protected]
GetPixel(unsigned int X, unsigned int Y) const sf::Sprite
GetPosition() const sf::Drawable
GetRotation() const sf::Drawable
GetScale() const sf::Drawable
GetSize() const sf::Sprite
GetSubRect() const sf::Sprite
Move(float OffsetX, float OffsetY)sf::Drawable
Move(const Vector2f &Offset)sf::Drawable
Render(RenderTarget &Target) const sf::Sprite [protected, virtual]
Render(RenderTarget &Target) const sf::Sprite [protected, virtual]
Resize(float Width, float Height)sf::Sprite
Resize(const Vector2f &Size)sf::Sprite
Rotate(float Angle)sf::Drawable
Sprite(const Image &Img, const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))sf::Sprite
TransformToGlobal(const sf::Vector2f &Point) const sf::Drawable
TransformToLocal(const sf::Vector2f &Point) const sf::Drawable
~Drawable()sf::Drawable [virtual]
+ ~Drawable()sf::Drawable [virtual] +

+ - -
- -
-
- -
-
-sf::Sprite
+ + +

sf::Sprite Class Reference

Sprite defines a sprite : texture, transformations, color, and draw on screen. More...

#include <Sprite.hpp>

-

Inheritance diagram for sf::Sprite: +

+Inheritance diagram for sf::Sprite:
+
+

sf::Drawable +
+ +

List of all members. @@ -66,18 +75,18 @@ - + - - + + - - + + - - + + - + @@ -117,24 +126,24 @@ - + - - + + - - + + - - + + - - + + - - + + - + @@ -157,22 +166,20 @@ - + - - + + - - + + - +

Public Member Functions

void FlipY (bool Flipped)
 Flip the sprite vertically.
const Image * GetImage () const
const Image * GetImage () const
 Get the source image of the sprite.
const IntRect & GetSubRect () const
 Get the source image of the sprite.
const IntRect & GetSubRect () const
 Get the sub-rectangle of the sprite inside the source image.
Vector2f GetSize () const
 Get the sub-rectangle of the sprite inside the source image.
Vector2f GetSize () const
 Get the sprite size.
Color GetPixel (unsigned int X, unsigned int Y) const
 Get the sprite size.
Color GetPixel (unsigned int X, unsigned int Y) const
 Get the color of a given pixel in the sprite (point is in local coordinates).
 Get the color of a given pixel in the sprite (point is in local coordinates).
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values).
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
const Vector2f & GetPosition () const
const Vector2f & GetPosition () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values).
 Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Protected Member Functions

virtual void Render (RenderTarget &Target) const
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the inverse transform matrix of the drawable.
 Get the inverse transform matrix of the drawable.

Detailed Description

Sprite defines a sprite : texture, transformations, color, and draw on screen. -

- -

-Definition at line 44 of file Sprite.hpp.

Constructor & Destructor Documentation

+

Definition at line 44 of file Sprite.hpp.

+

Constructor & Destructor Documentation

@@ -182,7 +189,7 @@ Definition at line 44 of (  )  - +
@@ -192,6 +199,8 @@ Definition at line 44 of Default constructor.

+

Definition at line 38 of file Sprite.cpp.

+

@@ -231,7 +240,7 @@ Default constructor. ) - +

@@ -250,194 +259,151 @@ Construct the sprite from a source image. +

Definition at line 50 of file Sprite.cpp.

+

Member Function Documentation

- +
- + - - + + - +
void sf::Sprite::SetImage void sf::Sprite::FlipX (const Image &  Img bool  Flipped  ) 

-Change the image of the sprite. +Flip the sprite horizontally.

Parameters:
- +
Img : New image
Flipped : True to flip the sprite
-
-

- -

-
- - - - - - - - - -
void sf::Sprite::SetSubRect (const IntRect &  SubRect  ) 
-
-
- -

-Set the sub-rectangle of the sprite inside the source image. -

-By default, the subrect covers the entire source image

-

Parameters:
- - -
SubRect : New sub-rectangle
-
+

Definition at line 112 of file Sprite.cpp.

- +

- + - - - - - - - - - - + + + - -
void sf::Sprite::Resize void sf::Sprite::FlipY (float  Width,
float  Height 
bool  Flipped  )  )

-Resize the sprite (by changing its scale factors) (take 2 values). +Flip the sprite vertically.

-The default size is defined by the subrect

Parameters:
- - +
Width : New width (must be strictly positive)
Height : New height (must be strictly positive)
Flipped : True to flip the sprite
+

Definition at line 121 of file Sprite.cpp.

+

- +

- + - - + - +
void sf::Sprite::Resize Blend::Mode sf::Drawable::GetBlendMode (const Vector2f &  Size  )  const [inherited]

-Resize the sprite (by changing its scale factors) (take a 2D vector). +Get the current blending mode.

-The default size is defined by the subrect

-

Parameters:
- - -
Size : New size (both coordinates must be strictly positive)
-
+
Returns:
Current blending mode
+ +

Definition at line 258 of file Drawable.cpp.

- +

- + - - + - +
void sf::Sprite::FlipX const Vector2f & sf::Drawable::GetCenter (bool  Flipped  )  const [inherited]

-Flip the sprite horizontally. +Get the center of the object.

-

Parameters:
- - -
Flipped : True to flip the sprite
-
+
Returns:
Current position of the center
+ +

Definition at line 231 of file Drawable.cpp.

- +

- + - - + - +
void sf::Sprite::FlipY const Color & sf::Drawable::GetColor (bool  Flipped  )  const [inherited]

-Flip the sprite vertically. +Get the color of the object.

-

Parameters:
- - -
Flipped : True to flip the sprite
-
+
Returns:
Current color
+ +

Definition at line 249 of file Drawable.cpp.

- +

- + - +
const Image* sf::Sprite::GetImage const Image * sf::Sprite::GetImage (  )  const const
@@ -448,53 +414,59 @@ Get the source image of the sprite.

Returns:
Pointer to the image (can be NULL)
+

Definition at line 130 of file Sprite.cpp.

+

- +

- + - +
const IntRect& sf::Sprite::GetSubRect const Matrix3 & sf::Drawable::GetInverseMatrix (  )  const const [protected, inherited]

-Get the sub-rectangle of the sprite inside the source image. +Get the inverse transform matrix of the drawable.

-

Returns:
Sub-rectangle
+
Returns:
Inverse transform matrix
+ +

Definition at line 350 of file Drawable.cpp.

- +

- + - +
Vector2f sf::Sprite::GetSize const Matrix3 & sf::Drawable::GetMatrix (  )  const const [protected, inherited]

-Get the sprite size. +Get the transform matrix of the drawable.

-

Returns:
Size of the sprite
+
Returns:
Transform matrix
+ +

Definition at line 334 of file Drawable.cpp.

- +

@@ -513,7 +485,7 @@ Get the sprite size. - +
) const const
@@ -522,6 +494,7 @@ Get the sprite size.

Get the color of a given pixel in the sprite (point is in local coordinates).

+Get the color of a given pixel in the sprite (point is in local coordinates).

Parameters:
@@ -530,387 +503,391 @@ Get the color of a given pixel in the sprite (point is in local coordinates).
Returns:
Color of pixel (X, Y)
+

Definition at line 158 of file Sprite.cpp.

+

- +

X : X coordinate of the pixel to get
- + - - + - +
virtual void sf::Sprite::Render const Vector2f & sf::Drawable::GetPosition (RenderTarget &  Target  )  const [protected, virtual] const [inherited]

-/see Drawable::Render +Get the position of the object.

+

Returns:
Current position
+ +

Definition at line 213 of file Drawable.cpp.

-

-Implements sf::Drawable.

- +

- + - - - - - - - - + + + +
void sf::Drawable::SetPosition float sf::Drawable::GetRotation (float  X,
float  Y   )  const [inherited]
+
+
+ +

+Get the orientation of the object. +

+Rotation is always in the range [0, 360]

+

Returns:
Current rotation, in degrees
+ +

Definition at line 240 of file Drawable.cpp.

+ +
+

+ +

+
+ - - - + + + + +
) [inherited]const Vector2f & sf::Drawable::GetScale (  )  const [inherited]

-Set the position of the object (take 2 values). +Get the current scale of the object.

-

Parameters:
- - - -
X : New X coordinate
Y : New Y coordinate
-
+
Returns:
Current scale factor (always positive)
+ +

Definition at line 222 of file Drawable.cpp.

- +

- + - - + - +
void sf::Drawable::SetPosition Vector2f sf::Sprite::GetSize (const Vector2f &  Position  )  [inherited] const

-Set the position of the object (take a 2D vector). +Get the sprite size.

-

Parameters:
- - -
Position : New position
-
+
Returns:
Size of the sprite
+ +

Definition at line 148 of file Sprite.cpp.

- +

- + - - + - +
void sf::Drawable::SetX const IntRect & sf::Sprite::GetSubRect (float  X  )  [inherited] const

-Set the X position of the object. +Get the sub-rectangle of the sprite inside the source image.

-

Parameters:
- - -
X : New X coordinate
-
+
Returns:
Sub-rectangle
+ +

Definition at line 139 of file Sprite.cpp.

- +

- + - - + + - +
void sf::Drawable::SetY void sf::Drawable::Move (float  Y const Vector2f &  Offset  )  [inherited] [inherited]

-Set the Y position of the object. +Move the object of a given offset (take a 2D vector).

Parameters:
- +
Y : New Y coordinate
Offset : Amount of units to move the object of
+

Definition at line 278 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::SetScale void sf::Drawable::Move ( float  ScaleX, OffsetX,
float  ScaleY  OffsetY 
) [inherited] [inherited]

-Set the scale of the object (take 2 values). +Move the object of a given offset (take 2 values).

Parameters:
- - + +
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
OffsetX : X offset
OffsetY : Y offset
+

Definition at line 268 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetScale void sf::Sprite::Render (const Vector2f &  Scale RenderTarget &  Target  )  [inherited] const [protected, virtual]

-Set the scale of the object (take a 2D vector). +/see Drawable::Render

-

Parameters:
- - -
Scale : New scale (both values must be strictly positive)
-
+/see sfDrawable::Render +

Implements sf::Drawable.

+ +

Definition at line 180 of file Sprite.cpp.

- +

- + - - + + - +
void sf::Drawable::SetScaleX void sf::Sprite::Resize (float  FactorX const Vector2f &  Size  )  [inherited]

-Set the X scale factor of the object. +Resize the sprite (by changing its scale factors) (take a 2D vector).

+Resize the object (by changing its scale factors) (take a 2D vector) The default size is defined by the subrect.

+The default size is defined by the subrect

Parameters:
- +
X : New X scale factor
Size : New size (both coordinates must be strictly positive)
-
-

- -

-
- - - - - - - - - -
void sf::Drawable::SetScaleY (float  FactorY  )  [inherited]
-
-
- -

-Set the Y scale factor of the object. -

-

Parameters:
- - -
Y : New Y scale factor
-
+

Definition at line 103 of file Sprite.cpp.

- +

- + - + - + - +
void sf::Drawable::SetCenter void sf::Sprite::Resize ( float  CenterX, Width,
float  CenterY  Height 
) [inherited]

-Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). +Resize the sprite (by changing its scale factors) (take 2 values).

-The default center is (0, 0)

+The default size is defined by the subrect

Parameters:
- - + +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
Width : New width (must be strictly positive)
Height : New height (must be strictly positive)
+The default size is defined by the subrect +

Definition at line 89 of file Sprite.cpp.

- +

- + - - + + - +
void sf::Drawable::SetCenter void sf::Drawable::Rotate (const Vector2f &  Center float  Angle  )  [inherited] [inherited]

-Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector). +Rotate the object.

-The default center is (0, 0)

Parameters:
- +
Center : New center
Angle : Angle of rotation, in degrees
+

Definition at line 306 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetRotation void sf::Drawable::Scale (float  Rotation const Vector2f &  Factor  )  [inherited] [inherited]

-Set the orientation of the object. +Scale the object (take a 2D vector).

Parameters:
- +
Rotation : Angle of rotation, in degrees
Factor : Scaling factors (both values must be strictly positive)
+

Definition at line 297 of file Drawable.cpp.

+

- +

- + - - - - + + + + + + + + + + + + +
void sf::Drawable::SetColor void sf::Drawable::Scale (const Color &  Col  )  [inherited]float  FactorX,
float  FactorY 
) [inherited]

-Set the color of the object. +Scale the object (take 2 values).

-The default color is white

Parameters:
- + +
Col : New color
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
+

Definition at line 287 of file Drawable.cpp.

+

@@ -923,7 +900,7 @@ The default color is white

Blend::Mode  Mode  )  - [inherited] + [inherited] @@ -935,402 +912,522 @@ Set the blending mode for the object. The default blend mode is Blend::Alpha

Parameters:
- +
Mode : New blending mode
Mode : New blending mode
+The default blend mode is Blend::Alpha +

Definition at line 204 of file Drawable.cpp.

- +

- + - + + - +
const Vector2f& sf::Drawable::GetPosition void sf::Drawable::SetCenter ( const Vector2f &  Center  )  const [inherited] [inherited]

-Get the position of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

-

Returns:
Current position
+Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

+The default center is (0, 0)

+

Parameters:
+ + +
Center : New center
+
+The default center is (0, 0) +

Definition at line 171 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetScale void sf::Drawable::SetCenter (  )  const [inherited]float  CenterX,
float  CenterY 
) [inherited]

-Get the current scale of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

-

Returns:
Current scale factor (always positive)
+Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+The default center is (0, 0)

+

Parameters:
+ + + +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
+
+The default center is (0, 0) +

Definition at line 157 of file Drawable.cpp.

- +

- + - + + - +
const Vector2f& sf::Drawable::GetCenter void sf::Drawable::SetColor ( const Color &  Col  )  const [inherited] [inherited]

-Get the center of the object. +Set the color of the object.

-

Returns:
Current position of the center
+The default color is white

+

Parameters:
+ + +
Col : New color
+
+The default color is white +

Definition at line 194 of file Drawable.cpp.

- +

- + - + + - +
float sf::Drawable::GetRotation void sf::Sprite::SetImage ( const Image &  Img  )  const [inherited]

-Get the orientation of the object. +Change the image of the sprite.

-Rotation is always in the range [0, 360]

-

Returns:
Current rotation, in degrees
+Set the image of the sprite.

+

Parameters:
+ + +
Img : New image
+
+ +

Definition at line 63 of file Sprite.cpp.

- +

- + - + + - +
const Color& sf::Drawable::GetColor void sf::Drawable::SetPosition ( const Vector2f &  Position  )  const [inherited] [inherited]

-Get the color of the object. +Set the position of the object (take a 2D vector).

-

Returns:
Current color
+
Parameters:
+ + +
Position : New position
+
+ +

Definition at line 75 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + + +
Blend::Mode sf::Drawable::GetBlendMode void sf::Drawable::SetPosition (  )  const [inherited]float  X,
float  Y 
) [inherited]

-Get the current blending mode. +Set the position of the object (take 2 values).

-

Returns:
Current blending mode
+
Parameters:
+ + + +
X : New X coordinate
Y : New Y coordinate
+
+ +

Definition at line 65 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - + + +
void sf::Drawable::Move void sf::Drawable::SetRotation ( float  OffsetX,
float  OffsetY 
) [inherited] Rotation  )  [inherited]

-Move the object of a given offset (take 2 values). +Set the orientation of the object.

Parameters:
- - +
OffsetX : X offset
OffsetY : Y offset
Rotation : Angle of rotation, in degrees
+

Definition at line 180 of file Drawable.cpp.

+

- +

- + - + - +
void sf::Drawable::Move void sf::Drawable::SetScale ( const Vector2f &  Offset Scale  )  [inherited] [inherited]

-Move the object of a given offset (take a 2D vector). +Set the scale of the object (take a 2D vector).

Parameters:
- +
Offset : Amount of units to move the object of
Scale : New scale (both values must be strictly positive)
+

Definition at line 117 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::Scale void sf::Drawable::SetScale ( float  FactorX, ScaleX,
float  FactorY  ScaleY 
) [inherited] [inherited]

-Scale the object (take 2 values). +Set the scale of the object (take 2 values).

Parameters:
- - + +
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
+

Definition at line 107 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Scale void sf::Drawable::SetScaleX (const Vector2f &  Factor float  FactorX  )  [inherited] [inherited]

-Scale the object (take a 2D vector). +Set the X scale factor of the object.

Parameters:
- +
Factor : Scaling factors (both values must be strictly positive)
X : New X scale factor
+

Definition at line 127 of file Drawable.cpp.

+

- +

- + - + - +
void sf::Drawable::Rotate void sf::Drawable::SetScaleY ( float  Angle FactorY  )  [inherited] [inherited]

-Rotate the object. +Set the Y scale factor of the object.

Parameters:
- +
Angle : Angle of rotation, in degrees
Y : New Y scale factor
+

Definition at line 141 of file Drawable.cpp.

+

- +

- + - - + + - +
sf::Vector2f sf::Drawable::TransformToLocal void sf::Sprite::SetSubRect (const sf::Vector2f &  Point const IntRect &  SubRect  )  const [inherited]

-Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point). +Set the sub-rectangle of the sprite inside the source image.

+By default, the subrect covers the entire source image

Parameters:
- +
Point : Point to transform
SubRect : New sub-rectangle
-
Returns:
Transformed point
+ +

Definition at line 79 of file Sprite.cpp.

- +

- + - - + + - +
sf::Vector2f sf::Drawable::TransformToGlobal void sf::Drawable::SetX (const sf::Vector2f &  Point float  X  )  const [inherited] [inherited]

-Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point). +Set the X position of the object.

Parameters:
- +
Point : Point to transform
X : New X coordinate
-
Returns:
Transformed point
+ +

Definition at line 85 of file Drawable.cpp.

- +

- + - + + - +
const Matrix3& sf::Drawable::GetMatrix void sf::Drawable::SetY ( float  Y  )  const [protected, inherited] [inherited]

-Get the transform matrix of the drawable. +Set the Y position of the object.

-

Returns:
Transform matrix
+
Parameters:
+ + +
Y : New Y coordinate
+
+ +

Definition at line 96 of file Drawable.cpp.

- +

- + - + + - +
const Matrix3& sf::Drawable::GetInverseMatrix sf::Vector2f sf::Drawable::TransformToGlobal ( const sf::Vector2f &  Point  )  const [protected, inherited] const [inherited]

-Get the inverse transform matrix of the drawable. +Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

-

Returns:
Inverse transform matrix
+Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+ +

Definition at line 325 of file Drawable.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
sf::Vector2f sf::Drawable::TransformToLocal (const sf::Vector2f &  Point  )  const [inherited]
+
+
+ +

+Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point). +

+Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+ +

Definition at line 316 of file Drawable.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::String Member List

This is the complete list of members for sf::String, including all inherited members.

- - + + - - - - - - - - - - - + + + + + + + + + + + - + @@ -75,8 +78,9 @@ - -
Bold enum valuesf::String
Drawable(const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))sf::Drawable
GetBlendMode() constsf::Drawable
GetCenter() constsf::Drawable
GetBlendMode() const sf::Drawable
GetCenter() const sf::Drawable
GetCharacterPos(std::size_t Index) const sf::String
GetColor() constsf::Drawable
GetFont() constsf::String
GetInverseMatrix() constsf::Drawable [protected]
GetMatrix() constsf::Drawable [protected]
GetPosition() constsf::Drawable
GetRect() constsf::String
GetRotation() constsf::Drawable
GetScale() constsf::Drawable
GetSize() constsf::String
GetStyle() constsf::String
GetText() constsf::String
GetColor() const sf::Drawable
GetFont() const sf::String
GetInverseMatrix() const sf::Drawable [protected]
GetMatrix() const sf::Drawable [protected]
GetPosition() const sf::Drawable
GetRect() const sf::String
GetRotation() const sf::Drawable
GetScale() const sf::Drawable
GetSize() const sf::String
GetStyle() const sf::String
GetText() const sf::String
Italic enum valuesf::String
Move(float OffsetX, float OffsetY)sf::Drawable
Move(const Vector2f &Offset)sf::Drawable
Regular enum valuesf::String
Render(RenderTarget &Target) const sf::String [protected, virtual]
Render(RenderTarget &Target) const sf::String [protected, virtual]
Rotate(float Angle)sf::Drawable
Scale(float FactorX, float FactorY)sf::Drawable
Scale(const Vector2f &Factor)sf::Drawable
TransformToGlobal(const sf::Vector2f &Point) const sf::Drawable
TransformToLocal(const sf::Vector2f &Point) const sf::Drawable
Underlined enum valuesf::String
~Drawable()sf::Drawable [virtual]
+ ~Drawable()sf::Drawable [virtual] +

+ - -
- -
-
- -
-
-sf::String
+ + +

sf::String Class Reference

String defines a graphical 2D text, that can be drawn on screen. More...

#include <String.hpp>

-

Inheritance diagram for sf::String: +

+Inheritance diagram for sf::String:
+
+

sf::Drawable +
+ +

List of all members. @@ -73,24 +82,24 @@ - + - - + + - - + + - - + + - + - + - + @@ -130,24 +139,24 @@ - + - - + + - - + + - - + + - - + + - - + + - + @@ -170,22 +179,20 @@ - + - - + + - - + + - +

Public Types

void SetStyle (unsigned long TextStyle)
 Set the style of the text The default style is Regular.
const Unicode::Text & GetText () const
const Unicode::Text & GetText () const
 Get the text (the returned text can be converted implicitely to any kind of string).
const Font & GetFont () const
 Get the text (the returned text can be converted implicitely to any kind of string).
const Font & GetFont () const
 Get the font used by the string.
float GetSize () const
 Get the font used by the string.
float GetSize () const
 Get the size of the characters.
unsigned long GetStyle () const
 Get the size of the characters.
unsigned long GetStyle () const
 Get the style of the text.
 Get the style of the text.
sf::Vector2f GetCharacterPos (std::size_t Index) const
 Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied).
FloatRect GetRect () const
FloatRect GetRect () const
 Get the string rectangle on screen.
 Get the string rectangle on screen.
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values).
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
const Vector2f & GetPosition () const
const Vector2f & GetPosition () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values).
 Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Protected Member Functions

virtual void Render (RenderTarget &Target) const
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the transform matrix of the drawable.
const Matrix3 & GetInverseMatrix () const
 Get the inverse transform matrix of the drawable.
 Get the inverse transform matrix of the drawable.

Detailed Description

String defines a graphical 2D text, that can be drawn on screen. -

- -

-Definition at line 44 of file String.hpp.

Member Enumeration Documentation

+

Definition at line 44 of file String.hpp.

+

Member Enumeration Documentation

@@ -213,8 +220,8 @@ Characters are underlined. -

-Definition at line 51 of file String.hpp. +

Definition at line 51 of file String.hpp.

+

Constructor & Destructor Documentation

@@ -227,7 +234,7 @@ Definition at line 51 of (  )  - +
@@ -237,6 +244,8 @@ Definition at line 51 of Default constructor.

+

Definition at line 39 of file String.cpp.

+

@@ -264,7 +273,7 @@ Default constructor. ) - [explicit] + [explicit] @@ -281,551 +290,574 @@ Construct the string from any kind of text. +

Definition at line 52 of file String.cpp.

+

Member Function Documentation

- +
- + - - + - +
void sf::String::SetText Blend::Mode sf::Drawable::GetBlendMode (const Unicode::Text &  Text  )  const [inherited]

-Set the text (from any kind of string). +Get the current blending mode.

-

Parameters:
- - -
Text : New text
-
+
Returns:
Current blending mode
+ +

Definition at line 258 of file Drawable.cpp.

- +

- + - - + - +
void sf::String::SetFont const Vector2f & sf::Drawable::GetCenter (const Font &  CharFont  )  const [inherited]

-Set the font of the string. +Get the center of the object.

-

Parameters:
- - -
Font : Font to use
-
+
Returns:
Current position of the center
+ +

Definition at line 231 of file Drawable.cpp.

- +

- + - - + + - +
void sf::String::SetSize sf::Vector2f sf::String::GetCharacterPos (float  Size std::size_t  Index  )  const

-Set the size of the string The default size is 30. +Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied).

+Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied).

Parameters:
- +
Size : New size, in pixels
Index : Index of the character
+
Returns:
Position of the Index-th character (end of string if Index is out of range)
+ +

Definition at line 153 of file String.cpp.

- +

- + - - + - +
void sf::String::SetStyle const Color & sf::Drawable::GetColor (unsigned long  TextStyle  )  const [inherited]

-Set the style of the text The default style is Regular. +Get the color of the object.

-

Parameters:
- - -
TextStyle : New text style, (combination of Style enum values)
-
+
Returns:
Current color
+ +

Definition at line 249 of file Drawable.cpp.

- +

- + - +
const Unicode::Text& sf::String::GetText const Font & sf::String::GetFont (  )  const const

-Get the text (the returned text can be converted implicitely to any kind of string). +Get the font used by the string.

-

Returns:
String's text
+
Returns:
Font used
+ +

Definition at line 124 of file String.cpp.

- +

- + - +
const Font& sf::String::GetFont const Matrix3 & sf::Drawable::GetInverseMatrix (  )  const const [protected, inherited]

-Get the font used by the string. +Get the inverse transform matrix of the drawable.

-

Returns:
Font used
+
Returns:
Inverse transform matrix
+ +

Definition at line 350 of file Drawable.cpp.

- +

- + - +
float sf::String::GetSize const Matrix3 & sf::Drawable::GetMatrix (  )  const const [protected, inherited]

-Get the size of the characters. +Get the transform matrix of the drawable.

-

Returns:
Size of the characters
+
Returns:
Transform matrix
+ +

Definition at line 334 of file Drawable.cpp.

- +

- + - +
unsigned long sf::String::GetStyle const Vector2f & sf::Drawable::GetPosition (  )  const const [inherited]

-Get the style of the text. +Get the position of the object.

-

Returns:
Current string style (combination of Style enum values)
+
Returns:
Current position
+ +

Definition at line 213 of file Drawable.cpp.

- +

- + - - + - +
sf::Vector2f sf::String::GetCharacterPos FloatRect sf::String::GetRect (std::size_t  Index  )  const const

-Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied). +Get the string rectangle on screen.

-

Parameters:
- - -
Index : Index of the character
-
-
Returns:
Position of the Index-th character (end of string if Index is out of range)
+
Returns:
Rectangle contaning the string in screen coordinates
+ +

Definition at line 195 of file String.cpp.

- +

- + - +
FloatRect sf::String::GetRect float sf::Drawable::GetRotation (  )  const const [inherited]

-Get the string rectangle on screen. +Get the orientation of the object.

-

Returns:
Rectangle contaning the string in screen coordinates
+Rotation is always in the range [0, 360]

+

Returns:
Current rotation, in degrees
+ +

Definition at line 240 of file Drawable.cpp.

- +

- + - - + - +
virtual void sf::String::Render const Vector2f & sf::Drawable::GetScale (RenderTarget &  Target  )  const [protected, virtual] const [inherited]

-/see Drawable::Render +Get the current scale of the object.

+

Returns:
Current scale factor (always positive)
+ +

Definition at line 222 of file Drawable.cpp.

-

-Implements sf::Drawable.

- +

- + - - - - - - - - - - - - - + + +
void sf::Drawable::SetPosition float sf::String::GetSize (float  X,
float  Y 
) [inherited]  )  const

-Set the position of the object (take 2 values). +Get the size of the characters.

-

Parameters:
- - - -
X : New X coordinate
Y : New Y coordinate
-
+
Returns:
Size of the characters
+ +

Definition at line 133 of file String.cpp.

- +

- + - - + - +
void sf::Drawable::SetPosition unsigned long sf::String::GetStyle (const Vector2f &  Position  )  [inherited] const

-Set the position of the object (take a 2D vector). +Get the style of the text.

-

Parameters:
- - -
Position : New position
-
+
Returns:
Current string style (combination of Style enum values)
+ +

Definition at line 142 of file String.cpp.

- +

- + - - + - +
void sf::Drawable::SetX const Unicode::Text & sf::String::GetText (float  X  )  [inherited] const

-Set the X position of the object. +Get the text (the returned text can be converted implicitely to any kind of string).

-

Parameters:
- - -
X : New X coordinate
-
+
Returns:
String's text
+ +

Definition at line 115 of file String.cpp.

- +

- + - - + + - +
void sf::Drawable::SetY void sf::Drawable::Move (float  Y const Vector2f &  Offset  )  [inherited] [inherited]

-Set the Y position of the object. +Move the object of a given offset (take a 2D vector).

Parameters:
- +
Y : New Y coordinate
Offset : Amount of units to move the object of
+

Definition at line 278 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::SetScale void sf::Drawable::Move ( float  ScaleX, OffsetX,
float  ScaleY  OffsetY 
) [inherited] [inherited]

-Set the scale of the object (take 2 values). +Move the object of a given offset (take 2 values).

Parameters:
- - + +
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
OffsetX : X offset
OffsetY : Y offset
+

Definition at line 268 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetScale void sf::String::Render (const Vector2f &  Scale RenderTarget &  Target  )  [inherited] const [protected, virtual]

-Set the scale of the object (take a 2D vector). +/see Drawable::Render

-

Parameters:
- - -
Scale : New scale (both values must be strictly positive)
-
+/see sfDrawable::Render +

Implements sf::Drawable.

+ +

Definition at line 213 of file String.cpp.

- +

- + - + - +
void sf::Drawable::SetScaleX void sf::Drawable::Rotate ( float  FactorX Angle  )  [inherited] [inherited]

-Set the X scale factor of the object. +Rotate the object.

Parameters:
- +
X : New X scale factor
Angle : Angle of rotation, in degrees
+

Definition at line 306 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::SetScaleY void sf::Drawable::Scale (float  FactorY const Vector2f &  Factor  )  [inherited] [inherited]

-Set the Y scale factor of the object. +Scale the object (take a 2D vector).

Parameters:
- +
Y : New Y scale factor
Factor : Scaling factors (both values must be strictly positive)
+

Definition at line 297 of file Drawable.cpp.

+

- +

- + - + - + - +
void sf::Drawable::SetCenter void sf::Drawable::Scale ( float  CenterX, FactorX,
float  CenterY  FactorY 
) [inherited] [inherited]

-Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). +Scale the object (take 2 values).

-The default center is (0, 0)

Parameters:
- - + +
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
+

Definition at line 287 of file Drawable.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void sf::Drawable::SetBlendMode (Blend::Mode  Mode  )  [inherited]
+
+
+ +

+Set the blending mode for the object. +

+The default blend mode is Blend::Alpha

+

Parameters:
+ + +
Mode : New blending mode
+
+The default blend mode is Blend::Alpha +

Definition at line 204 of file Drawable.cpp.

+

@@ -838,7 +870,7 @@ The default center is (0, 0)

const Vector2f &  Center  )  - [inherited] + [inherited] @@ -847,39 +879,56 @@ The default center is (0, 0)

Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

+Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

The default center is (0, 0)

Parameters:
- +
Center : New center
Center : New center
+The default center is (0, 0) +

Definition at line 171 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + +
void sf::Drawable::SetRotation void sf::Drawable::SetCenter ( float  Rotation  )  [inherited] CenterX,
float  CenterY 
) [inherited]

-Set the orientation of the object. +Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

+The default center is (0, 0)

Parameters:
- + +
Rotation : Angle of rotation, in degrees
CenterX : X coordinate of the center
CenterY : Y coordinate of the center
+The default center is (0, 0) +

Definition at line 157 of file Drawable.cpp.

@@ -893,7 +942,7 @@ Set the orientation of the object. const Color &  Col  )  - [inherited] + [inherited] @@ -905,353 +954,410 @@ Set the color of the object. The default color is white

Parameters:
- +
Col : New color
Col : New color
+The default color is white +

Definition at line 194 of file Drawable.cpp.

- +

- + - - + + - +
void sf::Drawable::SetBlendMode void sf::String::SetFont (Blend::Mode  Mode const Font &  CharFont  )  [inherited]

-Set the blending mode for the object. +Set the font of the string.

-The default blend mode is Blend::Alpha

Parameters:
- +
Mode : New blending mode
Font : Font to use
+

Definition at line 75 of file String.cpp.

+

- +

- + - + + - +
const Vector2f& sf::Drawable::GetPosition void sf::Drawable::SetPosition ( const Vector2f &  Position  )  const [inherited] [inherited]

-Get the position of the object. +Set the position of the object (take a 2D vector).

-

Returns:
Current position
+
Parameters:
+ + +
Position : New position
+
+ +

Definition at line 75 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + + +
const Vector2f& sf::Drawable::GetScale void sf::Drawable::SetPosition (  )  const [inherited]float  X,
float  Y 
) [inherited]

-Get the current scale of the object. +Set the position of the object (take 2 values).

-

Returns:
Current scale factor (always positive)
+
Parameters:
+ + + +
X : New X coordinate
Y : New Y coordinate
+
+ +

Definition at line 65 of file Drawable.cpp.

- +

- + - + + - +
const Vector2f& sf::Drawable::GetCenter void sf::Drawable::SetRotation ( float  Rotation  )  const [inherited] [inherited]

-Get the center of the object. +Set the orientation of the object.

-

Returns:
Current position of the center
+
Parameters:
+ + +
Rotation : Angle of rotation, in degrees
+
+ +

Definition at line 180 of file Drawable.cpp.

- +

- + - + + - +
float sf::Drawable::GetRotation void sf::Drawable::SetScale ( const Vector2f &  Scale  )  const [inherited] [inherited]

-Get the orientation of the object. +Set the scale of the object (take a 2D vector).

-Rotation is always in the range [0, 360]

-

Returns:
Current rotation, in degrees
+
Parameters:
+ + +
Scale : New scale (both values must be strictly positive)
+
+ +

Definition at line 117 of file Drawable.cpp.

- +

- + - - - + + + + + + + + + + + + +
const Color& sf::Drawable::GetColor void sf::Drawable::SetScale (  )  const [inherited]float  ScaleX,
float  ScaleY 
) [inherited]

-Get the color of the object. +Set the scale of the object (take 2 values).

-

Returns:
Current color
+
Parameters:
+ + + +
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)
+
+ +

Definition at line 107 of file Drawable.cpp.

- +

- + - + + - +
Blend::Mode sf::Drawable::GetBlendMode void sf::Drawable::SetScaleX ( float  FactorX  )  const [inherited] [inherited]

-Get the current blending mode. +Set the X scale factor of the object.

-

Returns:
Current blending mode
+
Parameters:
+ + +
X : New X scale factor
+
+ +

Definition at line 127 of file Drawable.cpp.

- +

- + - - - - - - - - - - - - + + +
void sf::Drawable::Move void sf::Drawable::SetScaleY ( float  OffsetX,
float  OffsetY 
) [inherited] FactorY  )  [inherited]

-Move the object of a given offset (take 2 values). +Set the Y scale factor of the object.

Parameters:
- - +
OffsetX : X offset
OffsetY : Y offset
Y : New Y scale factor
+

Definition at line 141 of file Drawable.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Move void sf::String::SetSize (const Vector2f &  Offset float  Size  )  [inherited]

-Move the object of a given offset (take a 2D vector). +Set the size of the string The default size is 30.

+Set the size of the string.

Parameters:
- +
Offset : Amount of units to move the object of
Size : New size, in pixels
+

Definition at line 88 of file String.cpp.

+

- +

- + - - - - - - - - - - + + + - -
void sf::Drawable::Scale void sf::String::SetStyle (float  FactorX,
float  FactorY 
unsigned long  TextStyle  )  ) [inherited]

-Scale the object (take 2 values). +Set the style of the text The default style is Regular.

+Set the style of the text The default style is Regular.

Parameters:
- - +
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)
TextStyle : New text style, (combination of Style enum values)
+

Definition at line 102 of file String.cpp.

+

- +

- + - - + + - +
void sf::Drawable::Scale void sf::String::SetText (const Vector2f &  Factor const Unicode::Text &  Text  )  [inherited]

-Scale the object (take a 2D vector). +Set the text (from any kind of string).

Parameters:
- +
Factor : Scaling factors (both values must be strictly positive)
Text : New text
+

Definition at line 65 of file String.cpp.

+

- +

- + - + - +
void sf::Drawable::Rotate void sf::Drawable::SetX ( float  Angle X  )  [inherited] [inherited]

-Rotate the object. +Set the X position of the object.

Parameters:
- +
Angle : Angle of rotation, in degrees
X : New X coordinate
+

Definition at line 85 of file Drawable.cpp.

+

- +

- + - - + + - +
sf::Vector2f sf::Drawable::TransformToLocal void sf::Drawable::SetY (const sf::Vector2f &  Point float  Y  )  const [inherited] [inherited]

-Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point). +Set the Y position of the object.

Parameters:
- +
Point : Point to transform
Y : New Y coordinate
-
Returns:
Transformed point
+ +

Definition at line 96 of file Drawable.cpp.

@@ -1265,7 +1371,7 @@ Transform a point from global coordinates into local coordinates (ie it applies const sf::Vector2f &  Point  )  - const [inherited] + const [inherited] @@ -1274,6 +1380,7 @@ Transform a point from global coordinates into local coordinates (ie it applies

Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

+Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point).

Parameters:
@@ -1281,54 +1388,44 @@ Transform a point from local coordinates into global coordinates (ie it applies
Returns:
Transformed point
- -

- -

-
-
Point : Point to transform
- - - - - - - -
const Matrix3& sf::Drawable::GetMatrix (  )  const [protected, inherited]
- -
- -

-Get the transform matrix of the drawable. -

-

Returns:
Transform matrix
+

Definition at line 325 of file Drawable.cpp.

- +

- + - + + - +
const Matrix3& sf::Drawable::GetInverseMatrix sf::Vector2f sf::Drawable::TransformToLocal ( const sf::Vector2f &  Point  )  const [protected, inherited] const [inherited]

-Get the inverse transform matrix of the drawable. +Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

-

Returns:
Inverse transform matrix
+Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point).

+

Parameters:
+ + +
Point : Point to transform
+
+
Returns:
Transformed point
+ +

Definition at line 316 of file Drawable.cpp.

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Thread Member List

This is the complete list of members for sf::Thread, including all inherited members.

- + - -
FuncType typedefsf::Thread
FuncType typedef (defined in sf::Thread)sf::Thread
Launch()sf::Thread
NonCopyable()sf::NonCopyable [inline, private]
Terminate()sf::Thread
Thread(FuncType Function, void *UserData=NULL)sf::Thread
Thread()sf::Thread [protected]
Wait()sf::Thread
~Thread()sf::Thread [virtual]
+ ~Thread()sf::Thread [virtual] +

+ - -
- + + -
- -
-
-sf::Thread
+

sf::Thread Class Reference

Thread defines an easy way to manipulate a thread. More...

#include <Thread.hpp>

-

Inheritance diagram for sf::Thread: +

+Inheritance diagram for sf::Thread:
+
+

sf::NonCopyable @@ -43,19 +49,22 @@ sf::SoundBufferRecorder sf::Music +
+ +

List of all members. - + - + - + - + @@ -76,10 +85,8 @@ typedef void(*)  - + @@ -99,7 +106,7 @@ Definition at line 44< - +

Public Types

-typedef void(*) FuncType (void *)
+typedef void(* FuncType )(void *)

Public Member Functions

 Thread (FuncType Function, void *UserData=NULL)
 Thread (FuncType Function, void *UserData=NULL)
 Construct the thread from a function pointer.
virtual ~Thread ()
virtual ~Thread ()
 Virtual destructor.
 Virtual destructor.
void Launch ()
 Create and run the thread.
Thread :
  • Inherit from it and override the Run() virtual function
  • Construct a Thread instance and pass it a function pointer to call
-

- -

-Definition at line 44 of file Win32/Thread.hpp.

Constructor & Destructor Documentation

+

Definition at line 44 of file Win32/Thread.hpp.

+

Constructor & Destructor Documentation

@@ -87,7 +94,7 @@ Definition at line 44<
sf::Thread::Thread (FuncType Thread::FuncType  Function,
)

@@ -115,18 +122,20 @@ Construct the thread from a function pointer.
+

Definition at line 50 of file Thread.cpp.

+

- +

- + - +
virtual sf::Thread::~Thread sf::Thread::~Thread (  )  [virtual] [virtual]
@@ -136,6 +145,8 @@ Construct the thread from a function pointer. Virtual destructor.

+

Definition at line 62 of file Thread.cpp.

+

@@ -147,7 +158,7 @@ Virtual destructor. (  )  - [protected] + [protected] @@ -157,6 +168,8 @@ Virtual destructor. Default constructor.

+

Definition at line 38 of file Thread.cpp.

+

Member Function Documentation

@@ -169,7 +182,7 @@ Default constructor. (  )  - + @@ -179,52 +192,59 @@ Default constructor. Create and run the thread.

+

Definition at line 73 of file Thread.cpp.

+

- +

- + - +
void sf::Thread::Wait void sf::Thread::Terminate (  ) 

-Wait until the thread finishes. +Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.

+Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. +

Definition at line 107 of file Thread.cpp.

- +

- + - +
void sf::Thread::Terminate void sf::Thread::Wait (  ) 

-Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. +Wait until the thread finishes.

+

Definition at line 87 of file Thread.cpp.

+

-

The documentation for this class was generated from the following file: +
The documentation for this class was generated from the following files: + - -
- -
-
- + + +

sf::Unicode Member List

This is the complete list of members for sf::Unicode, including all inherited members.

@@ -36,12 +39,12 @@ - + - + @@ -53,7 +56,8 @@ -
ANSIToUTF32(In Begin, In End, Out Output, const std::locale &Locale=GetDefaultLocale())sf::Unicode [inline, static]
ANSIToUTF32(In Begin, In End, Out Output, const std::locale &Locale)sf::Unicode [inline]
GetUTF32Length(In Begin, In End)sf::Unicode [inline]
GetUTF8Length(In Begin, In End)sf::Unicode [inline, static]
GetUTF8Length(In Begin, In End)sf::Unicode [inline]
UTF16String typedefsf::Unicode
UTF16String typedef (defined in sf::Unicode)sf::Unicode
UTF16ToUTF32(In Begin, In End, Out Output, Uint32 Replacement= '?')sf::Unicode [inline, static]
UTF16ToUTF32(In Begin, In End, Out Output, Uint32 Replacement)sf::Unicode [inline]
UTF16ToUTF8(In Begin, In End, Out Output, Uint8 Replacement= '?')sf::Unicode [inline, static]
UTF16ToUTF8(In Begin, In End, Out Output, Uint8 Replacement)sf::Unicode [inline]
UTF32String typedefsf::Unicode
UTF32String typedef (defined in sf::Unicode)sf::Unicode
UTF32ToANSI(In Begin, In End, Out Output, char Replacement= '?', const std::locale &Locale=GetDefaultLocale())sf::Unicode [inline, static]
UTF32ToANSI(In Begin, In End, Out Output, char Replacement, const std::locale &Locale)sf::Unicode [inline]
UTF32ToUTF16(In Begin, In End, Out Output, Uint16 Replacement= '?')sf::Unicode [inline, static]
UTF8ToUTF16(In Begin, In End, Out Output, Uint16 Replacement)sf::Unicode [inline]
UTF8ToUTF32(In Begin, In End, Out Output, Uint32 Replacement= '?')sf::Unicode [inline, static]
UTF8ToUTF32(In Begin, In End, Out Output, Uint32 Replacement)sf::Unicode [inline]
+

+ - -
- + + -
- -
-
-sf::Unicode
+

sf::Unicode Class Reference

Provides utility functions to convert from and to any unicode and ASCII encoding. More...

#include <Unicode.hpp> +

+

List of all members. + + + + - + +typedef std::basic_string< Uint16 >  +typedef std::basic_string< Uint32 >  - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - -

Classes

class  Text
 This class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding. More...

Public Types

typedef std::basic_string<
- Uint8 > 		UTF8String
typedef std::basic_string< Uint8 > UTF8String
 Define a string type for each encoding Warning : in UTF8 and UTF16 strings, one element doesn't necessarily maps to one character ; only an UTF32 element is wide enough to hold all possible unicode values.
-typedef std::basic_string<
- Uint16 > 		UTF16String
UTF16String
-typedef std::basic_string<
- Uint32 > 		UTF32String
UTF32String

Public Member Functions

template<typename In, typename Out>
template<typename In , typename Out >
Out UTF32ToANSI (In Begin, In End, Out Output, char Replacement, const std::locale &Locale)
 Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out ANSIToUTF32 (In Begin, In End, Out Output, const std::locale &Locale)
 Generic function to convert an ANSI characters range to an UTF-32 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out UTF8ToUTF16 (In Begin, In End, Out Output, Uint16 Replacement)
 Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out UTF8ToUTF32 (In Begin, In End, Out Output, Uint32 Replacement)
 Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out UTF16ToUTF8 (In Begin, In End, Out Output, Uint8 Replacement)
 Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out UTF16ToUTF32 (In Begin, In End, Out Output, Uint32 Replacement)
 Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out UTF32ToUTF8 (In Begin, In End, Out Output, Uint8 Replacement)
 Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
Out UTF32ToUTF16 (In Begin, In End, Out Output, Uint16 Replacement)
 Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale.
template<typename In>
template<typename In >
std::size_t GetUTF8Length (In Begin, In End)
 Get the number of characters composing an UTF-8 string.
template<typename In>
template<typename In >
std::size_t GetUTF16Length (In Begin, In End)
 Get the number of characters composing an UTF-16 string.
template<typename In>
template<typename In >
std::size_t GetUTF32Length (In Begin, In End)
 Get the number of characters composing an UTF-32 string.

Static Public Member Functions

template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF32ToANSI (In Begin, In End, Out Output, char Replacement= '?', const std::locale &Locale=GetDefaultLocale())
 Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out ANSIToUTF32 (In Begin, In End, Out Output, const std::locale &Locale=GetDefaultLocale())
 Generic function to convert an ANSI characters range to an UTF-32 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF8ToUTF16 (In Begin, In End, Out Output, Uint16 Replacement= '?')
 Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF8ToUTF32 (In Begin, In End, Out Output, Uint32 Replacement= '?')
 Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF16ToUTF8 (In Begin, In End, Out Output, Uint8 Replacement= '?')
 Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF16ToUTF32 (In Begin, In End, Out Output, Uint32 Replacement= '?')
 Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF32ToUTF8 (In Begin, In End, Out Output, Uint8 Replacement= '?')
 Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale.
template<typename In, typename Out>
template<typename In , typename Out >
static Out UTF32ToUTF16 (In Begin, In End, Out Output, Uint16 Replacement= '?')
 Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale.
template<typename In>
template<typename In >
static std::size_t GetUTF8Length (In Begin, In End)
 Get the number of characters composing an UTF-8 string.
template<typename In>
template<typename In >
static std::size_t GetUTF16Length (In Begin, In End)
 Get the number of characters composing an UTF-16 string.
template<typename In>
template<typename In >
static std::size_t GetUTF32Length (In Begin, In End)
 Get the number of characters composing an UTF-32 string.

Classes

class  Text
 This class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding. More...

Detailed Description

Provides utility functions to convert from and to any unicode and ASCII encoding. -

- -

-Definition at line 44 of file Unicode.hpp.

Member Typedef Documentation

+

Definition at line 44 of file Unicode.hpp.

+

Member Typedef Documentation

@@ -165,19 +165,19 @@ Definition at line 44 of Define a string type for each encoding Warning : in UTF8 and UTF16 strings, one element doesn't necessarily maps to one character ; only an UTF32 element is wide enough to hold all possible unicode values.

-

-Definition at line 54 of file Unicode.hpp. +

Definition at line 54 of file Unicode.hpp.

+

Member Function Documentation

- +
-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -194,40 +194,26 @@ template<typename In, typename Out> - - - - - - - + - +
static Out sf::Unicode::UTF32ToANSI Out sf::Unicode::ANSIToUTF32 ( In  Begin, Out  Output,
char  Replacement = '?',
const std::locale &  Locale = GetDefaultLocale()  Locale 
) [inline, static] [inline]

-Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale. +Generic function to convert an ANSI characters range to an UTF-32 characters range, using the given locale.

-

Parameters:
- - - - - - -
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Locale : Locale to use for conversion (uses the current one by default)
-
-
Returns:
Iterator to the end of the output sequence which has been written
+ +

Definition at line 67 of file Unicode.inl.

@@ -235,7 +221,7 @@ Generic function to convert an UTF-32 characters range to an ANSI characters ran

-template<typename In, typename Out>
+template<typename In , typename Out >
@@ -264,7 +250,7 @@ template<typename In, typename Out> - +
static Out sf::Unicode::ANSIToUTF32
) [inline, static] [inline, static]
@@ -285,14 +271,14 @@ Generic function to convert an ANSI characters range to an UTF-32 characters ran

- +

-template<typename In, typename Out>
+template<typename In >
- + @@ -301,52 +287,33 @@ template<typename In, typename Out> - - - - - - - - - - - - - + - +
static Out sf::Unicode::UTF8ToUTF16 std::size_t sf::Unicode::GetUTF16Length ( In  Begin, In  End,
Out  Output,
Uint16  Replacement = '?'  End 
) [inline, static] [inline]

-Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale. +Get the number of characters composing an UTF-16 string.

-

Parameters:
- - - - - -
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
-
-
Returns:
Iterator to the end of the output sequence which has been written
+ +

Definition at line 442 of file Unicode.inl.

- +

-template<typename In, typename Out>
+template<typename In >
- + @@ -355,52 +322,38 @@ template<typename In, typename Out> - - - - - - - - - - - - - + - +
static Out sf::Unicode::UTF8ToUTF32 static std::size_t sf::Unicode::GetUTF16Length ( In  Begin, In  End,
Out  Output,
Uint32  Replacement = '?'  End 
) [inline, static] [inline, static]

-Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale. +Get the number of characters composing an UTF-16 string.

Parameters:
- - - +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
End : Iterator pointing to the end of the input sequence
-
Returns:
Iterator to the end of the output sequence which has been written
+
Returns:
Count of the characters in the string

- +

-template<typename In, typename Out>
+template<typename In >
- + @@ -409,52 +362,73 @@ template<typename In, typename Out> - + - - - + + + +
static Out sf::Unicode::UTF16ToUTF8 std::size_t sf::Unicode::GetUTF32Length ( In  Begin, In  End, End 
Out  Output, ) [inline]
+
+
+ +

+Get the number of characters composing an UTF-32 string. +

+ +

Definition at line 471 of file Unicode.inl.

+ +
+

+ +

+
+
+template<typename In >
+ + + + + + - - + + - +
static std::size_t sf::Unicode::GetUTF32Length (In  Begin,
Uint8  Replacement = '?' In  End 
) [inline, static] [inline, static]

-Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale. +Get the number of characters composing an UTF-32 string.

Parameters:
- - - +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
End : Iterator pointing to the end of the input sequence
-
Returns:
Iterator to the end of the output sequence which has been written
+
Returns:
Count of the characters in the string

- +

-template<typename In, typename Out>
+template<typename In >
- + @@ -463,52 +437,73 @@ template<typename In, typename Out> - + - - - + + + +
static Out sf::Unicode::UTF16ToUTF32 std::size_t sf::Unicode::GetUTF8Length ( In  Begin, In  End, End 
Out  Output, ) [inline]
+
+
+ +

+Get the number of characters composing an UTF-8 string. +

+ +

Definition at line 422 of file Unicode.inl.

+ +
+

+ +

+
+
+template<typename In >
+ + + + + + - - + + - +
static std::size_t sf::Unicode::GetUTF8Length (In  Begin,
Uint32  Replacement = '?' In  End 
) [inline, static] [inline, static]

-Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale. +Get the number of characters composing an UTF-8 string.

Parameters:
- - - +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
End : Iterator pointing to the end of the input sequence
-
Returns:
Iterator to the end of the output sequence which has been written
+
Returns:
Count of the characters in the string

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -528,41 +523,34 @@ template<typename In, typename Out> - - + + - +
static Out sf::Unicode::UTF32ToUTF8 Out sf::Unicode::UTF16ToUTF32 ( In  Begin,
Uint8  Replacement = '?' Uint32  Replacement 
) [inline, static] [inline]

-Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale. +Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale.

-

Parameters:
- - - - - -
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
-
-
Returns:
Iterator to the end of the output sequence which has been written
+ +

Definition at line 280 of file Unicode.inl.

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -582,20 +570,20 @@ template<typename In, typename Out> - + - +
static Out sf::Unicode::UTF32ToUTF16 static Out sf::Unicode::UTF16ToUTF32 ( In  Begin,
Uint16 Uint32  Replacement = '?' 
) [inline, static] [inline, static]

-Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale. +Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale.

Parameters:
@@ -609,14 +597,14 @@ Generic function to convert an UTF-32 characters range to an UTF-16 characters r

- +

-template<typename In>
+template<typename In , typename Out >
- + @@ -625,78 +613,45 @@ template<typename In> - + + - - - -
static std::size_t sf::Unicode::GetUTF8Length Out sf::Unicode::UTF16ToUTF8 ( In  Begin, In  End  End,
) [inline, static]
-
-
- -

-Get the number of characters composing an UTF-8 string. -

-

Parameters:
- - - -
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
-
-
Returns:
Count of the characters in the string
- -
-

- -

-
-
-template<typename In>
- - - - - - + + - - + + - +
static std::size_t sf::Unicode::GetUTF16Length (In  Begin, Out  Output,
In  End Uint8  Replacement 
) [inline, static] [inline]

-Get the number of characters composing an UTF-16 string. +Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale.

-

Parameters:
- - - -
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
-
-
Returns:
Count of the characters in the string
+ +

Definition at line 207 of file Unicode.inl.

- +

-template<typename In>
+template<typename In , typename Out >
- + @@ -705,27 +660,41 @@ template<typename In> - + + + + + + + + + + + + + - +
static std::size_t sf::Unicode::GetUTF32Length static Out sf::Unicode::UTF16ToUTF8 ( In  Begin, In  End  End,
Out  Output,
Uint8  Replacement = '?' 
) [inline, static] [inline, static]

-Get the number of characters composing an UTF-32 string. +Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale.

Parameters:
- + + +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
-
Returns:
Count of the characters in the string
+
Returns:
Iterator to the end of the output sequence which has been written

@@ -733,7 +702,7 @@ Get the number of characters composing an UTF-32 string.

-template<typename In, typename Out>
+template<typename In , typename Out >
@@ -768,7 +737,7 @@ template<typename In, typename Out> - +
Out sf::Unicode::UTF32ToANSI
) [inline] [inline]
@@ -778,18 +747,18 @@ template<typename In, typename Out> Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale.

-

-Definition at line 31 of file Unicode.inl. +

Definition at line 31 of file Unicode.inl.

+

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -806,37 +775,51 @@ template<typename In, typename Out> + + + + + + - + - +
Out sf::Unicode::ANSIToUTF32 static Out sf::Unicode::UTF32ToANSI ( In  Begin, Out  Output,
char  Replacement = '?',
const std::locale &  Locale  Locale = GetDefaultLocale() 
) [inline] [inline, static]

-Generic function to convert an ANSI characters range to an UTF-32 characters range, using the given locale. +Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale.

+

Parameters:
+ + + + + + +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Locale : Locale to use for conversion (uses the current one by default)
+
+
Returns:
Iterator to the end of the output sequence which has been written
-

-Definition at line 67 of file Unicode.inl.

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -862,28 +845,28 @@ template<typename In, typename Out> - +
Out sf::Unicode::UTF8ToUTF16 Out sf::Unicode::UTF32ToUTF16 ( In  Begin,
) [inline] [inline]

-Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale. +Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale.

-

-Definition at line 102 of file Unicode.inl. +

Definition at line 379 of file Unicode.inl.

+

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -903,34 +886,41 @@ template<typename In, typename Out> - - + + - +
Out sf::Unicode::UTF8ToUTF32 static Out sf::Unicode::UTF32ToUTF16 ( In  Begin,
Uint32  Replacement Uint16  Replacement = '?' 
) [inline] [inline, static]

-Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale. +Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale.

+

Parameters:
+ + + + + +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
+
+
Returns:
Iterator to the end of the output sequence which has been written
-

-Definition at line 163 of file Unicode.inl.

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -956,28 +946,28 @@ template<typename In, typename Out> - +
Out sf::Unicode::UTF16ToUTF8 Out sf::Unicode::UTF32ToUTF8 ( In  Begin,
) [inline] [inline]

-Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale. +Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale.

-

-Definition at line 207 of file Unicode.inl. +

Definition at line 326 of file Unicode.inl.

+

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -997,34 +987,41 @@ template<typename In, typename Out> - - + + - +
Out sf::Unicode::UTF16ToUTF32 static Out sf::Unicode::UTF32ToUTF8 ( In  Begin,
Uint32  Replacement Uint8  Replacement = '?' 
) [inline] [inline, static]

-Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale. +Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale.

+

Parameters:
+ + + + + +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
+
+
Returns:
Iterator to the end of the output sequence which has been written
-

-Definition at line 280 of file Unicode.inl.

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -1044,34 +1041,34 @@ template<typename In, typename Out> - + - +
Out sf::Unicode::UTF32ToUTF8 Out sf::Unicode::UTF8ToUTF16 ( In  Begin,
Uint8 Uint16  Replacement 
) [inline] [inline]

-Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale. +Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale.

-

-Definition at line 326 of file Unicode.inl. +

Definition at line 102 of file Unicode.inl.

+

- +

-template<typename In, typename Out>
+template<typename In , typename Out >
- + @@ -1092,33 +1089,40 @@ template<typename In, typename Out> - + - +
Out sf::Unicode::UTF32ToUTF16 static Out sf::Unicode::UTF8ToUTF16 ( In  Begin, Uint16  Replacement  Replacement = '?' 
) [inline] [inline, static]

-Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale. +Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale.

+

Parameters:
+ + + + + +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
+
+
Returns:
Iterator to the end of the output sequence which has been written
-

-Definition at line 379 of file Unicode.inl.

- +

-template<typename In>
+template<typename In , typename Out >
- + @@ -1127,68 +1131,45 @@ template<typename In> - + + - - - -
std::size_t sf::Unicode::GetUTF8Length Out sf::Unicode::UTF8ToUTF32 ( In  Begin, In  End  End,
) [inline]
-
-
- -

-Get the number of characters composing an UTF-8 string. -

- -

-Definition at line 422 of file Unicode.inl. -

-

- -

-
-
-template<typename In>
- - - - - - + + - - + + - +
std::size_t sf::Unicode::GetUTF16Length (In  Begin, Out  Output,
In  End Uint32  Replacement 
) [inline] [inline]

-Get the number of characters composing an UTF-16 string. +Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale.

-

-Definition at line 442 of file Unicode.inl. +

Definition at line 163 of file Unicode.inl.

+

- +

-template<typename In>
+template<typename In , typename Out >
- + @@ -1197,27 +1178,47 @@ template<typename In> - + + + + + + + + + + + + + - +
std::size_t sf::Unicode::GetUTF32Length static Out sf::Unicode::UTF8ToUTF32 ( In  Begin, In  End  End,
Out  Output,
Uint32  Replacement = '?' 
) [inline] [inline, static]

-Get the number of characters composing an UTF-32 string. +Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale.

+

Parameters:
+ + + + + +
Begin : Iterator pointing to the beginning of the input sequence
End : Iterator pointing to the end of the input sequence
Output : Iterator pointing to the beginning of the output sequence
Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
+
+
Returns:
Iterator to the end of the output sequence which has been written
-

-Definition at line 471 of file Unicode.inl.

The documentation for this class was generated from the following files: +
  • Unicode.hpp
  • Unicode.inl
  • Unicode.cpp + - -
    - + + -
    - -
    -

    sf::Unicode::Text Member List

    This is the complete list of members for sf::Unicode::Text, including all inherited members.

    - - - - - - - - - - - - - - - - -
    operator const Unicode::UTF32String &() const (defined in sf::Unicode::Text)sf::Unicode::Text
    operator std::string() constsf::Unicode::Text
    operator std::wstring() const (defined in sf::Unicode::Text)sf::Unicode::Text
    operator Unicode::UTF16String() const (defined in sf::Unicode::Text)sf::Unicode::Text
    operator Unicode::UTF8String() const (defined in sf::Unicode::Text)sf::Unicode::Text
    Text()sf::Unicode::Text
    Text(const char *Str)sf::Unicode::Text
    Text(const wchar_t *Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const Uint8 *Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const Uint16 *Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const Uint32 *Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const std::string &Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const std::wstring &Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const Unicode::UTF8String &Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const Unicode::UTF16String &Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    Text(const Unicode::UTF32String &Str) (defined in sf::Unicode::Text)sf::Unicode::Text
    +

    +

    sf::Unicode::Unicode::Text Member List

    This is the complete list of members for sf::Unicode::Unicode::Text, including all inherited members.

    + + + + + + + + + + + + + + + + +
    operator const Unicode::UTF32String &() const (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    operator std::string() const sf::Unicode::Unicode::Text
    operator std::wstring() const (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    operator Unicode::UTF16String() const (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    operator Unicode::UTF8String() const (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text()sf::Unicode::Unicode::Text
    Text(const char *Str)sf::Unicode::Unicode::Text
    Text(const wchar_t *Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const Uint8 *Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const Uint16 *Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const Uint32 *Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const std::string &Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const std::wstring &Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const Unicode::UTF8String &Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const Unicode::UTF16String &Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text
    Text(const Unicode::UTF32String &Str) (defined in sf::Unicode::Unicode::Text)sf::Unicode::Unicode::Text

    + - -
    - + + -
    - -
    -
    -sf::Unicode::Text
    -

    sf::Unicode::Text Class Reference

    This class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding. +
    +

    sf::Unicode::Unicode::Text Class Reference

    This class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding. More...

    #include <Unicode.hpp> +

    +

    List of all members. - + - - + + - - + - - - - - - - + - + - + - - + + - + - + - +

    Public Member Functions

     Text ()
     Text ()
     Default constructor (empty text).
     Text (const char *Str)
     Default constructor (empty text).
     Text (const char *Str)
     Construct the unicode text from any type of string.
    +
     Construct the unicode text from any type of string.
     Text (const wchar_t *Str)
    +
     Text (const Uint8 *Str)
    +
     Text (const Uint16 *Str)
    +
     Text (const Uint32 *Str)
    +
     Text (const std::string &Str)
    +
     Text (const std::wstring &Str)
    +
     Text (const Unicode::UTF8String &Str)
    - Text (const Unicode::UTF16String &Str)
    + Text (const Unicode::UTF16String &Str)
    - Text (const Unicode::UTF32String &Str)
    + Text (const Unicode::UTF32String &Str)
     operator std::string () const
     operator std::string () const
     Operator to cast the text to any type of string.
    - operator std::wstring () const
     Operator to cast the text to any type of string.
    + operator std::wstring () const
    - operator Unicode::UTF8String () const
    + operator Unicode::UTF8String () const
    - operator Unicode::UTF16String () const
    + operator Unicode::UTF16String () const
    - operator const Unicode::UTF32String & () const
    + operator const Unicode::UTF32String & () const

    Detailed Description

    This class is an abstract definition of a unicode text, it can be converted from and to any kind of string and encoding. -

    - -

    -Definition at line 63 of file Unicode.hpp.

    Constructor & Destructor Documentation

    - +

    Definition at line 63 of file Unicode.hpp.

    +

    Constructor & Destructor Documentation

    +
    - + - +
    sf::Unicode::Text::Text sf::Unicode::Unicode::Text::Text (  ) 
    @@ -111,19 +114,21 @@ Definition at line 63 of Default constructor (empty text).

    +

    Definition at line 105 of file Unicode.cpp.

    +

    - +

    - + - +
    sf::Unicode::Text::Text sf::Unicode::Unicode::Text::Text ( const char *  Str  ) 
    @@ -138,19 +143,21 @@ Construct the unicode text from any type of string. +

    Definition at line 114 of file Unicode.cpp.

    +

    Member Function Documentation

    - +
    - + - +
    sf::Unicode::Text::operator std::string sf::Unicode::Unicode::Text::operator std::string (  )  const const
    @@ -161,10 +168,13 @@ Operator to cast the text to any type of string.

    Returns:
    Converted string
    +

    Definition at line 227 of file Unicode.cpp.

    +

    -

    The documentation for this class was generated from the following file: +
    The documentation for this class was generated from the following files: + - -
    - -
    -
    - + + +

    sf::Vector2< T > Member List

    This is the complete list of members for sf::Vector2< T >, including all inherited members.

    -
    Vector2()sf::Vector2< T >
    Vector2(T X, T Y)sf::Vector2< T >
    xsf::Vector2< T >
    ysf::Vector2< T >
    +

    + - -
    - + + -
    - -
    -
    -sf::Vector2
    +

    sf::Vector2< T > Class Template Reference

    Vector2 is an utility class for manipulating 2 dimensional vectors. More...

    #include <Vector2.hpp> +

    +

    List of all members. @@ -58,10 +63,8 @@ Vector2 is an utility class for manipulating 2 dimensional vectors.

    Template parameter defines the type of coordinates (integer, float, ...) -

    - -

    -Definition at line 37 of file Vector2.hpp.

    Constructor & Destructor Documentation

    +

    Definition at line 37 of file Vector2.hpp.

    +

    Constructor & Destructor Documentation

    @@ -73,7 +76,7 @@ template<typename T>
    - +
    (  ) 

    @@ -106,7 +109,7 @@ template<typename T>
    ) - +
    @@ -142,8 +145,8 @@ template<typename T> X coordinate of the vector.

    -

    -Definition at line 59 of file Vector2.hpp. +

    Definition at line 59 of file Vector2.hpp.

    +

    @@ -163,12 +166,13 @@ template<typename T> Y coordinate of the vector.

    -

    -Definition at line 60 of file Vector2.hpp. +

    Definition at line 60 of file Vector2.hpp.

    +

    The documentation for this class was generated from the following file: + - -
    - -
    -
    - + + +

    sf::Vector3< T > Member List

    This is the complete list of members for sf::Vector3< T >, including all inherited members.

    -
    Vector3()sf::Vector3< T >
    Vector3(T X, T Y, T Z)sf::Vector3< T >
    xsf::Vector3< T >
    ysf::Vector3< T >
    zsf::Vector3< T >
    +

    + - -
    - + + -
    - -
    -
    -sf::Vector3
    +

    sf::Vector3< T > Class Template Reference

    Vector3 is an utility class for manipulating 3 dimensional vectors. More...

    #include <Vector3.hpp> +

    +

    List of all members. @@ -61,10 +66,8 @@ Vector3 is an utility class for manipulating 3 dimensional vectors.

    Template parameter defines the type of coordinates (integer, float, ...) -

    - -

    -Definition at line 37 of file Vector3.hpp.

    Constructor & Destructor Documentation

    +

    Definition at line 37 of file Vector3.hpp.

    +

    Constructor & Destructor Documentation

    @@ -76,7 +79,7 @@ template<typename T>
    - +
    (  ) 

    @@ -115,7 +118,7 @@ template<typename T>
    ) - +
    @@ -152,8 +155,8 @@ template<typename T> X coordinate of the vector.

    -

    -Definition at line 60 of file Vector3.hpp. +

    Definition at line 60 of file Vector3.hpp.

    +

    @@ -173,8 +176,8 @@ template<typename T> Y coordinate of the vector.

    -

    -Definition at line 61 of file Vector3.hpp. +

    Definition at line 61 of file Vector3.hpp.

    +

    @@ -194,12 +197,13 @@ template<typename T> Z coordinate of the vector.

    -

    -Definition at line 62 of file Vector3.hpp. +

    Definition at line 62 of file Vector3.hpp.

    +

    The documentation for this class was generated from the following file: + - -
    - -
    -
    - + + +

    sf::VideoMode Member List

    This is the complete list of members for sf::VideoMode, including all inherited members.

    - - - + + + - + -
    BitsPerPixelsf::VideoMode
    GetDesktopMode()sf::VideoMode [static]
    GetMode(std::size_t Index)sf::VideoMode [static]
    GetModesCount()sf::VideoMode [static]
    GetDesktopMode()sf::VideoMode [static]
    GetMode(std::size_t Index)sf::VideoMode [static]
    GetModesCount()sf::VideoMode [static]
    Heightsf::VideoMode
    IsValid() constsf::VideoMode
    IsValid() const sf::VideoMode
    operator!=(const VideoMode &Other) const sf::VideoMode
    operator==(const VideoMode &Other) const sf::VideoMode
    VideoMode()sf::VideoMode
    VideoMode(unsigned int ModeWidth, unsigned int ModeHeight, unsigned int ModeBpp=32)sf::VideoMode
    Widthsf::VideoMode
    +

    + - -
    - + + -
    - -
    -
    -sf::VideoMode
    +

    sf::VideoMode Class Reference

    VideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for getting modes supported by the display device. More...

    #include <VideoMode.hpp> +

    +

    List of all members. @@ -43,9 +48,9 @@ - + - + @@ -53,15 +58,15 @@ - + - - + + - - + + - + @@ -75,10 +80,8 @@
     VideoMode (unsigned int ModeWidth, unsigned int ModeHeight, unsigned int ModeBpp=32)
     Construct the video mode with its attributes.
    bool IsValid () const
    bool IsValid () const
     Tell whether or not the video mode is supported.
     Tell whether or not the video mode is supported.
    bool operator== (const VideoMode &Other) const
     Comparison operator overload -- tell if two video modes are equal.
     Comparison operator overload -- tell if two video modes are different.

    Static Public Member Functions

    static VideoMode GetDesktopMode ()
    static VideoMode GetDesktopMode ()
     Get the current desktop video mode.
    static VideoMode GetMode (std::size_t Index)
     Get the current desktop video mode.
    static VideoMode GetMode (std::size_t Index)
     Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.
    static std::size_t GetModesCount ()
     Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.
    static std::size_t GetModesCount ()
     Get valid video modes count.
     Get valid video modes count.

    Public Attributes

    unsigned int Width

    Detailed Description

    VideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for getting modes supported by the display device. -

    - -

    -Definition at line 42 of file VideoMode.hpp.

    Constructor & Destructor Documentation

    +

    Definition at line 42 of file VideoMode.hpp.

    +

    Constructor & Destructor Documentation

    @@ -88,7 +91,7 @@ Definition at line 42 (  )  - +
    @@ -98,6 +101,8 @@ Definition at line 42 Default constructor.

    +

    Definition at line 67 of file VideoMode.cpp.

    +

    @@ -125,7 +130,7 @@ Default constructor. ) - +

    @@ -142,19 +147,21 @@ Construct the video mode with its attributes. +

    Definition at line 79 of file VideoMode.cpp.

    +

    Member Function Documentation

    - +
    - + - +
    static VideoMode sf::VideoMode::GetDesktopMode VideoMode sf::VideoMode::GetDesktopMode (  )  [static] [static]
    @@ -165,27 +172,30 @@ Get the current desktop video mode.

    Returns:
    Current desktop video mode
    +

    Definition at line 91 of file VideoMode.cpp.

    +

    - +

    - + - +
    static VideoMode sf::VideoMode::GetMode VideoMode sf::VideoMode::GetMode ( std::size_t  Index  )  [static] [static]

    -Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst. +Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.

    +Get a valid video mode Index must be in range [0, GetModesCount()[.

    Parameters:
    @@ -193,18 +203,20 @@ Get a valid video mode Index must be in range [0,
    Returns:
    Corresponding video mode (invalid mode if index is out of range)
    +

    Definition at line 102 of file VideoMode.cpp.

    +

    - +

    Index : Index of video mode to get
    - + - +
    static std::size_t sf::VideoMode::GetModesCount std::size_t sf::VideoMode::GetModesCount (  )  [static] [static]
    @@ -215,9 +227,11 @@ Get valid video modes count.

    Returns:
    Number of valid video modes available
    +

    Definition at line 117 of file VideoMode.cpp.

    +

    - +

    @@ -226,7 +240,7 @@ Get valid video modes count. - +
    (  )  const const
    @@ -237,82 +251,88 @@ Tell whether or not the video mode is supported.

    Returns:
    True if video mode is supported, false otherwise
    +

    Definition at line 129 of file VideoMode.cpp.

    +

    - +

    - + - +
    bool sf::VideoMode::operator== bool sf::VideoMode::operator!= ( const VideoMode &  Other  )  const const

    -Comparison operator overload -- tell if two video modes are equal. +Comparison operator overload -- tell if two video modes are different.

    Parameters:
    Other : Video mode to compare
    -
    Returns:
    True if modes are equal
    +
    Returns:
    True if modes are different
    + +

    Definition at line 152 of file VideoMode.cpp.

    - +

    - + - +
    bool sf::VideoMode::operator!= bool sf::VideoMode::operator== ( const VideoMode &  Other  )  const const

    -Comparison operator overload -- tell if two video modes are different. +Comparison operator overload -- tell if two video modes are equal.

    Parameters:
    Other : Video mode to compare
    -
    Returns:
    True if modes are different
    +
    Returns:
    True if modes are equal
    + +

    Definition at line 141 of file VideoMode.cpp.

    Member Data Documentation

    - +
    - +
    unsigned int sf::VideoMode::Width unsigned int sf::VideoMode::BitsPerPixel

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

    -

    -Definition at line 121 of file VideoMode.hpp. +

    Definition at line 123 of file VideoMode.hpp.

    +

    @@ -330,31 +350,32 @@ Definition at line 121 Video mode height, in pixels.

    -

    -Definition at line 122 of file VideoMode.hpp. +

    Definition at line 122 of file VideoMode.hpp.

    +

    - +

    - +
    unsigned int sf::VideoMode::BitsPerPixel unsigned int sf::VideoMode::Width

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

    -

    -Definition at line 123 of file VideoMode.hpp. +

    Definition at line 121 of file VideoMode.hpp.

    +

    -

    The documentation for this class was generated from the following file: +
    The documentation for this class was generated from the following files: + - -
    - -
    -
    - + + +

    sf::View Member List

    This is the complete list of members for sf::View, including all inherited members.

    - - - + + + - + @@ -42,7 +45,8 @@ -
    GetCenter() constsf::View
    GetHalfSize() constsf::View
    GetRect() constsf::View
    GetCenter() const sf::View
    GetHalfSize() const sf::View
    GetRect() const sf::View
    Move(float OffsetX, float OffsetY)sf::View
    Move(const sf::Vector2f &Offset)sf::View
    RenderTarget classsf::View [friend]
    RenderTarget (defined in sf::View)sf::View [friend]
    SetCenter(float X, float Y)sf::View
    SetCenter(const sf::Vector2f &Center)sf::View
    SetFromRect(const FloatRect &ViewRect)sf::View
    View(const FloatRect &ViewRect=FloatRect(0, 0, 1000, 1000))sf::View [explicit]
    View(const sf::Vector2f &Center, const sf::Vector2f &HalfSize)sf::View
    Zoom(float Factor)sf::View
    +

    + - -
    - + + -
    - -
    -
    -sf::View
    +

    sf::View Class Reference

    This class defines a view (position, size, etc. More...

    #include <View.hpp> +

    +

    List of all members. @@ -58,15 +63,15 @@ - + - - + + - - + + - + @@ -78,17 +83,15 @@ +class 
    void SetFromRect (const FloatRect &ViewRect)
     Rebuild the view from a rectangle.
    const sf::Vector2f & GetCenter () const
    const sf::Vector2f & GetCenter () const
     Get the center of the view.
    const sf::Vector2f & GetHalfSize () const
     Get the center of the view.
    const sf::Vector2f & GetHalfSize () const
     Get the half-size of the view.
    const sf::FloatRect & GetRect () const
     Get the half-size of the view.
    const sf::FloatRect & GetRect () const
     Get the bounding rectangle of the view.
     Get the bounding rectangle of the view.
    void Move (float OffsetX, float OffsetY)
     Move the view (take 2 values).
     Resize the view rectangle to simulate a zoom / unzoom effect.

    Friends

    -class RenderTarget
    RenderTarget

    Detailed Description

    This class defines a view (position, size, etc.

    ) ; you can consider it as a 2D camera -

    - -

    -Definition at line 45 of file View.hpp.

    Constructor & Destructor Documentation

    +

    Definition at line 45 of file View.hpp.

    +

    Constructor & Destructor Documentation

    @@ -99,7 +102,7 @@ Definition at line 45 of fi const FloatRect &  ViewRect = FloatRect(0, 0, 1000, 1000)  )  - [explicit] + [explicit]
    @@ -114,6 +117,8 @@ Construct the view from a rectangle. +

    Definition at line 37 of file View.cpp.

    +

    @@ -135,7 +140,7 @@ Construct the view from a rectangle. ) - +

    @@ -151,292 +156,314 @@ Construct the view from its center and half-size. +

    Definition at line 46 of file View.cpp.

    +

    Member Function Documentation

    - +
    - + - - - - - - - - - - - - - + + +
    void sf::View::SetCenter const sf::Vector2f & sf::View::GetCenter (float  X,
    float  Y 
    )  )  const

    -Change the center of the view (take 2 values). +Get the center of the view.

    -

    Parameters:
    - - - -
    X : X coordinate of the new center
    Y : Y coordinate of the new center
    -
    +
    Returns:
    Center of the view
    + +

    Definition at line 108 of file View.cpp.

    - +

    - + - - + - +
    void sf::View::SetCenter const sf::Vector2f & sf::View::GetHalfSize (const sf::Vector2f &  Center  )  const

    -Change the center of the view (take a vector). +Get the half-size of the view.

    -

    Parameters:
    - - -
    Center : New center
    -
    +
    Returns:
    Half-size of the view
    + +

    Definition at line 117 of file View.cpp.

    - +

    - + - - - - - - - - - - - - - + + +
    void sf::View::SetHalfSize const sf::FloatRect & sf::View::GetRect (float  HalfWidth,
    float  HalfHeight 
    )  )  const

    -Change the half-size of the view (take 2 values). +Get the bounding rectangle of the view.

    -

    Parameters:
    - - - -
    HalfWidth : New half-width
    HalfHeight : New half-height
    -
    +
    Returns:
    Bounding rectangle of the view
    + +

    Definition at line 126 of file View.cpp.

    - +

    - + - + - +
    void sf::View::SetHalfSize void sf::View::Move ( const sf::Vector2f &  HalfSize Offset  ) 

    -Change the half-size of the view (take a vector). +Move the view (take a vector).

    Parameters:
    - +
    HalfSize : New half-size
    Offset : Offset to move the view
    +

    Definition at line 150 of file View.cpp.

    +

    - +

    - + - - - - + + + + + + + + + + + + +
    void sf::View::SetFromRect void sf::View::Move (const FloatRect &  ViewRect  ) float  OffsetX,
    float  OffsetY 
    )

    -Rebuild the view from a rectangle. +Move the view (take 2 values).

    Parameters:
    - + +
    ViewRect : Rectangle defining the position and size of the view
    OffsetX : Offset to move the view, on X axis
    OffsetY : Offset to move the view, on Y axis
    +

    Definition at line 139 of file View.cpp.

    +

    - +

    - + - + + - +
    const sf::Vector2f& sf::View::GetCenter void sf::View::SetCenter ( const sf::Vector2f &  Center  )  const

    -Get the center of the view. +Change the center of the view (take a vector).

    -

    Returns:
    Center of the view
    +
    Parameters:
    + + +
    Center : New center
    +
    + +

    Definition at line 69 of file View.cpp.

    - +

    - + - - - + + + + + + + + + + + + +
    const sf::Vector2f& sf::View::GetHalfSize void sf::View::SetCenter (  )  constfloat  X,
    float  Y 
    )

    -Get the half-size of the view. +Change the center of the view (take 2 values).

    -

    Returns:
    Half-size of the view
    +
    Parameters:
    + + + +
    X : X coordinate of the new center
    Y : Y coordinate of the new center
    +
    + +

    Definition at line 58 of file View.cpp.

    - +

    - + - + + - +
    const sf::FloatRect& sf::View::GetRect void sf::View::SetFromRect ( const FloatRect &  ViewRect  )  const

    -Get the bounding rectangle of the view. +Rebuild the view from a rectangle.

    -

    Returns:
    Bounding rectangle of the view
    +
    Parameters:
    + + +
    ViewRect : Rectangle defining the position and size of the view
    +
    + +

    Definition at line 98 of file View.cpp.

    - +

    - + - - - - - - - - - - + + + - -
    void sf::View::Move void sf::View::SetHalfSize (float  OffsetX,
    float  OffsetY 
    const sf::Vector2f &  HalfSize  )  )

    -Move the view (take 2 values). +Change the half-size of the view (take a vector).

    Parameters:
    - - +
    OffsetX : Offset to move the view, on X axis
    OffsetY : Offset to move the view, on Y axis
    HalfSize : New half-size
    +

    Definition at line 89 of file View.cpp.

    +

    - +

    - + - - - - + + + + + + + + + + + + +
    void sf::View::Move void sf::View::SetHalfSize (const sf::Vector2f &  Offset  ) float  HalfWidth,
    float  HalfHeight 
    )

    -Move the view (take a vector). +Change the half-size of the view (take 2 values).

    Parameters:
    - + +
    Offset : Offset to move the view
    HalfWidth : New half-width
    HalfHeight : New half-height
    +

    Definition at line 78 of file View.cpp.

    +

    @@ -449,7 +476,7 @@ Move the view (take a vector). float  Factor  )  - + @@ -464,10 +491,13 @@ Resize the view rectangle to simulate a zoom / unzoom effect. +

    Definition at line 159 of file View.cpp.

    +

    -

    The documentation for this class was generated from the following file: +
    The documentation for this class was generated from the following files: + - -
    - -
    -
    - + + +

    sf::Window Member List

    This is the complete list of members for sf::Window, including all inherited members.

    @@ -34,12 +37,12 @@ - - - - - - + + + + + + @@ -54,9 +57,10 @@ - + -
    Close()sf::Window
    Create(VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())sf::Window
    Display()sf::Window
    EnableKeyRepeat(bool Enabled)sf::Window
    GetEvent(Event &EventReceived)sf::Window
    GetFrameTime() constsf::Window
    GetHeight() constsf::Window
    GetInput() constsf::Window
    GetSettings() constsf::Window
    GetWidth() constsf::Window
    IsOpened() constsf::Window
    GetFrameTime() const sf::Window
    GetHeight() const sf::Window
    GetInput() const sf::Window
    GetSettings() const sf::Window
    GetWidth() const sf::Window
    IsOpened() const sf::Window
    NonCopyable()sf::NonCopyable [inline, private]
    SetActive(bool Active=true) const sf::Window
    SetCursorPosition(unsigned int Left, unsigned int Top)sf::Window
    Window()sf::Window
    Window(VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())sf::Window
    Window(WindowHandle Handle, const WindowSettings &Params=WindowSettings())sf::Window
    ~Window()sf::Window [virtual]
    ~Window()sf::Window [virtual]
    ~WindowListener()sf::WindowListener [inline, protected, virtual]
    +

    + - -
    - -
    -
    - -
    -
    -sf::Window
    + + +

    sf::Window Class Reference

    Window is a rendering window ; it can create a new window or connect to an existing one. More...

    #include <Window.hpp>

    -

    Inheritance diagram for sf::Window: +

    +Inheritance diagram for sf::Window:
    +
    +

    sf::WindowListener sf::NonCopyable sf::RenderWindow +
    + +

    List of all members. @@ -53,9 +62,9 @@ - + - + @@ -65,18 +74,18 @@ - + - - + + - - + + - - + + - + @@ -110,25 +119,23 @@ - + - + - + - +

    Public Member Functions

     Window (WindowHandle Handle, const WindowSettings &Params=WindowSettings())
     Construct the window from an existing control.
    virtual ~Window ()
    virtual ~Window ()
     Destructor.
     Destructor.
    void Create (VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())
     Create (or recreate) the window.
    void Close ()
     Close (destroy) the window.
    bool IsOpened () const
    bool IsOpened () const
     Tell whether or not the window is opened (ie.
    unsigned int GetWidth () const
     Tell whether or not the window is opened (ie.
    unsigned int GetWidth () const
     Get the width of the rendering region of the window.
    unsigned int GetHeight () const
     Get the width of the rendering region of the window.
    unsigned int GetHeight () const
     Get the height of the rendering region of the window.
    const WindowSettings & GetSettings () const
     Get the height of the rendering region of the window.
    const WindowSettings & GetSettings () const
     Get the creation settings of the window.
     Get the creation settings of the window.
    bool GetEvent (Event &EventReceived)
     Get the event on top of events stack, if any, and pop it.
    void Display ()
     Display the window on screen.
    const Input & GetInput () const
    const Input & GetInput () const
     Get the input manager of the window.
     Get the input manager of the window.
    void SetFramerateLimit (unsigned int Limit)
     Limit the framerate to a maximum fixed frequency.
    float GetFrameTime () const
    float GetFrameTime () const
     Get time elapsed since last frame.
     Get time elapsed since last frame.
    void SetJoystickThreshold (float Threshold)
     Change the joystick threshold, ie.

    Detailed Description

    Window is a rendering window ; it can create a new window or connect to an existing one. -

    - -

    -Definition at line 55 of file Window/Window.hpp.

    Constructor & Destructor Documentation

    +

    Definition at line 55 of file Window/Window.hpp.

    +

    Constructor & Destructor Documentation

    @@ -138,7 +145,7 @@ Definition at line 55 (  )  - +
    @@ -148,6 +155,8 @@ Definition at line 55 Default constructor.

    +

    Definition at line 49 of file Window.cpp.

    +

    @@ -170,7 +179,7 @@ Default constructor. unsigned long  - WindowStyle = Style::Resize|Style::Close, + WindowStyle = Style::Resize | Style::Close, @@ -181,7 +190,7 @@ Default constructor. ) - +

    @@ -199,6 +208,8 @@ Construct a new window. +

    Definition at line 64 of file Window.cpp.

    +

    @@ -220,7 +231,7 @@ Construct a new window. ) - + @@ -236,18 +247,20 @@ Construct the window from an existing control. +

    Definition at line 79 of file Window.cpp.

    +

    - +

    - + - +
    virtual sf::Window::~Window sf::Window::~Window (  )  [virtual] [virtual]
    @@ -257,9 +270,75 @@ Construct the window from an existing control. Destructor.

    +

    Definition at line 94 of file Window.cpp.

    +

    Member Function Documentation

    + +
    +
    + + + + + + + + +
    void sf::Window::Close (  ) 
    +
    +
    + +

    +Close (destroy) the window. +

    +The sf::Window instance remains valid and you can call Create to recreate the window

    +The sf::Window instance remains valid and you can call Create to recreate the window +

    Definition at line 165 of file Window.cpp.

    + +
    +

    + +

    +
    + + + + + + + + + + + + + + + + + + +
    void sf::Window::Create (WindowHandle  Handle,
    const WindowSettings &  Params = WindowSettings() 
    )
    +
    +
    + +

    +Create (or recreate) the window from an existing control. +

    +Create the window from an existing control.

    +

    Parameters:
    + + + +
    Handle : Platform-specific handle of the control
    Params : Creation parameters (see default constructor for default values)
    +
    + +

    Definition at line 147 of file Window.cpp.

    + +
    +

    @@ -280,7 +359,7 @@ Destructor. unsigned long  - WindowStyle = Style::Resize|Style::Close, + WindowStyle = Style::Resize | Style::Close, @@ -291,7 +370,7 @@ Destructor. ) - +
    @@ -300,6 +379,7 @@ Destructor.

    Create (or recreate) the window.

    +Create the window.

    Parameters:
    @@ -309,147 +389,178 @@ Create (or recreate) the window.
    Mode : Video mode to use
    +

    Definition at line 104 of file Window.cpp.

    +

    - +

    - + - - - - - + + - - +
    void sf::Window::Create void sf::Window::Display (WindowHandle  Handle,
     )  const WindowSettings &  Params = WindowSettings() 
    +
    +
    + +

    +Display the window on screen. +

    + +

    Definition at line 353 of file Window.cpp.

    + +
    +

    + +

    +
    + + + + + + - -
    void sf::Window::EnableKeyRepeat (bool  Enabled  )  )

    -Create (or recreate) the window from an existing control. +Enable or disable automatic key-repeat.

    +Automatic key-repeat is enabled by default

    Parameters:
    - - +
    Handle : Platform-specific handle of the control
    Params : Creation parameters (see default constructor for default values)
    Enabled : True to enable, false to disable
    +Automatic key-repeat is enabled by default +

    Definition at line 317 of file Window.cpp.

    - +

    - + - + + - +
    void sf::Window::Close bool sf::Window::GetEvent ( Event &  EventReceived  ) 

    -Close (destroy) the window. +Get the event on top of events stack, if any, and pop it.

    -The sf::Window instance remains valid and you can call Create to recreate the window +Get the event on top of events stack, if any.

    +

    Parameters:
    + + +
    EventReceived : Event to fill, if any
    +
    +
    Returns:
    True if an event was returned, false if events stack was empty
    + +

    Definition at line 218 of file Window.cpp.

    +

    - +

    - + - +
    bool sf::Window::IsOpened float sf::Window::GetFrameTime (  )  const const

    -Tell whether or not the window is opened (ie. +Get time elapsed since last frame.

    -has been created). Note that a hidden window (Show(false)) will still return true

    -

    Returns:
    True if the window is opened
    +
    Returns:
    Time elapsed, in seconds
    + +

    Definition at line 394 of file Window.cpp.

    - +

    - + - +
    unsigned int sf::Window::GetWidth unsigned int sf::Window::GetHeight (  )  const const

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

    -

    Returns:
    Width in pixels
    +
    Returns:
    Height in pixels
    + +

    Reimplemented in sf::RenderWindow.

    + +

    Definition at line 200 of file Window.cpp.

    -

    -Reimplemented in sf::RenderWindow.

    - +

    - + - +
    unsigned int sf::Window::GetHeight const Input & sf::Window::GetInput (  )  const const

    -Get the height of the rendering region of the window. +Get the input manager of the window.

    -

    Returns:
    Height in pixels
    +
    Returns:
    Reference to the input
    + +

    Definition at line 376 of file Window.cpp.

    -

    -Reimplemented in sf::RenderWindow.

    - +

    - + - +
    const WindowSettings& sf::Window::GetSettings const WindowSettings & sf::Window::GetSettings (  )  const const
    @@ -460,87 +571,89 @@ Get the creation settings of the window.

    Returns:
    Structure containing the creation settings
    +

    Definition at line 209 of file Window.cpp.

    +

    - +

    - + - - + - +
    bool sf::Window::GetEvent unsigned int sf::Window::GetWidth (Event &  EventReceived  )  const

    -Get the event on top of events stack, if any, and pop it. +Get the width of the rendering region of the window.

    -

    Parameters:
    - - -
    EventReceived : Event to fill, if any
    -
    -
    Returns:
    True if an event was returned, false if events stack was empty
    +
    Returns:
    Width in pixels
    + +

    Reimplemented in sf::RenderWindow.

    + +

    Definition at line 191 of file Window.cpp.

    - +

    - + - - + - +
    void sf::Window::UseVerticalSync bool sf::Window::IsOpened (bool  Enabled  )  const

    -Enable / disable vertical synchronization. +Tell whether or not the window is opened (ie.

    -

    Parameters:
    - - -
    Enabled : True to enable v-sync, false to deactivate
    -
    +has been created). Note that a hidden window (Show(false)) will still return true

    +

    Returns:
    True if the window is opened
    +has been created). Note that a hidden window (Show(false)) will still return true +

    Definition at line 182 of file Window.cpp.

    - +

    - + - + - +
    void sf::Window::ShowMouseCursor bool sf::Window::SetActive ( bool  Show Active = true  )  const

    -Show or hide the mouse cursor. +Activate of deactivate the window as the current target for rendering.

    +Activate of deactivate the window as the current target for rendering.

    Parameters:
    - +
    Show : True to show, false to hide
    Active : True to activate, false to deactivate (true by default)
    +
    Returns:
    True if operation was successful, false otherwise
    + +

    Definition at line 338 of file Window.cpp.

    @@ -563,7 +676,7 @@ Show or hide the mouse cursor. ) - + @@ -579,52 +692,46 @@ Change the position of the mouse cursor. +

    Definition at line 260 of file Window.cpp.

    +

    - +

    - + - - - - - - - - - - + + + - -
    void sf::Window::SetPosition void sf::Window::SetFramerateLimit (int  Left,
    int  Top 
    unsigned int  Limit  )  )

    -Change the position of the window on screen. +Limit the framerate to a maximum fixed frequency.

    -Only works for top-level windows

    +Set the framerate at a fixed frequency.

    Parameters:
    - - +
    Left : Left position
    Top : Top position
    Limit : Framerate limit, in frames per seconds (use 0 to disable limit)
    +

    Definition at line 385 of file Window.cpp.

    +

    - +

    - + @@ -633,90 +740,114 @@ Only works for top-level windows

    - + + + + + + + - +
    void sf::Window::SetSize void sf::Window::SetIcon ( unsigned int  Width, unsigned int  Height  Height,
    const Uint8 *  Pixels 
    )

    -Change the size of the rendering region of the window. +Change the window's icon.

    Parameters:
    - - + + +
    Width : New width
    Height : New height
    Width : Icon's width, in pixels
    Height : Icon's height, in pixels
    Pixels : Pointer to the pixels in memory, format must be RGBA 32 bits
    +

    Definition at line 327 of file Window.cpp.

    +

    - +

    - + - - + + - +
    void sf::Window::Show void sf::Window::SetJoystickThreshold (bool  State float  Threshold  ) 

    -Show or hide the window. +Change the joystick threshold, ie.

    +the value below which no move event will be generated

    Parameters:
    - +
    State : True to show, false to hide
    Threshold : New threshold, in range [0, 100]
    +the value below which no move event will be generated +

    Definition at line 404 of file Window.cpp.

    - +

    - + - - - - + + + + + + + + + + + + +
    void sf::Window::EnableKeyRepeat void sf::Window::SetPosition (bool  Enabled  ) int  Left,
    int  Top 
    )

    -Enable or disable automatic key-repeat. +Change the position of the window on screen.

    -Automatic key-repeat is enabled by default

    +Only works for top-level windows

    Parameters:
    - + +
    Enabled : True to enable, false to disable
    Left : Left position
    Top : Top position
    +

    Definition at line 276 of file Window.cpp.

    +

    - +

    - + @@ -725,186 +856,121 @@ Automatic key-repeat is enabled by default

    - - - - - - - + - +
    void sf::Window::SetIcon void sf::Window::SetSize ( unsigned int  Width, unsigned int  Height,
    const Uint8 *  Pixels  Height 
    )

    -Change the window's icon. +Change the size of the rendering region of the window.

    Parameters:
    - - - + +
    Width : Icon's width, in pixels
    Height : Icon's height, in pixels
    Pixels : Pointer to the pixels in memory, format must be RGBA 32 bits
    Width : New width
    Height : New height
    +

    Definition at line 293 of file Window.cpp.

    +

    - +

    - + - + - +
    bool sf::Window::SetActive void sf::Window::Show ( bool  Active = true State  )  const

    -Activate of deactivate the window as the current target for rendering. +Show or hide the window.

    Parameters:
    - +
    Active : True to activate, false to deactivate (true by default)
    State : True to show, false to hide
    -
    Returns:
    True if operation was successful, false otherwise
    - -
    -

    - -

    -
    - - - - - - - - -
    void sf::Window::Display (  ) 
    -
    -
    -

    -Display the window on screen. -

    +

    Definition at line 303 of file Window.cpp.

    - -

    -
    - - - - - - - - -
    const Input& sf::Window::GetInput (  )  const
    -
    -
    - -

    -Get the input manager of the window. -

    -

    Returns:
    Reference to the input
    - -
    -

    - +

    - + - - + + - +
    void sf::Window::SetFramerateLimit void sf::Window::ShowMouseCursor (unsigned int  Limit bool  Show  ) 

    -Limit the framerate to a maximum fixed frequency. +Show or hide the mouse cursor.

    Parameters:
    - +
    Limit : Framerate limit, in frames per seconds (use 0 to disable limit)
    Show : True to show, false to hide
    -
    -

    - -

    -
    - - - - - - - - -
    float sf::Window::GetFrameTime (  )  const
    -
    -
    - -

    -Get time elapsed since last frame. -

    -

    Returns:
    Time elapsed, in seconds
    +

    Definition at line 250 of file Window.cpp.

    - +

    - + - - + + - +
    void sf::Window::SetJoystickThreshold void sf::Window::UseVerticalSync (float  Threshold bool  Enabled  ) 

    -Change the joystick threshold, ie. +Enable / disable vertical synchronization.

    -the value below which no move event will be generated

    Parameters:
    - +
    Threshold : New threshold, in range [0, 100]
    Enabled : True to enable v-sync, false to deactivate
    +

    Definition at line 240 of file Window.cpp.

    +

    -

    The documentation for this class was generated from the following file: +
    The documentation for this class was generated from the following files: + - -
    - -
    -
    - + + +

    sf::WindowListener Member List

    This is the complete list of members for sf::WindowListener, including all inherited members.

    -
    OnEvent(const Event &EventReceived)=0sf::WindowListener [pure virtual]
    ~WindowListener()sf::WindowListener [inline, protected, virtual]
    +

    + - -
    - + + -
    - -
    -
    -sf::WindowListener
    +

    sf::WindowListener Class Reference

    Base class for classes that want to receive events from a window (for internal use only). More...

    #include <WindowListener.hpp>

    -

    Inheritance diagram for sf::WindowListener: +

    +Inheritance diagram for sf::WindowListener:
    +
    +

    sf::Input sf::Window sf::RenderWindow +
    + +

    List of all members. @@ -54,10 +63,8 @@

    Public Member Functions

    Detailed Description

    Base class for classes that want to receive events from a window (for internal use only). -

    - -

    -Definition at line 42 of file WindowListener.hpp.

    Constructor & Destructor Documentation

    +

    Definition at line 42 of file WindowListener.hpp.

    +

    Constructor & Destructor Documentation

    @@ -67,7 +74,7 @@ Definition at line 42 (  )  - [inline, protected, virtual] + [inline, protected, virtual]
    @@ -77,8 +84,8 @@ Definition at line 42 Destructor.

    -

    -Definition at line 60 of file WindowListener.hpp. +

    Definition at line 60 of file WindowListener.hpp.

    +

    Member Function Documentation

    @@ -92,7 +99,7 @@ Definition at line 60 const Event &  EventReceived  )  - [pure virtual] + [pure virtual]
    @@ -111,6 +118,7 @@ Called each time an event is received from attached window.

    The documentation for this class was generated from the following file: + - -
    - + + -

    SFML File List

    Here is a list of all documented files with brief descriptions: +
    +

    File List

    Here is a list of all documented files with brief descriptions:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AppController.h [code]
    AppController.mm [code]
    Arial.hpp [code]
    Audio.hpp [code]
    AudioDevice.cpp [code]
    AudioDevice.hpp [code]
    AudioResource.cpp [code]
    AudioResource.hpp [code]
    Clock.cpp [code]
    Clock.hpp [code]
    Color.cpp [code]
    Color.hpp [code]
    Config.hpp [code]
    Context.cpp [code]
    Context.hpp [code]
    Doxygen.hpp [code]
    Drawable.cpp [code]
    Drawable.hpp [code]
    Event.hpp [code]
    Font.cpp [code]
    Font.hpp [code]
    FontLoader.cpp [code]
    FontLoader.hpp [code]
    Ftp.cpp [code]
    Ftp.hpp [code]
    GLKit.h [code]
    GLKit.mm [code]
    Glyph.hpp [code]
    Graphics.hpp [code]
    GraphicsContext.cpp [code]
    GraphicsContext.hpp [code]
    Http.cpp [code]
    Http.hpp [code]
    Image.cpp [code]
    Image.hpp [code]
    ImageLoader.cpp [code]
    ImageLoader.hpp [code]
    Initializer.cpp [code]
    Input.cpp [code]
    Input.hpp [code]
    IPAddress.cpp [code]
    IPAddress.hpp [code]
    Cocoa/Joystick.cpp [code]
    Template for new ports/Joystick.cpp [code]
    Win32/Joystick.cpp [code]
    Cocoa/Joystick.hpp [code]
    Joystick.hpp [code]
    Template for new ports/Joystick.hpp [code]
    Win32/Joystick.hpp [code]
    Listener.cpp [code]
    Listener.hpp [code]
    Lock.cpp [code]
    Lock.hpp [code]
    Matrix3.cpp [code]
    Matrix3.hpp [code]
    Matrix3.inl [code]
    Music.cpp [code]
    Music.hpp [code]
    Mutex.cpp [code]
    Mutex.hpp [code]
    Win32/Mutex.hpp [code]
    Network.hpp [code]
    NonCopyable.hpp [code]
    OpenAL.hpp [code]
    OpenGL.hpp [code]
    Packet.cpp [code]
    Packet.hpp [code]
    Platform.cpp [code]
    Platform.hpp [code]
    Win32/Platform.hpp [code]
    PostFX.cpp [code]
    PostFX.hpp [code]
    Randomizer.cpp [code]
    Randomizer.hpp [code]
    Rect.hpp [code]
    Rect.inl [code]
    RenderTarget.cpp [code]
    RenderTarget.hpp [code]
    RenderWindow.cpp [code]
    RenderWindow.hpp [code]
    Resource.hpp [code]
    Resource.inl [code]
    ResourcePtr.inl [code]
    Selector.hpp [code]
    Selector.inl [code]
    SelectorBase.cpp [code]
    SelectorBase.hpp [code]
    SFML_Main.cpp [code]
    Shape.cpp [code]
    Shape.hpp [code]
    Sleep.cpp [code]
    Sleep.hpp [code]
    SocketHelper.cpp [code]
    SocketHelper.hpp [code]
    Win32/SocketHelper.hpp [code]
    Sockets.hpp [code]
    SocketTCP.cpp [code]
    SocketTCP.hpp [code]
    SocketUDP.cpp [code]
    SocketUDP.hpp [code]
    Sound.cpp [code]
    Sound.hpp [code]
    SoundBuffer.cpp [code]
    SoundBuffer.hpp [code]
    SoundBufferRecorder.cpp [code]
    SoundBufferRecorder.hpp [code]
    SoundFile.cpp [code]
    SoundFile.hpp [code]
    SoundFileDefault.cpp [code]
    SoundFileDefault.hpp [code]
    SoundFileOgg.cpp [code]
    SoundFileOgg.hpp [code]
    SoundRecorder.cpp [code]
    SoundRecorder.hpp [code]
    SoundStream.cpp [code]
    SoundStream.hpp [code]
    Sprite.cpp [code]
    Sprite.hpp [code]
    String.cpp [code]
    String.hpp [code]
    System.hpp [code]
    Thread.cpp [code]
    Thread.hpp [code]
    Win32/Thread.hpp [code]
    Unicode.cpp [code]
    Unicode.hpp [code]
    Unicode.inl [code]
    Vector2.hpp [code]
    Vector2.inl [code]
    Vector3.hpp [code]
    Vector3.inl [code]
    VideoMode.cpp [code]
    VideoMode.hpp [code]
    Cocoa/VideoModeSupport.cpp [code]
    Template for new ports/VideoModeSupport.cpp [code]
    Win32/VideoModeSupport.cpp [code]
    Cocoa/VideoModeSupport.hpp [code]
    Template for new ports/VideoModeSupport.hpp [code]
    VideoModeSupport.hpp [code]
    Win32/VideoModeSupport.hpp [code]
    View.cpp [code]
    View.hpp [code]
    Window.cpp [code]
    Window/Window.hpp [code]
    Window.hpp [code]
    WindowHandle.hpp [code]
    WindowImpl.cpp [code]
    WindowImpl.hpp [code]
    WindowImplCocoa.hpp [code]
    WindowImplCocoa.mm [code]
    WindowImplWin32.cpp [code]
    WindowImplWin32.hpp [code]
    WindowImplXXX.cpp [code]
    WindowImplXXX.hpp [code]
    WindowListener.hpp [code]
    WindowSettings.hpp [code]
    WindowStyle.hpp [code]
    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - a -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - b -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - c -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - d -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - e -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - f -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - g -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - h -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - i -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - k -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - l -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - m -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - n -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - o -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - p -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - r -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - s -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - t -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - u -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - v -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - w -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - x -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - y -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - z -

      @@ -78,6 +77,7 @@ Here is a list of all documented class members with links to the class documenta
    • Zoom() : sf::View
    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

    Here is a list of all documented class members with links to the class documentation for each member:

    - ~ -

    +
    - -
    - -
    -
    - -
    -
    - + + +
     

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - a -

    - b -

    - c -

    - d -

    - e -

    - f -

    - g -

    - h -

    - i -

    -

    - j -

    -

    - k -

    - l -

    - m -

    - n -

    - o -

    - p -

    - r -

    - s -

    - t -

    - u -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - a -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - b -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - c -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - d -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - e -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - f -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - g -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - h -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - i -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - k -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - l -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - m -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - n -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - o -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - p -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - r -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - s -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - t -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - u -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - v -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - w -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - z -

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - ~ -

    +
    - -
    - -
    -
    - -
    -
    - + + +
     

    +
    - -
    - + + -
    - -
    -
    - -
    -
    - -
    - -

    +

     

    - a -

    - b -

    - c -

    - d -

    @@ -116,26 +99,12 @@

    - h -

    - i -

    -

    - j -

    -

    - k -

    - l -

    +
    - -
    - + + -
    - -
    -

    SFML Class Hierarchy

    This inheritance list is sorted roughly, but not completely, alphabetically: +
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • -
  • -
  • -
  • +
  • +
  • +
  • +
  • +
  • +
  • -
  • -
  • +
  • +
  • @@ -58,12 +61,12 @@
  • -
  • +
  • -
  • +
  • @@ -71,6 +74,7 @@
  • +
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • -
  • -
  • +
  • +
  • @@ -163,9 +170,9 @@
  • -
  • +
  • -
  • +
  • @@ -176,91 +183,178 @@
  • +
  • + + diff --git a/doc/html/index.hhk b/doc/html/index.hhk index 0c2a847..ff0c0b8 100755 --- a/doc/html/index.hhk +++ b/doc/html/index.hhk @@ -5,9 +5,8 @@ +
  • +
  • +
  • +
  • +
  • -
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • + +
  • -
  • +
  • -
  • -
  • +
  • +
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • +
  • + +
  • +
  • -
  • -
  • +
  • +
  • -
  • +
  • -
  • +
  • @@ -645,30 +674,19 @@
  • -
  • +
  • -
  • -
  • -
  • +
  • -
  • -
  • +
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • +
  • +
  • -
  • -
  • -
  • +
  • +
  • +
  • -
  • -
  • -
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • - -
  • -
  • -
  • - -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • +
  • + +
  • +
  • +
  • + +
  • -
  • +
  • -
  • +
  • -
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • -
  • - -
  • -
  • -
  • -
  • - -
  • -
  • +
  • +
  • -
  • -
  • -
  • -
  • -
  • -
  • -
  • +
  • +
  • +
  • +
  • -
  • +
  • -
  • +
  • -
  • - +
  • -
  • -
  • -
  • +
  • -
  • -
  • +
  • -
  • +
  • -
  • -
  • +
  • +
  • @@ -886,37 +868,34 @@
  • -
  • +
  • -
  • +
  • +
  • -
  • -
  • -
  • -
  • +
  • -
  • @@ -925,42 +904,46 @@
  • -
  • -
  • +
  • +
  • + +
  • +
  • -
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • @@ -971,10 +954,8 @@
  • -
  • -
  • -
  • +
  • +
  • +
  • @@ -995,25 +978,30 @@
  • -
  • -
  • -
  • +
  • +
  • +
  • -
  • +
  • -
  • +
  • +
  • +
  • +
  • -
  • +
  • -
  • +
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • -
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • -
  • +
  • +