lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Changed the naming convention for public member variables/functions and free functions (using lowerCase instead of UpperCase)

Browse source
This commit is contained in:
Laurent Gomila 2012-03-11 19:10:37 +01:00
parent ff5b69d312
commit 14ac411542
200 changed files with 4302 additions and 4320 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/mainpage.hpp
View file

@ -23,47 +23,47 @@
/// ///
/// // Load a sprite to display /// // Load a sprite to display
/// sf::Texture texture; /// sf::Texture texture;
/// if (!texture.LoadFromFile("cute_image.jpg")) /// if (!texture.loadFromFile("cute_image.jpg"))
/// return EXIT_FAILURE; /// return EXIT_FAILURE;
/// sf::Sprite sprite(texture); /// sf::Sprite sprite(texture);
/// ///
/// // Create a graphical text to display /// // Create a graphical text to display
/// sf::Font font; /// sf::Font font;
/// if (!font.LoadFromFile("arial.ttf")) /// if (!font.loadFromFile("arial.ttf"))
/// return EXIT_FAILURE; /// return EXIT_FAILURE;
/// sf::Text text("Hello SFML", font, 50); /// sf::Text text("Hello SFML", font, 50);
/// ///
/// // Load a music to play /// // Load a music to play
/// sf::Music music; /// sf::Music music;
/// if (!music.OpenFromFile("nice_music.ogg")) /// if (!music.openFromFile("nice_music.ogg"))
/// return EXIT_FAILURE; /// return EXIT_FAILURE;
/// ///
/// // Play the music /// // Play the music
/// music.Play(); /// music.play();
/// ///
/// // Start the game loop /// // Start the game loop
/// while (window.IsOpen()) /// while (window.isOpen())
/// { /// {
/// // Process events /// // Process events
/// sf::Event event; /// sf::Event event;
/// while (window.PollEvent(event)) /// while (window.pollEvent(event))
/// { /// {
/// // Close window : exit /// // Close window : exit
/// if (event.Type == sf::Event::Closed) /// if (event.type == sf::Event::Closed)
/// window.Close(); /// window.close();
/// } /// }
/// ///
/// // Clear screen /// // Clear screen
/// window.Clear(); /// window.clear();
/// ///
/// // Draw the sprite /// // Draw the sprite
/// window.Draw(sprite); /// window.draw(sprite);
/// ///
/// // Draw the string /// // Draw the string
/// window.Draw(text); /// window.draw(text);
/// ///
/// // Update the window /// // Update the window
/// window.Display(); /// window.display();
/// } /// }
/// ///
/// return EXIT_SUCCESS; /// return EXIT_SUCCESS;

20
examples/X11/X11.cpp
View file

@ -15,10 +15,10 @@
/// \param Window Target window to initialize /// \param Window Target window to initialize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Initialize(sf::Window& window) void initialize(sf::Window& window)
{ {
// Activate the window // Activate the window
window.SetActive(); window.setActive();
// Setup OpenGL states // Setup OpenGL states
// Set color and depth clear value // Set color and depth clear value
@ -43,10 +43,10 @@ void Initialize(sf::Window& window)
/// \param elapsedTime Time elapsed since the last draw /// \param elapsedTime Time elapsed since the last draw
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Draw(sf::Window& window, float elapsedTime) void draw(sf::Window& window, float elapsedTime)
{ {
// Activate the window // Activate the window
window.SetActive(); window.setActive();
// Clear color and depth buffers // Clear color and depth buffers
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
@ -160,8 +160,8 @@ int main()
sf::Clock clock; sf::Clock clock;
// Initialize our views // Initialize our views
Initialize(SFMLView1); initialize(SFMLView1);
Initialize(SFMLView2); initialize(SFMLView2);
// Start the event loop // Start the event loop
bool running = true; bool running = true;
@ -184,12 +184,12 @@ int main()
} }
// Draw something into our views // Draw something into our views
Draw(SFMLView1, clock.GetElapsedTime().AsSeconds()); draw(SFMLView1, clock.getElapsedTime().asSeconds());
Draw(SFMLView2, clock.GetElapsedTime().AsSeconds() * 0.3f); draw(SFMLView2, clock.getElapsedTime().asSeconds() * 0.3f);
// Display the views on screen // Display the views on screen
SFMLView1.Display(); SFMLView1.display();
SFMLView2.Display(); SFMLView2.display();
} }
// Close the display // Close the display

34
examples/ftp/Ftp.cpp
View file

@ -13,7 +13,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::ostream& operator <<(std::ostream& stream, const sf::Ftp::Response& response) std::ostream& operator <<(std::ostream& stream, const sf::Ftp::Response& response)
{ {
return stream << response.GetStatus() << response.GetMessage(); return stream << response.getStatus() << response.getMessage();
} }
@ -36,9 +36,9 @@ int main()
// Connect to the server // Connect to the server
sf::Ftp server; sf::Ftp server;
sf::Ftp::Response connectResponse = server.Connect(address); sf::Ftp::Response connectResponse = server.connect(address);
std::cout << connectResponse << std::endl; std::cout << connectResponse << std::endl;
if (!connectResponse.IsOk()) if (!connectResponse.isOk())
return EXIT_FAILURE; return EXIT_FAILURE;
// Ask for user name and password // Ask for user name and password
@ -49,9 +49,9 @@ int main()
std::cin >> password; std::cin >> password;
// Login to the server // Login to the server
sf::Ftp::Response loginResponse = server.Login(user, password); sf::Ftp::Response loginResponse = server.login(user, password);
std::cout << loginResponse << std::endl; std::cout << loginResponse << std::endl;
if (!loginResponse.IsOk()) if (!loginResponse.isOk())
return EXIT_FAILURE; return EXIT_FAILURE;
// Main menu // Main menu
@ -91,18 +91,18 @@ int main()
case 1 : case 1 :
{ {
// Print the current server directory // Print the current server directory
sf::Ftp::DirectoryResponse response = server.GetWorkingDirectory(); sf::Ftp::DirectoryResponse response = server.getWorkingDirectory();
std::cout << response << std::endl; std::cout << response << std::endl;
std::cout << "Current directory is " << response.GetDirectory() << std::endl; std::cout << "Current directory is " << response.getDirectory() << std::endl;
break; break;
} }
case 2 : case 2 :
{ {
// Print the contents of the current server directory // Print the contents of the current server directory
sf::Ftp::ListingResponse response = server.GetDirectoryListing(); sf::Ftp::ListingResponse response = server.getDirectoryListing();
std::cout << response << std::endl; std::cout << response << std::endl;
std::vector<std::string> filenames = response.GetFilenames(); std::vector<std::string> filenames = response.getFilenames();
for (std::vector<std::string>::const_iterator it = filenames.begin(); it != filenames.end(); ++it) for (std::vector<std::string>::const_iterator it = filenames.begin(); it != filenames.end(); ++it)
std::cout << *it << std::endl; std::cout << *it << std::endl;
break; break;
@ -114,7 +114,7 @@ int main()
std::string directory; std::string directory;
std::cout << "Choose a directory: "; std::cout << "Choose a directory: ";
std::cin >> directory; std::cin >> directory;
std::cout << server.ChangeDirectory(directory) << std::endl; std::cout << server.changeDirectory(directory) << std::endl;
break; break;
} }
@ -124,7 +124,7 @@ int main()
std::string directory; std::string directory;
std::cout << "Name of the directory to create: "; std::cout << "Name of the directory to create: ";
std::cin >> directory; std::cin >> directory;
std::cout << server.CreateDirectory(directory) << std::endl; std::cout << server.createDirectory(directory) << std::endl;
break; break;
} }
@ -134,7 +134,7 @@ int main()
std::string directory; std::string directory;
std::cout << "Name of the directory to remove: "; std::cout << "Name of the directory to remove: ";
std::cin >> directory; std::cin >> directory;
std::cout << server.DeleteDirectory(directory) << std::endl; std::cout << server.deleteDirectory(directory) << std::endl;
break; break;
} }
@ -146,7 +146,7 @@ int main()
std::cin >> source; std::cin >> source;
std::cout << "New name: "; std::cout << "New name: ";
std::cin >> destination; std::cin >> destination;
std::cout << server.RenameFile(source, destination) << std::endl; std::cout << server.renameFile(source, destination) << std::endl;
break; break;
} }
@ -156,7 +156,7 @@ int main()
std::string filename; std::string filename;
std::cout << "Name of the file to remove: "; std::cout << "Name of the file to remove: ";
std::cin >> filename; std::cin >> filename;
std::cout << server.DeleteFile(filename) << std::endl; std::cout << server.deleteFile(filename) << std::endl;
break; break;
} }
@ -168,7 +168,7 @@ int main()
std::cin >> filename; std::cin >> filename;
std::cout << "Directory to download the file to: "; std::cout << "Directory to download the file to: ";
std::cin >> directory; std::cin >> directory;
std::cout << server.Download(filename, directory) << std::endl; std::cout << server.download(filename, directory) << std::endl;
break; break;
} }
@ -180,7 +180,7 @@ int main()
std::cin >> filename; std::cin >> filename;
std::cout << "Directory to upload the file to (relative to current directory): "; std::cout << "Directory to upload the file to (relative to current directory): ";
std::cin >> directory; std::cin >> directory;
std::cout << server.Upload(filename, directory) << std::endl; std::cout << server.upload(filename, directory) << std::endl;
break; break;
} }
@ -195,7 +195,7 @@ int main()
// Disconnect from the server // Disconnect from the server
std::cout << "Disconnecting from server..." << std::endl; std::cout << "Disconnecting from server..." << std::endl;
std::cout << server.Disconnect() << std::endl; std::cout << server.disconnect() << std::endl;
// Wait until the user presses 'enter' key // Wait until the user presses 'enter' key
std::cout << "Press enter to exit..." << std::endl; std::cout << "Press enter to exit..." << std::endl;

54
examples/opengl/OpenGL.cpp
View file

@ -16,11 +16,11 @@ int main()
{ {
// Create the main window // Create the main window
sf::RenderWindow window(sf::VideoMode(800, 600), "SFML OpenGL", sf::Style::Default, sf::ContextSettings(32)); sf::RenderWindow window(sf::VideoMode(800, 600), "SFML OpenGL", sf::Style::Default, sf::ContextSettings(32));
window.SetVerticalSyncEnabled(true); window.setVerticalSyncEnabled(true);
// Create a sprite for the background // Create a sprite for the background
sf::Texture backgroundTexture; sf::Texture backgroundTexture;
if (!backgroundTexture.LoadFromFile("resources/background.jpg")) if (!backgroundTexture.loadFromFile("resources/background.jpg"))
return EXIT_FAILURE; return EXIT_FAILURE;
sf::Sprite background(backgroundTexture); sf::Sprite background(backgroundTexture);
@ -30,11 +30,11 @@ int main()
GLuint texture = 0; GLuint texture = 0;
{ {
sf::Image image; sf::Image image;
if (!image.LoadFromFile("resources/texture.jpg")) if (!image.loadFromFile("resources/texture.jpg"))
return EXIT_FAILURE; return EXIT_FAILURE;
glGenTextures(1, &texture); glGenTextures(1, &texture);
glBindTexture(GL_TEXTURE_2D, texture); glBindTexture(GL_TEXTURE_2D, texture);
gluBuild2DMipmaps(GL_TEXTURE_2D, GL_RGBA, image.GetWidth(), image.GetHeight(), GL_RGBA, GL_UNSIGNED_BYTE, image.GetPixelsPtr()); gluBuild2DMipmaps(GL_TEXTURE_2D, GL_RGBA, image.getWidth(), image.getHeight(), GL_RGBA, GL_UNSIGNED_BYTE, image.getPixelsPtr());
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_LINEAR);
} }
@ -58,49 +58,49 @@ int main()
sf::Clock clock; sf::Clock clock;
// Start game loop // Start game loop
while (window.IsOpen()) while (window.isOpen())
{ {
// Process events // Process events
sf::Event event; sf::Event event;
while (window.PollEvent(event)) while (window.pollEvent(event))
{ {
// Close window : exit // Close window : exit
if (event.Type == sf::Event::Closed) if (event.type == sf::Event::Closed)
window.Close(); window.close();
// Escape key : exit // Escape key : exit
if ((event.Type == sf::Event::KeyPressed) && (event.Key.Code == sf::Keyboard::Escape)) if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape))
window.Close(); window.close();
// Adjust the viewport when the window is resized // Adjust the viewport when the window is resized
if (event.Type == sf::Event::Resized) if (event.type == sf::Event::Resized)
glViewport(0, 0, event.Size.Width, event.Size.Height); glViewport(0, 0, event.size.width, event.size.height);
} }
// Draw the background // Draw the background
window.PushGLStates(); window.pushGLStates();
window.Draw(background); window.draw(background);
window.PopGLStates(); window.popGLStates();
// Activate the window before using OpenGL commands. // Activate the window before using OpenGL commands.
// This is useless here because we have only one window which is // This is useless here because we have only one window which is
// always the active one, but don't forget it if you use multiple windows // always the active one, but don't forget it if you use multiple windows
window.SetActive(); window.setActive();
// Clear the depth buffer // Clear the depth buffer
glClear(GL_DEPTH_BUFFER_BIT); glClear(GL_DEPTH_BUFFER_BIT);
// We get the position of the mouse cursor, so that we can move the box accordingly // We get the position of the mouse cursor, so that we can move the box accordingly
float x = sf::Mouse::GetPosition(window).x * 200.f / window.GetSize().x - 100.f; float x = sf::Mouse::getPosition(window).x * 200.f / window.getSize().x - 100.f;
float y = -sf::Mouse::GetPosition(window).y * 200.f / window.GetSize().y + 100.f; float y = -sf::Mouse::getPosition(window).y * 200.f / window.getSize().y + 100.f;
// Apply some transformations // Apply some transformations
glMatrixMode(GL_MODELVIEW); glMatrixMode(GL_MODELVIEW);
glLoadIdentity(); glLoadIdentity();
glTranslatef(x, y, -100.f); glTranslatef(x, y, -100.f);
glRotatef(clock.GetElapsedTime().AsSeconds() * 50.f, 1.f, 0.f, 0.f); glRotatef(clock.getElapsedTime().asSeconds() * 50.f, 1.f, 0.f, 0.f);
glRotatef(clock.GetElapsedTime().AsSeconds() * 30.f, 0.f, 1.f, 0.f); glRotatef(clock.getElapsedTime().asSeconds() * 30.f, 0.f, 1.f, 0.f);
glRotatef(clock.GetElapsedTime().AsSeconds() * 90.f, 0.f, 0.f, 1.f); glRotatef(clock.getElapsedTime().asSeconds() * 90.f, 0.f, 0.f, 1.f);
// Draw a cube // Draw a cube
float size = 20.f; float size = 20.f;
@ -139,15 +139,15 @@ int main()
glEnd(); glEnd();
// Draw some text on top of our OpenGL object // Draw some text on top of our OpenGL object
window.PushGLStates(); window.pushGLStates();
sf::Text text("SFML / OpenGL demo"); sf::Text text("SFML / OpenGL demo");
text.SetColor(sf::Color(255, 255, 255, 170)); text.setColor(sf::Color(255, 255, 255, 170));
text.SetPosition(250.f, 450.f); text.setPosition(250.f, 450.f);
window.Draw(text); window.draw(text);
window.PopGLStates(); window.popGLStates();
// Finally, display the rendered frame on screen // Finally, display the rendered frame on screen
window.Display(); window.display();
} }
// Don't forget to destroy our texture // Don't forget to destroy our texture

156
examples/pong/Pong.cpp
View file

@ -28,54 +28,54 @@ int main()
// Create the window of the application // Create the window of the application
sf::RenderWindow window(sf::VideoMode(gameWidth, gameHeight, 32), "SFML Pong"); sf::RenderWindow window(sf::VideoMode(gameWidth, gameHeight, 32), "SFML Pong");
window.SetVerticalSyncEnabled(true); window.setVerticalSyncEnabled(true);
// Load the sounds used in the game // Load the sounds used in the game
sf::SoundBuffer ballSoundBuffer; sf::SoundBuffer ballSoundBuffer;
if (!ballSoundBuffer.LoadFromFile("resources/ball.wav")) if (!ballSoundBuffer.loadFromFile("resources/ball.wav"))
return EXIT_FAILURE; return EXIT_FAILURE;
sf::Sound ballSound(ballSoundBuffer); sf::Sound ballSound(ballSoundBuffer);
// Create the left paddle // Create the left paddle
sf::RectangleShape leftPaddle; sf::RectangleShape leftPaddle;
leftPaddle.SetSize(paddleSize - sf::Vector2f(3, 3)); leftPaddle.setSize(paddleSize - sf::Vector2f(3, 3));
leftPaddle.SetOutlineThickness(3); leftPaddle.setOutlineThickness(3);
leftPaddle.SetOutlineColor(sf::Color::Black); leftPaddle.setOutlineColor(sf::Color::Black);
leftPaddle.SetFillColor(sf::Color(100, 100, 200)); leftPaddle.setFillColor(sf::Color(100, 100, 200));
leftPaddle.SetOrigin(paddleSize / 2.f); leftPaddle.setOrigin(paddleSize / 2.f);
// Create the right paddle // Create the right paddle
sf::RectangleShape rightPaddle; sf::RectangleShape rightPaddle;
rightPaddle.SetSize(paddleSize - sf::Vector2f(3, 3)); rightPaddle.setSize(paddleSize - sf::Vector2f(3, 3));
rightPaddle.SetOutlineThickness(3); rightPaddle.setOutlineThickness(3);
rightPaddle.SetOutlineColor(sf::Color::Black); rightPaddle.setOutlineColor(sf::Color::Black);
rightPaddle.SetFillColor(sf::Color(200, 100, 100)); rightPaddle.setFillColor(sf::Color(200, 100, 100));
rightPaddle.SetOrigin(paddleSize / 2.f); rightPaddle.setOrigin(paddleSize / 2.f);
// Create the ball // Create the ball
sf::CircleShape ball; sf::CircleShape ball;
ball.SetRadius(ballRadius - 3); ball.setRadius(ballRadius - 3);
ball.SetOutlineThickness(3); ball.setOutlineThickness(3);
ball.SetOutlineColor(sf::Color::Black); ball.setOutlineColor(sf::Color::Black);
ball.SetFillColor(sf::Color::White); ball.setFillColor(sf::Color::White);
ball.SetOrigin(ballRadius / 2, ballRadius / 2); ball.setOrigin(ballRadius / 2, ballRadius / 2);
// Load the text font // Load the text font
sf::Font font; sf::Font font;
if (!font.LoadFromFile("resources/sansation.ttf")) if (!font.loadFromFile("resources/sansation.ttf"))
return EXIT_FAILURE; return EXIT_FAILURE;
// Initialize the pause message // Initialize the pause message
sf::Text pauseMessage; sf::Text pauseMessage;
pauseMessage.SetFont(font); pauseMessage.setFont(font);
pauseMessage.SetCharacterSize(40); pauseMessage.setCharacterSize(40);
pauseMessage.SetPosition(170.f, 150.f); pauseMessage.setPosition(170.f, 150.f);
pauseMessage.SetColor(sf::Color::White); pauseMessage.setColor(sf::Color::White);
pauseMessage.SetString("Welcome to SFML pong!\nPress space to start the game"); pauseMessage.setString("Welcome to SFML pong!\nPress space to start the game");
// Define the paddles properties // Define the paddles properties
sf::Clock AITimer; sf::Clock AITimer;
const sf::Time AITime = sf::Seconds(0.1f); const sf::Time AITime = sf::seconds(0.1f);
const float paddleSpeed = 400.f; const float paddleSpeed = 400.f;
float rightPaddleSpeed = 0.f; float rightPaddleSpeed = 0.f;
const float ballSpeed = 400.f; const float ballSpeed = 400.f;
@ -83,22 +83,22 @@ int main()
sf::Clock clock; sf::Clock clock;
bool isPlaying = false; bool isPlaying = false;
while (window.IsOpen()) while (window.isOpen())
{ {
// Handle events // Handle events
sf::Event event; sf::Event event;
while (window.PollEvent(event)) while (window.pollEvent(event))
{ {
// Window closed or escape key pressed: exit // Window closed or escape key pressed: exit
if ((event.Type == sf::Event::Closed) || if ((event.type == sf::Event::Closed) ||
((event.Type == sf::Event::KeyPressed) && (event.Key.Code == sf::Keyboard::Escape))) ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape)))
{ {
window.Close(); window.close();
break; break;
} }
// Space key pressed: play // Space key pressed: play
if ((event.Type == sf::Event::KeyPressed) && (event.Key.Code == sf::Keyboard::Space)) if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Space))
{ {
if (!isPlaying) if (!isPlaying)
{ {
@ -106,9 +106,9 @@ int main()
isPlaying = true; isPlaying = true;
// Reset the position of the paddles and ball // Reset the position of the paddles and ball
leftPaddle.SetPosition(10 + paddleSize.x / 2, gameHeight / 2); leftPaddle.setPosition(10 + paddleSize.x / 2, gameHeight / 2);
rightPaddle.SetPosition(gameWidth - 10 - paddleSize.x / 2, gameHeight / 2); rightPaddle.setPosition(gameWidth - 10 - paddleSize.x / 2, gameHeight / 2);
ball.SetPosition(gameWidth / 2, gameHeight / 2); ball.setPosition(gameWidth / 2, gameHeight / 2);
// Reset the ball angle // Reset the ball angle
do do
@ -123,34 +123,34 @@ int main()
if (isPlaying) if (isPlaying)
{ {
float deltaTime = clock.Restart().AsSeconds(); float deltaTime = clock.restart().asSeconds();
// Move the player's paddle // Move the player's paddle
if (sf::Keyboard::IsKeyPressed(sf::Keyboard::Up) && if (sf::Keyboard::isKeyPressed(sf::Keyboard::Up) &&
(leftPaddle.GetPosition().y - paddleSize.y / 2 > 5.f)) (leftPaddle.getPosition().y - paddleSize.y / 2 > 5.f))
{ {
leftPaddle.Move(0.f, -paddleSpeed * deltaTime); leftPaddle.move(0.f, -paddleSpeed * deltaTime);
} }
if (sf::Keyboard::IsKeyPressed(sf::Keyboard::Down) && if (sf::Keyboard::isKeyPressed(sf::Keyboard::Down) &&
(leftPaddle.GetPosition().y + paddleSize.y / 2 < gameHeight - 5.f)) (leftPaddle.getPosition().y + paddleSize.y / 2 < gameHeight - 5.f))
{ {
leftPaddle.Move(0.f, paddleSpeed * deltaTime); leftPaddle.move(0.f, paddleSpeed * deltaTime);
} }
// Move the computer's paddle // Move the computer's paddle
if (((rightPaddleSpeed < 0.f) && (rightPaddle.GetPosition().y - paddleSize.y / 2 > 5.f)) || if (((rightPaddleSpeed < 0.f) && (rightPaddle.getPosition().y - paddleSize.y / 2 > 5.f)) ||
((rightPaddleSpeed > 0.f) && (rightPaddle.GetPosition().y + paddleSize.y / 2 < gameHeight - 5.f))) ((rightPaddleSpeed > 0.f) && (rightPaddle.getPosition().y + paddleSize.y / 2 < gameHeight - 5.f)))
{ {
rightPaddle.Move(0.f, rightPaddleSpeed * deltaTime); rightPaddle.move(0.f, rightPaddleSpeed * deltaTime);
} }
// Update the computer's paddle direction according to the ball position // Update the computer's paddle direction according to the ball position
if (AITimer.GetElapsedTime() > AITime) if (AITimer.getElapsedTime() > AITime)
{ {
AITimer.Restart(); AITimer.restart();
if (ball.GetPosition().y + ballRadius > rightPaddle.GetPosition().y + paddleSize.y / 2) if (ball.getPosition().y + ballRadius > rightPaddle.getPosition().y + paddleSize.y / 2)
rightPaddleSpeed = paddleSpeed; rightPaddleSpeed = paddleSpeed;
else if (ball.GetPosition().y - ballRadius < rightPaddle.GetPosition().y - paddleSize.y / 2) else if (ball.getPosition().y - ballRadius < rightPaddle.getPosition().y - paddleSize.y / 2)
rightPaddleSpeed = -paddleSpeed; rightPaddleSpeed = -paddleSpeed;
else else
rightPaddleSpeed = 0.f; rightPaddleSpeed = 0.f;
@ -158,82 +158,82 @@ int main()
// Move the ball // Move the ball
float factor = ballSpeed * deltaTime; float factor = ballSpeed * deltaTime;
ball.Move(std::cos(ballAngle) * factor, std::sin(ballAngle) * factor); ball.move(std::cos(ballAngle) * factor, std::sin(ballAngle) * factor);
// Check collisions between the ball and the screen // Check collisions between the ball and the screen
if (ball.GetPosition().x - ballRadius < 0.f) if (ball.getPosition().x - ballRadius < 0.f)
{ {
isPlaying = false; isPlaying = false;
pauseMessage.SetString("You lost !\nPress space to restart or\nescape to exit"); pauseMessage.setString("You lost !\nPress space to restart or\nescape to exit");
} }
if (ball.GetPosition().x + ballRadius > 800) if (ball.getPosition().x + ballRadius > 800)
{ {
isPlaying = false; isPlaying = false;
pauseMessage.SetString("You won !\nPress space to restart or\nescape to exit"); pauseMessage.setString("You won !\nPress space to restart or\nescape to exit");
} }
if (ball.GetPosition().y - ballRadius < 0.f) if (ball.getPosition().y - ballRadius < 0.f)
{ {
ballSound.Play(); ballSound.play();
ballAngle = -ballAngle; ballAngle = -ballAngle;
ball.SetPosition(ball.GetPosition().x, ballRadius + 0.1f); ball.setPosition(ball.getPosition().x, ballRadius + 0.1f);
} }
if (ball.GetPosition().y + ballRadius > gameHeight) if (ball.getPosition().y + ballRadius > gameHeight)
{ {
ballSound.Play(); ballSound.play();
ballAngle = -ballAngle; ballAngle = -ballAngle;
ball.SetPosition(ball.GetPosition().x, gameHeight - ballRadius - 0.1f); ball.setPosition(ball.getPosition().x, gameHeight - ballRadius - 0.1f);
} }
// Check the collisions between the ball and the paddles // Check the collisions between the ball and the paddles
// Left Paddle // Left Paddle
if (ball.GetPosition().x - ballRadius < leftPaddle.GetPosition().x + paddleSize.x / 2 && if (ball.getPosition().x - ballRadius < leftPaddle.getPosition().x + paddleSize.x / 2 &&
ball.GetPosition().x - ballRadius > leftPaddle.GetPosition().x && ball.getPosition().x - ballRadius > leftPaddle.getPosition().x &&
ball.GetPosition().y + ballRadius >= leftPaddle.GetPosition().y - paddleSize.y / 2 && ball.getPosition().y + ballRadius >= leftPaddle.getPosition().y - paddleSize.y / 2 &&
ball.GetPosition().y - ballRadius <= leftPaddle.GetPosition().y + paddleSize.y / 2) ball.getPosition().y - ballRadius <= leftPaddle.getPosition().y + paddleSize.y / 2)
{ {
if (ball.GetPosition().y > leftPaddle.GetPosition().y) if (ball.getPosition().y > leftPaddle.getPosition().y)
ballAngle = pi - ballAngle + (std::rand() % 20) * pi / 180; ballAngle = pi - ballAngle + (std::rand() % 20) * pi / 180;
else else
ballAngle = pi - ballAngle - (std::rand() % 20) * pi / 180; ballAngle = pi - ballAngle - (std::rand() % 20) * pi / 180;
ballSound.Play(); ballSound.play();
ball.SetPosition(leftPaddle.GetPosition().x + ballRadius + paddleSize.x / 2 + 0.1f, ball.GetPosition().y); ball.setPosition(leftPaddle.getPosition().x + ballRadius + paddleSize.x / 2 + 0.1f, ball.getPosition().y);
} }
// Right Paddle // Right Paddle
if (ball.GetPosition().x + ballRadius > rightPaddle.GetPosition().x - paddleSize.x / 2 && if (ball.getPosition().x + ballRadius > rightPaddle.getPosition().x - paddleSize.x / 2 &&
ball.GetPosition().x + ballRadius < rightPaddle.GetPosition().x && ball.getPosition().x + ballRadius < rightPaddle.getPosition().x &&
ball.GetPosition().y + ballRadius >= rightPaddle.GetPosition().y - paddleSize.y / 2 && ball.getPosition().y + ballRadius >= rightPaddle.getPosition().y - paddleSize.y / 2 &&
ball.GetPosition().y - ballRadius <= rightPaddle.GetPosition().y + paddleSize.y / 2) ball.getPosition().y - ballRadius <= rightPaddle.getPosition().y + paddleSize.y / 2)
{ {
if (ball.GetPosition().y > rightPaddle.GetPosition().y) if (ball.getPosition().y > rightPaddle.getPosition().y)
ballAngle = pi - ballAngle + (std::rand() % 20) * pi / 180; ballAngle = pi - ballAngle + (std::rand() % 20) * pi / 180;
else else
ballAngle = pi - ballAngle - (std::rand() % 20) * pi / 180; ballAngle = pi - ballAngle - (std::rand() % 20) * pi / 180;
ballSound.Play(); ballSound.play();
ball.SetPosition(rightPaddle.GetPosition().x - ballRadius - paddleSize.x / 2 - 0.1f, ball.GetPosition().y); ball.setPosition(rightPaddle.getPosition().x - ballRadius - paddleSize.x / 2 - 0.1f, ball.getPosition().y);
} }
} }
// Clear the window // Clear the window
window.Clear(sf::Color(50, 200, 50)); window.clear(sf::Color(50, 200, 50));
if (isPlaying) if (isPlaying)
{ {
// Draw the paddles and the ball // Draw the paddles and the ball
window.Draw(leftPaddle); window.draw(leftPaddle);
window.Draw(rightPaddle); window.draw(rightPaddle);
window.Draw(ball); window.draw(ball);
} }
else else
{ {
// Draw the pause message // Draw the pause message
window.Draw(pauseMessage); window.draw(pauseMessage);
} }
// Display things on screen // Display things on screen
window.Display(); window.display();
} }
return EXIT_SUCCESS; return EXIT_SUCCESS;

26
examples/shader/Effect.hpp
View file

@ -19,34 +19,34 @@ public :
{ {
} }
const std::string& GetName() const const std::string& getName() const
{ {
return m_name; return m_name;
} }
void Load() void load()
{ {
m_isLoaded = sf::Shader::IsAvailable() && OnLoad(); m_isLoaded = sf::Shader::isAvailable() && onLoad();
} }
void Update(float time, float x, float y) void update(float time, float x, float y)
{ {
if (m_isLoaded) if (m_isLoaded)
OnUpdate(time, x, y); onUpdate(time, x, y);
} }
void Draw(sf::RenderTarget& target, sf::RenderStates states) const void draw(sf::RenderTarget& target, sf::RenderStates states) const
{ {
if (m_isLoaded) if (m_isLoaded)
{ {
OnDraw(target, states); onDraw(target, states);
} }
else else
{ {
sf::Text error("Shader not\nsupported"); sf::Text error("Shader not\nsupported");
error.SetPosition(320.f, 200.f); error.setPosition(320.f, 200.f);
error.SetCharacterSize(36); error.setCharacterSize(36);
target.Draw(error, states); target.draw(error, states);
} }
} }
@ -61,9 +61,9 @@ protected :
private : private :
// Virtual functions to be implemented in derived effects // Virtual functions to be implemented in derived effects
virtual bool OnLoad() = 0; virtual bool onLoad() = 0;
virtual void OnUpdate(float time, float x, float y) = 0; virtual void onUpdate(float time, float x, float y) = 0;
virtual void OnDraw(sf::RenderTarget& target, sf::RenderStates states) const = 0; virtual void onDraw(sf::RenderTarget& target, sf::RenderStates states) const = 0;
private : private :

168
examples/shader/Shader.cpp
View file

@ -20,30 +20,30 @@ public :
{ {
} }
bool OnLoad() bool onLoad()
{ {
// Load the texture and initialize the sprite // Load the texture and initialize the sprite
if (!m_texture.LoadFromFile("resources/background.jpg")) if (!m_texture.loadFromFile("resources/background.jpg"))
return false; return false;
m_sprite.SetTexture(m_texture); m_sprite.setTexture(m_texture);
// Load the shader // Load the shader
if (!m_shader.LoadFromFile("resources/pixelate.frag", sf::Shader::Fragment)) if (!m_shader.loadFromFile("resources/pixelate.frag", sf::Shader::Fragment))
return false; return false;
m_shader.SetParameter("texture", sf::Shader::CurrentTexture); m_shader.setParameter("texture", sf::Shader::CurrentTexture);
return true; return true;
} }
void OnUpdate(float, float x, float y) void onUpdate(float, float x, float y)
{ {
m_shader.SetParameter("pixel_threshold", (x + y) / 30); m_shader.setParameter("pixel_threshold", (x + y) / 30);
} }
void OnDraw(sf::RenderTarget& target, sf::RenderStates states) const void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
{ {
states.Shader = &m_shader; states.shader = &m_shader;
target.Draw(m_sprite, states); target.draw(m_sprite, states);
} }
private: private:
@ -66,10 +66,10 @@ public :
{ {
} }
bool OnLoad() bool onLoad()
{ {
// Create the text // Create the text
m_text.SetString("Praesent suscipit augue in velit pulvinar hendrerit varius purus aliquam.\n" m_text.setString("Praesent suscipit augue in velit pulvinar hendrerit varius purus aliquam.\n"
"Mauris mi odio, bibendum quis fringilla a, laoreet vel orci. Proin vitae vulputate tortor.\n" "Mauris mi odio, bibendum quis fringilla a, laoreet vel orci. Proin vitae vulputate tortor.\n"
"Praesent cursus ultrices justo, ut feugiat ante vehicula quis.\n" "Praesent cursus ultrices justo, ut feugiat ante vehicula quis.\n"
"Donec fringilla scelerisque mauris et viverra.\n" "Donec fringilla scelerisque mauris et viverra.\n"
@ -87,27 +87,27 @@ public :
"Mauris ultricies dolor sed massa convallis sed aliquet augue fringilla.\n" "Mauris ultricies dolor sed massa convallis sed aliquet augue fringilla.\n"
"Duis erat eros, porta in accumsan in, blandit quis sem.\n" "Duis erat eros, porta in accumsan in, blandit quis sem.\n"
"In hac habitasse platea dictumst. Etiam fringilla est id odio dapibus sit amet semper dui laoreet.\n"); "In hac habitasse platea dictumst. Etiam fringilla est id odio dapibus sit amet semper dui laoreet.\n");
m_text.SetCharacterSize(22); m_text.setCharacterSize(22);
m_text.SetPosition(30, 20); m_text.setPosition(30, 20);
// Load the shader // Load the shader
if (!m_shader.LoadFromFile("resources/wave.vert", "resources/blur.frag")) if (!m_shader.loadFromFile("resources/wave.vert", "resources/blur.frag"))
return false; return false;
return true; return true;
} }
void OnUpdate(float time, float x, float y) void onUpdate(float time, float x, float y)
{ {
m_shader.SetParameter("wave_phase", time); m_shader.setParameter("wave_phase", time);
m_shader.SetParameter("wave_amplitude", x * 40, y * 40); m_shader.setParameter("wave_amplitude", x * 40, y * 40);
m_shader.SetParameter("blur_radius", (x + y) * 0.008f); m_shader.setParameter("blur_radius", (x + y) * 0.008f);
} }
void OnDraw(sf::RenderTarget& target, sf::RenderStates states) const void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
{ {
states.Shader = &m_shader; states.shader = &m_shader;
target.Draw(m_text, states); target.draw(m_text, states);
} }
private: private:
@ -129,10 +129,10 @@ public :
{ {
} }
bool OnLoad() bool onLoad()
{ {
// Create the points // Create the points
m_points.SetPrimitiveType(sf::Points); m_points.setPrimitiveType(sf::Points);
for (int i = 0; i < 40000; ++i) for (int i = 0; i < 40000; ++i)
{ {
float x = static_cast<float>(std::rand() % 800); float x = static_cast<float>(std::rand() % 800);
@ -140,29 +140,29 @@ public :
sf::Uint8 r = std::rand() % 255; sf::Uint8 r = std::rand() % 255;
sf::Uint8 g = std::rand() % 255; sf::Uint8 g = std::rand() % 255;
sf::Uint8 b = std::rand() % 255; sf::Uint8 b = std::rand() % 255;
m_points.Append(sf::Vertex(sf::Vector2f(x, y), sf::Color(r, g, b))); m_points.append(sf::Vertex(sf::Vector2f(x, y), sf::Color(r, g, b)));
} }
// Load the shader // Load the shader
if (!m_shader.LoadFromFile("resources/storm.vert", "resources/blink.frag")) if (!m_shader.loadFromFile("resources/storm.vert", "resources/blink.frag"))
return false; return false;
return true; return true;
} }
void OnUpdate(float time, float x, float y) void onUpdate(float time, float x, float y)
{ {
float radius = 200 + std::cos(time) * 150; float radius = 200 + std::cos(time) * 150;
m_shader.SetParameter("storm_position", x * 800, y * 600); m_shader.setParameter("storm_position", x * 800, y * 600);
m_shader.SetParameter("storm_inner_radius", radius / 3); m_shader.setParameter("storm_inner_radius", radius / 3);
m_shader.SetParameter("storm_total_radius", radius); m_shader.setParameter("storm_total_radius", radius);
m_shader.SetParameter("blink_alpha", 0.5f + std::cos(time * 3) * 0.25f); m_shader.setParameter("blink_alpha", 0.5f + std::cos(time * 3) * 0.25f);
} }
void OnDraw(sf::RenderTarget& target, sf::RenderStates states) const void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
{ {
states.Shader = &m_shader; states.shader = &m_shader;
target.Draw(m_points, states); target.draw(m_points, states);
} }
private: private:
@ -184,24 +184,24 @@ public :
{ {
} }
bool OnLoad() bool onLoad()
{ {
// Create the off-screen surface // Create the off-screen surface
if (!m_surface.Create(800, 600)) if (!m_surface.create(800, 600))
return false; return false;
m_surface.SetSmooth(true); m_surface.setSmooth(true);
// Load the textures // Load the textures
if (!m_backgroundTexture.LoadFromFile("resources/sfml.png")) if (!m_backgroundTexture.loadFromFile("resources/sfml.png"))
return false; return false;
m_backgroundTexture.SetSmooth(true); m_backgroundTexture.setSmooth(true);
if (!m_entityTexture.LoadFromFile("resources/devices.png")) if (!m_entityTexture.loadFromFile("resources/devices.png"))
return false; return false;
m_entityTexture.SetSmooth(true); m_entityTexture.setSmooth(true);
// Initialize the background sprite // Initialize the background sprite
m_backgroundSprite.SetTexture(m_backgroundTexture); m_backgroundSprite.setTexture(m_backgroundTexture);
m_backgroundSprite.SetPosition(135, 100); m_backgroundSprite.setPosition(135, 100);
// Load the moving entities // Load the moving entities
for (int i = 0; i < 6; ++i) for (int i = 0; i < 6; ++i)
@ -211,37 +211,37 @@ public :
} }
// Load the shader // Load the shader
if (!m_shader.LoadFromFile("resources/edge.frag", sf::Shader::Fragment)) if (!m_shader.loadFromFile("resources/edge.frag", sf::Shader::Fragment))
return false; return false;
m_shader.SetParameter("texture", sf::Shader::CurrentTexture); m_shader.setParameter("texture", sf::Shader::CurrentTexture);
return true; return true;
} }
void OnUpdate(float time, float x, float y) void onUpdate(float time, float x, float y)
{ {
m_shader.SetParameter("edge_threshold", 1 - (x + y) / 2); m_shader.setParameter("edge_threshold", 1 - (x + y) / 2);
// Update the position of the moving entities // Update the position of the moving entities
for (std::size_t i = 0; i < m_entities.size(); ++i) for (std::size_t i = 0; i < m_entities.size(); ++i)
{ {
float x = std::cos(0.25f * (time * i + (m_entities.size() - i))) * 300 + 350; float x = std::cos(0.25f * (time * i + (m_entities.size() - i))) * 300 + 350;
float y = std::sin(0.25f * (time * (m_entities.size() - i) + i)) * 200 + 250; float y = std::sin(0.25f * (time * (m_entities.size() - i) + i)) * 200 + 250;
m_entities[i].SetPosition(x, y); m_entities[i].setPosition(x, y);
} }
// Render the updated scene to the off-screen surface // Render the updated scene to the off-screen surface
m_surface.Clear(sf::Color::White); m_surface.clear(sf::Color::White);
m_surface.Draw(m_backgroundSprite); m_surface.draw(m_backgroundSprite);
for (std::size_t i = 0; i < m_entities.size(); ++i) for (std::size_t i = 0; i < m_entities.size(); ++i)
m_surface.Draw(m_entities[i]); m_surface.draw(m_entities[i]);
m_surface.Display(); m_surface.display();
} }
void OnDraw(sf::RenderTarget& target, sf::RenderStates states) const void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
{ {
states.Shader = &m_shader; states.shader = &m_shader;
target.Draw(sf::Sprite(m_surface.GetTexture()), states); target.draw(sf::Sprite(m_surface.getTexture()), states);
} }
private: private:
@ -265,7 +265,7 @@ int main()
{ {
// Create the main window // Create the main window
sf::RenderWindow window(sf::VideoMode(800, 600), "SFML Shader"); sf::RenderWindow window(sf::VideoMode(800, 600), "SFML Shader");
window.SetVerticalSyncEnabled(true); window.setVerticalSyncEnabled(true);
// Create the effects // Create the effects
std::vector<Effect*> effects; std::vector<Effect*> effects;
@ -277,50 +277,50 @@ int main()
// Initialize them // Initialize them
for (std::size_t i = 0; i < effects.size(); ++i) for (std::size_t i = 0; i < effects.size(); ++i)
effects[i]->Load(); effects[i]->load();
// Create the messages background // Create the messages background
sf::Texture textBackgroundTexture; sf::Texture textBackgroundTexture;
if (!textBackgroundTexture.LoadFromFile("resources/text-background.png")) if (!textBackgroundTexture.loadFromFile("resources/text-background.png"))
return EXIT_FAILURE; return EXIT_FAILURE;
sf::Sprite textBackground(textBackgroundTexture); sf::Sprite textBackground(textBackgroundTexture);
textBackground.SetPosition(0, 520); textBackground.setPosition(0, 520);
textBackground.SetColor(sf::Color(255, 255, 255, 200)); textBackground.setColor(sf::Color(255, 255, 255, 200));
// Load the messages font // Load the messages font
sf::Font font; sf::Font font;
if (!font.LoadFromFile("resources/sansation.ttf")) if (!font.loadFromFile("resources/sansation.ttf"))
return EXIT_FAILURE; return EXIT_FAILURE;
// Create the description text // Create the description text
sf::Text description("Current effect: " + effects[current]->GetName(), font, 20); sf::Text description("Current effect: " + effects[current]->getName(), font, 20);
description.SetPosition(10, 530); description.setPosition(10, 530);
description.SetColor(sf::Color(80, 80, 80)); description.setColor(sf::Color(80, 80, 80));
// Create the instructions text // Create the instructions text
sf::Text instructions("Press left and right arrows to change the current shader", font, 20); sf::Text instructions("Press left and right arrows to change the current shader", font, 20);
instructions.SetPosition(280, 555); instructions.setPosition(280, 555);
instructions.SetColor(sf::Color(80, 80, 80)); instructions.setColor(sf::Color(80, 80, 80));
// Start the game loop // Start the game loop
sf::Clock clock; sf::Clock clock;
while (window.IsOpen()) while (window.isOpen())
{ {
// Process events // Process events
sf::Event event; sf::Event event;
while (window.PollEvent(event)) while (window.pollEvent(event))
{ {
// Close window: exit // Close window: exit
if (event.Type == sf::Event::Closed) if (event.type == sf::Event::Closed)
window.Close(); window.close();
if (event.Type == sf::Event::KeyPressed) if (event.type == sf::Event::KeyPressed)
{ {
switch (event.Key.Code) switch (event.key.code)
{ {
// Escape key: exit // Escape key: exit
case sf::Keyboard::Escape: case sf::Keyboard::Escape:
window.Close(); window.close();
break; break;
// Left arrow key: previous shader // Left arrow key: previous shader
@ -329,7 +329,7 @@ int main()
current = effects.size() - 1; current = effects.size() - 1;
else else
current--; current--;
description.SetString("Current effect: " + effects[current]->GetName()); description.setString("Current effect: " + effects[current]->getName());
break; break;
// Right arrow key: next shader // Right arrow key: next shader
@ -338,7 +338,7 @@ int main()
current = 0; current = 0;
else else
current++; current++;
description.SetString("Current effect: " + effects[current]->GetName()); description.setString("Current effect: " + effects[current]->getName());
break; break;
default: default:
@ -348,23 +348,23 @@ int main()
} }
// Update the current example // Update the current example
float x = static_cast<float>(sf::Mouse::GetPosition(window).x) / window.GetSize().x; float x = static_cast<float>(sf::Mouse::getPosition(window).x) / window.getSize().x;
float y = static_cast<float>(sf::Mouse::GetPosition(window).y) / window.GetSize().y; float y = static_cast<float>(sf::Mouse::getPosition(window).y) / window.getSize().y;
effects[current]->Update(clock.GetElapsedTime().AsSeconds(), x, y); effects[current]->update(clock.getElapsedTime().asSeconds(), x, y);
// Clear the window // Clear the window
window.Clear(sf::Color(255, 128, 0)); window.clear(sf::Color(255, 128, 0));
// Draw the current example // Draw the current example
window.Draw(*effects[current]); window.draw(*effects[current]);
// Draw the text // Draw the text
window.Draw(textBackground); window.draw(textBackground);
window.Draw(instructions); window.draw(instructions);
window.Draw(description); window.draw(description);
// Finally, display the rendered frame on screen // Finally, display the rendered frame on screen
window.Display(); window.display();
} }
// delete the effects // delete the effects

16
examples/sockets/Sockets.cpp
View file

@ -6,10 +6,10 @@
#include <cstdlib> #include <cstdlib>
void RunTcpServer(unsigned short Port); void runTcpServer(unsigned short port);
void RunTcpClient(unsigned short Port); void runTcpClient(unsigned short port);
void RunUdpServer(unsigned short Port); void runUdpServer(unsigned short port);
void RunUdpClient(unsigned short Port); void runUdpClient(unsigned short port);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -37,17 +37,17 @@ int main()
{ {
// Test the TCP protocol // Test the TCP protocol
if (who == 's') if (who == 's')
RunTcpServer(port); runTcpServer(port);
else else
RunTcpClient(port); runTcpClient(port);
} }
else else
{ {
// Test the unconnected UDP protocol // Test the unconnected UDP protocol
if (who == 's') if (who == 's')
RunUdpServer(port); runUdpServer(port);
else else
RunUdpClient(port); runUdpClient(port);
} }
// Wait until the user presses 'enter' key // Wait until the user presses 'enter' key

20
examples/sockets/TCP.cpp
View file

@ -11,32 +11,32 @@
/// send a message and wait for the answer. /// send a message and wait for the answer.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void RunTcpServer(unsigned short port) void runTcpServer(unsigned short port)
{ {
// Create a server socket to accept new connections // Create a server socket to accept new connections
sf::TcpListener listener; sf::TcpListener listener;
// Listen to the given port for incoming connections // Listen to the given port for incoming connections
if (listener.Listen(port) != sf::Socket::Done) if (listener.listen(port) != sf::Socket::Done)
return; return;
std::cout << "Server is listening to port " << port << ", waiting for connections... " << std::endl; std::cout << "Server is listening to port " << port << ", waiting for connections... " << std::endl;
// Wait for a connection // Wait for a connection
sf::TcpSocket socket; sf::TcpSocket socket;
if (listener.Accept(socket) != sf::Socket::Done) if (listener.accept(socket) != sf::Socket::Done)
return; return;
std::cout << "Client connected: " << socket.GetRemoteAddress() << std::endl; std::cout << "Client connected: " << socket.getRemoteAddress() << std::endl;
// Send a message to the connected client // Send a message to the connected client
const char out[] = "Hi, I'm the server"; const char out[] = "Hi, I'm the server";
if (socket.Send(out, sizeof(out)) != sf::Socket::Done) if (socket.send(out, sizeof(out)) != sf::Socket::Done)
return; return;
std::cout << "Message sent to the client: \"" << out << "\"" << std::endl; std::cout << "Message sent to the client: \"" << out << "\"" << std::endl;
// Receive a message back from the client // Receive a message back from the client
char in[128]; char in[128];
std::size_t received; std::size_t received;
if (socket.Receive(in, sizeof(in), received) != sf::Socket::Done) if (socket.receive(in, sizeof(in), received) != sf::Socket::Done)
return; return;
std::cout << "Answer received from the client: \"" << in << "\"" << std::endl; std::cout << "Answer received from the client: \"" << in << "\"" << std::endl;
} }
@ -47,7 +47,7 @@ void RunTcpServer(unsigned short port)
/// welcome message and send an answer. /// welcome message and send an answer.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void RunTcpClient(unsigned short port) void runTcpClient(unsigned short port)
{ {
// Ask for the server address // Ask for the server address
sf::IpAddress server; sf::IpAddress server;
@ -62,20 +62,20 @@ void RunTcpClient(unsigned short port)
sf::TcpSocket socket; sf::TcpSocket socket;
// Connect to the server // Connect to the server
if (socket.Connect(server, port) != sf::Socket::Done) if (socket.connect(server, port) != sf::Socket::Done)
return; return;
std::cout << "Connected to server " << server << std::endl; std::cout << "Connected to server " << server << std::endl;
// Receive a message from the server // Receive a message from the server
char in[128]; char in[128];
std::size_t received; std::size_t received;
if (socket.Receive(in, sizeof(in), received) != sf::Socket::Done) if (socket.receive(in, sizeof(in), received) != sf::Socket::Done)
return; return;
std::cout << "Message received from the server: \"" << in << "\"" << std::endl; std::cout << "Message received from the server: \"" << in << "\"" << std::endl;
// Send an answer to the server // Send an answer to the server
const char out[] = "Hi, I'm a client"; const char out[] = "Hi, I'm a client";
if (socket.Send(out, sizeof(out)) != sf::Socket::Done) if (socket.send(out, sizeof(out)) != sf::Socket::Done)
return; return;
std::cout << "Message sent to the server: \"" << out << "\"" << std::endl; std::cout << "Message sent to the server: \"" << out << "\"" << std::endl;
} }

14
examples/sockets/UDP.cpp
View file

@ -10,13 +10,13 @@
/// Launch a server, wait for a message, send an answer. /// Launch a server, wait for a message, send an answer.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void RunUdpServer(unsigned short port) void runUdpServer(unsigned short port)
{ {
// Create a socket to receive a message from anyone // Create a socket to receive a message from anyone
sf::UdpSocket socket; sf::UdpSocket socket;
// Listen to messages on the specified port // Listen to messages on the specified port
if (socket.Bind(port) != sf::Socket::Done) if (socket.bind(port) != sf::Socket::Done)
return; return;
std::cout << "Server is listening to port " << port << ", waiting for a message... " << std::endl; std::cout << "Server is listening to port " << port << ", waiting for a message... " << std::endl;
@ -25,13 +25,13 @@ void RunUdpServer(unsigned short port)
std::size_t received; std::size_t received;
sf::IpAddress sender; sf::IpAddress sender;
unsigned short senderPort; unsigned short senderPort;
if (socket.Receive(in, sizeof(in), received, sender, senderPort) != sf::Socket::Done) if (socket.receive(in, sizeof(in), received, sender, senderPort) != sf::Socket::Done)
return; return;
std::cout << "Message received from client " << sender << ": \"" << in << "\"" << std::endl; std::cout << "Message received from client " << sender << ": \"" << in << "\"" << std::endl;
// Send an answer to the client // Send an answer to the client
const char out[] = "Hi, I'm the server"; const char out[] = "Hi, I'm the server";
if (socket.Send(out, sizeof(out), sender, senderPort) != sf::Socket::Done) if (socket.send(out, sizeof(out), sender, senderPort) != sf::Socket::Done)
return; return;
std::cout << "Message sent to the client: \"" << out << "\"" << std::endl; std::cout << "Message sent to the client: \"" << out << "\"" << std::endl;
} }
@ -41,7 +41,7 @@ void RunUdpServer(unsigned short port)
/// Send a message to the server, wait for the answer /// Send a message to the server, wait for the answer
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void RunUdpClient(unsigned short port) void runUdpClient(unsigned short port)
{ {
// Ask for the server address // Ask for the server address
sf::IpAddress server; sf::IpAddress server;
@ -57,7 +57,7 @@ void RunUdpClient(unsigned short port)
// Send a message to the server // Send a message to the server
const char out[] = "Hi, I'm a client"; const char out[] = "Hi, I'm a client";
if (socket.Send(out, sizeof(out), server, port) != sf::Socket::Done) if (socket.send(out, sizeof(out), server, port) != sf::Socket::Done)
return; return;
std::cout << "Message sent to the server: \"" << out << "\"" << std::endl; std::cout << "Message sent to the server: \"" << out << "\"" << std::endl;
@ -66,7 +66,7 @@ void RunUdpClient(unsigned short port)
std::size_t received; std::size_t received;
sf::IpAddress sender; sf::IpAddress sender;
unsigned short senderPort; unsigned short senderPort;
if (socket.Receive(in, sizeof(in), received, sender, senderPort) != sf::Socket::Done) if (socket.receive(in, sizeof(in), received, sender, senderPort) != sf::Socket::Done)
return; return;
std::cout << "Message received from " << sender << ": \"" << in << "\"" << std::endl; std::cout << "Message received from " << sender << ": \"" << in << "\"" << std::endl;
} }

40
examples/sound/Sound.cpp
View file

@ -11,31 +11,31 @@
/// Play a sound /// Play a sound
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void PlaySound() void playSound()
{ {
// Load a sound buffer from a wav file // Load a sound buffer from a wav file
sf::SoundBuffer buffer; sf::SoundBuffer buffer;
if (!buffer.LoadFromFile("resources/canary.wav")) if (!buffer.loadFromFile("resources/canary.wav"))
return; return;
// Display sound informations // Display sound informations
std::cout << "canary.wav :" << std::endl; std::cout << "canary.wav :" << std::endl;
std::cout << " " << buffer.GetDuration().AsSeconds() << " seconds" << std::endl; std::cout << " " << buffer.getDuration().asSeconds() << " seconds" << std::endl;
std::cout << " " << buffer.GetSampleRate() << " samples / sec" << std::endl; std::cout << " " << buffer.getSampleRate() << " samples / sec" << std::endl;
std::cout << " " << buffer.GetChannelCount() << " channels" << std::endl; std::cout << " " << buffer.getChannelCount() << " channels" << std::endl;
// Create a sound instance and play it // Create a sound instance and play it
sf::Sound sound(buffer); sf::Sound sound(buffer);
sound.Play(); sound.play();
// Loop while the sound is playing // Loop while the sound is playing
while (sound.GetStatus() == sf::Sound::Playing) while (sound.getStatus() == sf::Sound::Playing)
{ {
// Leave some CPU time for other processes // Leave some CPU time for other processes
sf::Sleep(sf::Milliseconds(100)); sf::sleep(sf::milliseconds(100));
// Display the playing position // Display the playing position
std::cout << "\rPlaying... " << std::fixed << std::setprecision(2) << sound.GetPlayingOffset().AsSeconds() << " sec "; std::cout << "\rPlaying... " << std::fixed << std::setprecision(2) << sound.getPlayingOffset().asSeconds() << " sec ";
std::cout << std::flush; std::cout << std::flush;
} }
std::cout << std::endl << std::endl; std::cout << std::endl << std::endl;
@ -46,30 +46,30 @@ void PlaySound()
/// Play a music /// Play a music
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void PlayMusic() void playMusic()
{ {
// Load an ogg music file // Load an ogg music file
sf::Music music; sf::Music music;
if (!music.OpenFromFile("resources/orchestral.ogg")) if (!music.openFromFile("resources/orchestral.ogg"))
return; return;
// Display music informations // Display music informations
std::cout << "orchestral.ogg :" << std::endl; std::cout << "orchestral.ogg :" << std::endl;
std::cout << " " << music.GetDuration().AsSeconds() << " seconds" << std::endl; std::cout << " " << music.getDuration().asSeconds() << " seconds" << std::endl;
std::cout << " " << music.GetSampleRate() << " samples / sec" << std::endl; std::cout << " " << music.getSampleRate() << " samples / sec" << std::endl;
std::cout << " " << music.GetChannelCount() << " channels" << std::endl; std::cout << " " << music.getChannelCount() << " channels" << std::endl;
// Play it // Play it
music.Play(); music.play();
// Loop while the music is playing // Loop while the music is playing
while (music.GetStatus() == sf::Music::Playing) while (music.getStatus() == sf::Music::Playing)
{ {
// Leave some CPU time for other processes // Leave some CPU time for other processes
sf::Sleep(sf::Milliseconds(100)); sf::sleep(sf::milliseconds(100));
// Display the playing position // Display the playing position
std::cout << "\rPlaying... " << std::fixed << std::setprecision(2) << music.GetPlayingOffset().AsSeconds() << " sec "; std::cout << "\rPlaying... " << std::fixed << std::setprecision(2) << music.getPlayingOffset().asSeconds() << " sec ";
std::cout << std::flush; std::cout << std::flush;
} }
std::cout << std::endl; std::cout << std::endl;
@ -85,10 +85,10 @@ void PlayMusic()
int main() int main()
{ {
// Play a sound // Play a sound
PlaySound(); playSound();
// Play a music // Play a music
PlayMusic(); playMusic();
// Wait until the user presses 'enter' key // Wait until the user presses 'enter' key
std::cout << "Press enter to exit..." << std::endl; std::cout << "Press enter to exit..." << std::endl;

24
examples/sound_capture/SoundCapture.cpp
View file

@ -16,7 +16,7 @@
int main() int main()
{ {
// Check that the device can capture audio // Check that the device can capture audio
if (sf::SoundRecorder::IsAvailable() == false) if (sf::SoundRecorder::isAvailable() == false)
{ {
std::cout << "Sorry, audio capture is not supported by your system" << std::endl; std::cout << "Sorry, audio capture is not supported by your system" << std::endl;
return EXIT_SUCCESS; return EXIT_SUCCESS;
@ -36,19 +36,19 @@ int main()
sf::SoundBufferRecorder recorder; sf::SoundBufferRecorder recorder;
// Audio capture is done in a separate thread, so we can block the main thread while it is capturing // Audio capture is done in a separate thread, so we can block the main thread while it is capturing
recorder.Start(sampleRate); recorder.start(sampleRate);
std::cout << "Recording... press enter to stop"; std::cout << "Recording... press enter to stop";
std::cin.ignore(10000, '\n'); std::cin.ignore(10000, '\n');
recorder.Stop(); recorder.stop();
// Get the buffer containing the captured data // Get the buffer containing the captured data
const sf::SoundBuffer& buffer = recorder.GetBuffer(); const sf::SoundBuffer& buffer = recorder.getBuffer();
// Display captured sound informations // Display captured sound informations
std::cout << "Sound information :" << std::endl; std::cout << "Sound information :" << std::endl;
std::cout << " " << buffer.GetDuration().AsSeconds() << " seconds" << std::endl; std::cout << " " << buffer.getDuration().asSeconds() << " seconds" << std::endl;
std::cout << " " << buffer.GetSampleRate() << " samples / seconds" << std::endl; std::cout << " " << buffer.getSampleRate() << " samples / seconds" << std::endl;
std::cout << " " << buffer.GetChannelCount() << " channels" << std::endl; std::cout << " " << buffer.getChannelCount() << " channels" << std::endl;
// Choose what to do with the recorded sound data // Choose what to do with the recorded sound data
char choice; char choice;
@ -64,23 +64,23 @@ int main()
std::getline(std::cin, filename); std::getline(std::cin, filename);
// Save the buffer // Save the buffer
buffer.SaveToFile(filename); buffer.saveToFile(filename);
} }
else else
{ {
// Create a sound instance and play it // Create a sound instance and play it
sf::Sound sound(buffer); sf::Sound sound(buffer);
sound.Play(); sound.play();
// Wait until finished // Wait until finished
while (sound.GetStatus() == sf::Sound::Playing) while (sound.getStatus() == sf::Sound::Playing)
{ {
// Display the playing position // Display the playing position
std::cout << "\rPlaying... " << std::fixed << std::setprecision(2) << sound.GetPlayingOffset().AsSeconds() << " sec"; std::cout << "\rPlaying... " << std::fixed << std::setprecision(2) << sound.getPlayingOffset().asSeconds() << " sec";
std::cout << std::flush; std::cout << std::flush;
// Leave some CPU time for other threads // Leave some CPU time for other threads
sf::Sleep(sf::Milliseconds(100)); sf::sleep(sf::milliseconds(100));
} }
} }

24
examples/voip/Client.cpp
View file

@ -38,9 +38,9 @@ private :
/// /see SoundRecorder::OnStart /// /see SoundRecorder::OnStart
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnStart() virtual bool onStart()
{ {
if (m_socket.Connect(m_host, m_port) == sf::Socket::Done) if (m_socket.connect(m_host, m_port) == sf::Socket::Done)
{ {
std::cout << "Connected to server " << m_host << std::endl; std::cout << "Connected to server " << m_host << std::endl;
return true; return true;
@ -55,30 +55,30 @@ private :
/// /see SoundRecorder::ProcessSamples /// /see SoundRecorder::ProcessSamples
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnProcessSamples(const sf::Int16* samples, std::size_t sampleCount) virtual bool onProcessSamples(const sf::Int16* samples, std::size_t sampleCount)
{ {
// Pack the audio samples into a network packet // Pack the audio samples into a network packet
sf::Packet packet; sf::Packet packet;
packet << audioData; packet << audioData;
packet.Append(samples, sampleCount * sizeof(sf::Int16)); packet.append(samples, sampleCount * sizeof(sf::Int16));
// Send the audio packet to the server // Send the audio packet to the server
return m_socket.Send(packet) == sf::Socket::Done; return m_socket.send(packet) == sf::Socket::Done;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// /see SoundRecorder::OnStop /// /see SoundRecorder::OnStop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnStop() virtual void onStop()
{ {
// Send a "end-of-stream" packet // Send a "end-of-stream" packet
sf::Packet packet; sf::Packet packet;
packet << endOfStream; packet << endOfStream;
m_socket.Send(packet); m_socket.send(packet);
// Close the socket // Close the socket
m_socket.Disconnect(); m_socket.disconnect();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -95,10 +95,10 @@ private :
/// start sending him audio data /// start sending him audio data
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void DoClient(unsigned short port) void doClient(unsigned short port)
{ {
// Check that the device can capture audio // Check that the device can capture audio
if (sf::SoundRecorder::IsAvailable() == false) if (sf::SoundRecorder::isAvailable() == false)
{ {
std::cout << "Sorry, audio capture is not supported by your system" << std::endl; std::cout << "Sorry, audio capture is not supported by your system" << std::endl;
return; return;
@ -122,8 +122,8 @@ void DoClient(unsigned short port)
std::cin.ignore(10000, '\n'); std::cin.ignore(10000, '\n');
// Start capturing audio data // Start capturing audio data
recorder.Start(44100); recorder.start(44100);
std::cout << "Recording... press enter to stop"; std::cout << "Recording... press enter to stop";
std::cin.ignore(10000, '\n'); std::cin.ignore(10000, '\n');
recorder.Stop(); recorder.stop();
} }

50
examples/voip/Server.cpp
View file

@ -30,37 +30,37 @@ public :
m_hasFinished(false) m_hasFinished(false)
{ {
// Set the sound parameters // Set the sound parameters
Initialize(1, 44100); initialize(1, 44100);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// Run the server, stream audio data from the client /// Run the server, stream audio data from the client
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Start(unsigned short port) void start(unsigned short port)
{ {
if (!m_hasFinished) if (!m_hasFinished)
{ {
// Listen to the given port for incoming connections // Listen to the given port for incoming connections
if (m_listener.Listen(port) != sf::Socket::Done) if (m_listener.listen(port) != sf::Socket::Done)
return; return;
std::cout << "Server is listening to port " << port << ", waiting for connections... " << std::endl; std::cout << "Server is listening to port " << port << ", waiting for connections... " << std::endl;
// Wait for a connection // Wait for a connection
if (m_listener.Accept(m_client) != sf::Socket::Done) if (m_listener.accept(m_client) != sf::Socket::Done)
return; return;
std::cout << "Client connected: " << m_client.GetRemoteAddress() << std::endl; std::cout << "Client connected: " << m_client.getRemoteAddress() << std::endl;
// Start playback // Start playback
Play(); play();
// Start receiving audio data // Start receiving audio data
ReceiveLoop(); receiveLoop();
} }
else else
{ {
// Start playback // Start playback
Play(); play();
} }
} }
@ -70,7 +70,7 @@ private :
/// /see SoundStream::OnGetData /// /see SoundStream::OnGetData
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnGetData(sf::SoundStream::Chunk& data) virtual bool onGetData(sf::SoundStream::Chunk& data)
{ {
// We have reached the end of the buffer and all audio data have been played : we can stop playback // We have reached the end of the buffer and all audio data have been played : we can stop playback
if ((m_offset >= m_samples.size()) && m_hasFinished) if ((m_offset >= m_samples.size()) && m_hasFinished)
@ -78,7 +78,7 @@ private :
// No new data has arrived since last update : wait until we get some // No new data has arrived since last update : wait until we get some
while ((m_offset >= m_samples.size()) && !m_hasFinished) while ((m_offset >= m_samples.size()) && !m_hasFinished)
sf::Sleep(sf::Milliseconds(10)); sf::sleep(sf::milliseconds(10));
// Copy samples into a local buffer to avoid synchronization problems // Copy samples into a local buffer to avoid synchronization problems
// (don't forget that we run in two separate threads) // (don't forget that we run in two separate threads)
@ -88,8 +88,8 @@ private :
} }
// Fill audio data to pass to the stream // Fill audio data to pass to the stream
data.Samples = &m_tempBuffer[0]; data.samples = &m_tempBuffer[0];
data.SampleCount = m_tempBuffer.size(); data.sampleCount = m_tempBuffer.size();
// Update the playing offset // Update the playing offset
m_offset += m_tempBuffer.size(); m_offset += m_tempBuffer.size();
@ -101,22 +101,22 @@ private :
/// /see SoundStream::OnSeek /// /see SoundStream::OnSeek
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnSeek(sf::Time timeOffset) virtual void onSeek(sf::Time timeOffset)
{ {
m_offset = timeOffset.AsMilliseconds() * GetSampleRate() * GetChannelCount() / 1000; m_offset = timeOffset.asMilliseconds() * getSampleRate() * getChannelCount() / 1000;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// Get audio data from the client until playback is stopped /// Get audio data from the client until playback is stopped
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ReceiveLoop() void receiveLoop()
{ {
while (!m_hasFinished) while (!m_hasFinished)
{ {
// Get waiting audio data from the network // Get waiting audio data from the network
sf::Packet packet; sf::Packet packet;
if (m_client.Receive(packet) != sf::Socket::Done) if (m_client.receive(packet) != sf::Socket::Done)
break; break;
// Extract the message ID // Extract the message ID
@ -126,8 +126,8 @@ private :
if (id == audioData) if (id == audioData)
{ {
// Extract audio samples from the packet, and append it to our samples buffer // Extract audio samples from the packet, and append it to our samples buffer
const sf::Int16* samples = reinterpret_cast<const sf::Int16*>(packet.GetData() + 1); const sf::Int16* samples = reinterpret_cast<const sf::Int16*>(packet.getData() + 1);
std::size_t sampleCount = (packet.GetDataSize() - 1) / sizeof(sf::Int16); std::size_t sampleCount = (packet.getDataSize() - 1) / sizeof(sf::Int16);
// Don't forget that the other thread can access the sample array at any time // Don't forget that the other thread can access the sample array at any time
// (so we protect any operation on it with the mutex) // (so we protect any operation on it with the mutex)
@ -169,17 +169,17 @@ private :
/// a connected client /// a connected client
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void DoServer(unsigned short port) void doServer(unsigned short port)
{ {
// Build an audio stream to play sound data as it is received through the network // Build an audio stream to play sound data as it is received through the network
NetworkAudioStream audioStream; NetworkAudioStream audioStream;
audioStream.Start(port); audioStream.start(port);
// Loop until the sound playback is finished // Loop until the sound playback is finished
while (audioStream.GetStatus() != sf::SoundStream::Stopped) while (audioStream.getStatus() != sf::SoundStream::Stopped)
{ {
// Leave some CPU time for other threads // Leave some CPU time for other threads
sf::Sleep(sf::Milliseconds(100)); sf::sleep(sf::milliseconds(100));
} }
std::cin.ignore(10000, '\n'); std::cin.ignore(10000, '\n');
@ -189,12 +189,12 @@ void DoServer(unsigned short port)
std::cin.ignore(10000, '\n'); std::cin.ignore(10000, '\n');
// Replay the sound (just to make sure replaying the received data is OK) // Replay the sound (just to make sure replaying the received data is OK)
audioStream.Play(); audioStream.play();
// Loop until the sound playback is finished // Loop until the sound playback is finished
while (audioStream.GetStatus() != sf::SoundStream::Stopped) while (audioStream.getStatus() != sf::SoundStream::Stopped)
{ {
// Leave some CPU time for other threads // Leave some CPU time for other threads
sf::Sleep(sf::Milliseconds(100)); sf::sleep(sf::milliseconds(100));
} }
} }

8
examples/voip/VoIP.cpp
View file

@ -11,8 +11,8 @@
// Function prototypes // Function prototypes
// (I'm too lazy to put them into separate headers...) // (I'm too lazy to put them into separate headers...)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void DoClient(unsigned short port); void doClient(unsigned short port);
void DoServer(unsigned short port); void doServer(unsigned short port);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -34,12 +34,12 @@ int main()
if (who == 's') if (who == 's')
{ {
// Run as a server // Run as a server
DoServer(port); doServer(port);
} }
else else
{ {
// Run as a client // Run as a client
DoClient(port); doClient(port);
} }
// Wait until the user presses 'enter' key // Wait until the user presses 'enter' key

28
examples/win32/Win32.cpp
View file

@ -13,7 +13,7 @@ HWND button;
/// Function called whenever one of our windows receives a message /// Function called whenever one of our windows receives a message
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
LRESULT CALLBACK OnEvent(HWND handle, UINT message, WPARAM wParam, LPARAM lParam) LRESULT CALLBACK onEvent(HWND handle, UINT message, WPARAM wParam, LPARAM lParam)
{ {
switch (message) switch (message)
{ {
@ -52,7 +52,7 @@ INT WINAPI WinMain(HINSTANCE instance, HINSTANCE, LPSTR, INT)
// Define a class for our main window // Define a class for our main window
WNDCLASS windowClass; WNDCLASS windowClass;
windowClass.style = 0; windowClass.style = 0;
windowClass.lpfnWndProc = &OnEvent; windowClass.lpfnWndProc = &onEvent;
windowClass.cbClsExtra = 0; windowClass.cbClsExtra = 0;
windowClass.cbWndExtra = 0; windowClass.cbWndExtra = 0;
windowClass.hInstance = instance; windowClass.hInstance = instance;
@ -77,12 +77,12 @@ INT WINAPI WinMain(HINSTANCE instance, HINSTANCE, LPSTR, INT)
// Load some textures to display // Load some textures to display
sf::Texture texture1, texture2; sf::Texture texture1, texture2;
if (!texture1.LoadFromFile("resources/image1.jpg") || !texture2.LoadFromFile("resources/image2.jpg")) if (!texture1.loadFromFile("resources/image1.jpg") || !texture2.loadFromFile("resources/image2.jpg"))
return EXIT_FAILURE; return EXIT_FAILURE;
sf::Sprite sprite1(texture1); sf::Sprite sprite1(texture1);
sf::Sprite sprite2(texture2); sf::Sprite sprite2(texture2);
sprite1.SetOrigin(texture1.GetWidth() / 2.f, texture1.GetHeight() / 2.f); sprite1.setOrigin(texture1.getWidth() / 2.f, texture1.getHeight() / 2.f);
sprite1.SetPosition(sprite1.GetOrigin()); sprite1.setPosition(sprite1.getOrigin());
// Create a clock for measuring elapsed time // Create a clock for measuring elapsed time
sf::Clock clock; sf::Clock clock;
@ -100,23 +100,23 @@ INT WINAPI WinMain(HINSTANCE instance, HINSTANCE, LPSTR, INT)
} }
else else
{ {
float time = clock.GetElapsedTime().AsSeconds(); float time = clock.getElapsedTime().asSeconds();
// Clear views // Clear views
SFMLView1.Clear(); SFMLView1.clear();
SFMLView2.Clear(); SFMLView2.clear();
// Draw sprite 1 on view 1 // Draw sprite 1 on view 1
sprite1.SetRotation(time * 100); sprite1.setRotation(time * 100);
SFMLView1.Draw(sprite1); SFMLView1.draw(sprite1);
// Draw sprite 2 on view 2 // Draw sprite 2 on view 2
sprite2.SetPosition(std::cos(time) * 100.f, 0.f); sprite2.setPosition(std::cos(time) * 100.f, 0.f);
SFMLView2.Draw(sprite2); SFMLView2.draw(sprite2);
// Display each view on screen // Display each view on screen
SFMLView1.Display(); SFMLView1.display();
SFMLView2.Display(); SFMLView2.display();
} }
} }

26
examples/window/Window.cpp
View file

@ -34,29 +34,29 @@ int main()
gluPerspective(90.f, 1.f, 1.f, 500.f); gluPerspective(90.f, 1.f, 1.f, 500.f);
// Start the game loop // Start the game loop
while (window.IsOpen()) while (window.isOpen())
{ {
// Process events // Process events
sf::Event event; sf::Event event;
while (window.PollEvent(event)) while (window.pollEvent(event))
{ {
// Close window : exit // Close window : exit
if (event.Type == sf::Event::Closed) if (event.type == sf::Event::Closed)
window.Close(); window.close();
// Escape key : exit // Escape key : exit
if ((event.Type == sf::Event::KeyPressed) && (event.Key.Code == sf::Keyboard::Escape)) if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape))
window.Close(); window.close();
// Resize event : adjust viewport // Resize event : adjust viewport
if (event.Type == sf::Event::Resized) if (event.type == sf::Event::Resized)
glViewport(0, 0, event.Size.Width, event.Size.Height); glViewport(0, 0, event.size.width, event.size.height);
} }
// Activate the window before using OpenGL commands. // Activate the window before using OpenGL commands.
// This is useless here because we have only one window which is // This is useless here because we have only one window which is
// always the active one, but don't forget it if you use multiple windows // always the active one, but don't forget it if you use multiple windows
window.SetActive(); window.setActive();
// Clear color and depth buffer // Clear color and depth buffer
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
@ -65,9 +65,9 @@ int main()
glMatrixMode(GL_MODELVIEW); glMatrixMode(GL_MODELVIEW);
glLoadIdentity(); glLoadIdentity();
glTranslatef(0.f, 0.f, -200.f); glTranslatef(0.f, 0.f, -200.f);
glRotatef(clock.GetElapsedTime().AsSeconds() * 50, 1.f, 0.f, 0.f); glRotatef(clock.getElapsedTime().asSeconds() * 50, 1.f, 0.f, 0.f);
glRotatef(clock.GetElapsedTime().AsSeconds() * 30, 0.f, 1.f, 0.f); glRotatef(clock.getElapsedTime().asSeconds() * 30, 0.f, 1.f, 0.f);
glRotatef(clock.GetElapsedTime().AsSeconds() * 90, 0.f, 0.f, 1.f); glRotatef(clock.getElapsedTime().asSeconds() * 90, 0.f, 0.f, 1.f);
// Draw a cube // Draw a cube
glBegin(GL_QUADS); glBegin(GL_QUADS);
@ -111,7 +111,7 @@ int main()
glEnd(); glEnd();
// Finally, display the rendered frame on screen // Finally, display the rendered frame on screen
window.Display(); window.display();
} }
return EXIT_SUCCESS; return EXIT_SUCCESS;

34
include/SFML/Audio/Listener.hpp
View file

@ -52,20 +52,20 @@ public :
/// ///
/// \param volume New global volume, in the range [0, 100] /// \param volume New global volume, in the range [0, 100]
/// ///
/// \see GetGlobalVolume /// \see getGlobalVolume
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetGlobalVolume(float volume); static void setGlobalVolume(float volume);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current value of the global volume /// \brief Get the current value of the global volume
/// ///
/// \return Current global volume, in the range [0, 100] /// \return Current global volume, in the range [0, 100]
/// ///
/// \see SetGlobalVolume /// \see setGlobalVolume
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static float GetGlobalVolume(); static float getGlobalVolume();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the position of the listener in the scene /// \brief Set the position of the listener in the scene
@ -76,10 +76,10 @@ public :
/// \param y Y coordinate of the listener's position /// \param y Y coordinate of the listener's position
/// \param z Z coordinate of the listener's position /// \param z Z coordinate of the listener's position
/// ///
/// \see GetPosition, SetDirection /// \see getPosition, setDirection
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetPosition(float x, float y, float z); static void setPosition(float x, float y, float z);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the position of the listener in the scene /// \brief Set the position of the listener in the scene
@ -88,20 +88,20 @@ public :
/// ///
/// \param position New listener's position /// \param position New listener's position
/// ///
/// \see GetPosition, SetDirection /// \see getPosition, setDirection
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetPosition(const Vector3f& position); static void setPosition(const Vector3f& position);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current position of the listener in the scene /// \brief Get the current position of the listener in the scene
/// ///
/// \return Listener's position /// \return Listener's position
/// ///
/// \see SetPosition /// \see setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static Vector3f GetPosition(); static Vector3f getPosition();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the orientation of the listener in the scene /// \brief Set the orientation of the listener in the scene
@ -115,10 +115,10 @@ public :
/// \param y Y coordinate of the listener's orientation /// \param y Y coordinate of the listener's orientation
/// \param z Z coordinate of the listener's orientation /// \param z Z coordinate of the listener's orientation
/// ///
/// \see GetDirection, SetPosition /// \see getDirection, setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetDirection(float x, float y, float z); static void setDirection(float x, float y, float z);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the orientation of the listener in the scene /// \brief Set the orientation of the listener in the scene
@ -130,20 +130,20 @@ public :
/// ///
/// \param direction New listener's orientation /// \param direction New listener's orientation
/// ///
/// \see GetDirection, SetPosition /// \see getDirection, setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetDirection(const Vector3f& direction); static void setDirection(const Vector3f& direction);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current orientation of the listener in the scene /// \brief Get the current orientation of the listener in the scene
/// ///
/// \return Listener's orientation /// \return Listener's orientation
/// ///
/// \see SetDirection /// \see setDirection
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static Vector3f GetDirection(); static Vector3f getDirection();
}; };
} // namespace sf } // namespace sf
@ -172,7 +172,7 @@ public :
/// Usage example: /// Usage example:
/// \code /// \code
/// // Move the listener to the position (1, 0, -5) /// // Move the listener to the position (1, 0, -5)
/// sf::Listener::SetPosition(1, 0, -5); /// sf::Listener::setPosition(1, 0, -5);
/// ///
/// // Make it face the right axis (1, 0, 0) /// // Make it face the right axis (1, 0, 0)
/// sf::Listener::SetDirection(1, 0, 0); /// sf::Listener::SetDirection(1, 0, 0);

40
include/SFML/Audio/Music.hpp
View file

@ -68,7 +68,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Open a music from an audio file /// \brief Open a music from an audio file
/// ///
/// This function doesn't start playing the music (call Play() /// This function doesn't start playing the music (call play()
/// to do so). /// to do so).
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam,
@ -78,15 +78,15 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see OpenFromMemory, OpenFromStream /// \see openFromMemory, openFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenFromFile(const std::string& filename); bool openFromFile(const std::string& filename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Open a music from an audio file in memory /// \brief Open a music from an audio file in memory
/// ///
/// This function doesn't start playing the music (call Play() /// This function doesn't start playing the music (call play()
/// to do so). /// to do so).
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam,
@ -97,15 +97,15 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see OpenFromFile, OpenFromStream /// \see openFromFile, openFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenFromMemory(const void* data, std::size_t sizeInBytes); bool openFromMemory(const void* data, std::size_t sizeInBytes);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Open a music from an audio file in a custom stream /// \brief Open a music from an audio file in a custom stream
/// ///
/// This function doesn't start playing the music (call Play() /// This function doesn't start playing the music (call play()
/// to do so). /// to do so).
/// Here is a complete list of all the supported audio formats: /// Here is a complete list of all the supported audio formats:
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, /// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam,
@ -115,10 +115,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see OpenFromFile, OpenFromMemory /// \see openFromFile, openFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenFromStream(InputStream& stream); bool openFromStream(InputStream& stream);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the total duration of the music /// \brief Get the total duration of the music
@ -126,7 +126,7 @@ public :
/// \return Music duration /// \return Music duration
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time GetDuration() const; Time getDuration() const;
protected : protected :
@ -141,7 +141,7 @@ protected :
/// \return True to continue playback, false to stop /// \return True to continue playback, false to stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnGetData(Chunk& data); virtual bool onGetData(Chunk& data);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current playing position in the stream source /// \brief Change the current playing position in the stream source
@ -149,7 +149,7 @@ protected :
/// \param timeOffset New playing position, from the beginning of the music /// \param timeOffset New playing position, from the beginning of the music
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnSeek(Time timeOffset); virtual void onSeek(Time timeOffset);
private : private :
@ -157,7 +157,7 @@ private :
/// \brief Initialize the internal state after loading a new music /// \brief Initialize the internal state after loading a new music
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Initialize(); void initialize();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -191,7 +191,7 @@ private :
/// ///
/// As a sound stream, a music is played in its own thread in order /// As a sound stream, a music is played in its own thread in order
/// not to block the rest of the program. This means that you can /// not to block the rest of the program. This means that you can
/// leave the music alone after calling Play(), it will manage itself /// leave the music alone after calling play(), it will manage itself
/// very well. /// very well.
/// ///
/// Usage example: /// Usage example:
@ -200,19 +200,19 @@ private :
/// sf::Music music; /// sf::Music music;
/// ///
/// // Open it from an audio file /// // Open it from an audio file
/// if (!music.OpenFromFile("music.ogg")) /// if (!music.openFromFile("music.ogg"))
/// { /// {
/// // error... /// // error...
/// } /// }
/// ///
/// // Change some parameters /// // Change some parameters
/// music.SetPosition(0, 1, 10); // change its 3D position /// music.setPosition(0, 1, 10); // change its 3D position
/// music.SetPitch(2); // increase the pitch /// music.setPitch(2); // increase the pitch
/// music.SetVolume(50); // reduce the volume /// music.setVolume(50); // reduce the volume
/// music.SetLoop(true); // make it loop /// music.setLoop(true); // make it loop
/// ///
/// // Play it /// // Play it
/// music.Play(); /// music.play();
/// \endcode /// \endcode
/// ///
/// \see sf::Sound, sf::SoundStream /// \see sf::Sound, sf::SoundStream

42
include/SFML/Audio/Sound.hpp
View file

@ -86,7 +86,7 @@ public :
/// \see Pause, Stop /// \see Pause, Stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Play(); void play();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Pause the sound /// \brief Pause the sound
@ -97,19 +97,19 @@ public :
/// \see Play, Stop /// \see Play, Stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Pause(); void pause();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop playing the sound /// \brief Stop playing the sound
/// ///
/// This function stops the sound if it was playing or paused, /// This function stops the sound if it was playing or paused,
/// and does nothing if it was already stopped. /// and does nothing if it was already stopped.
/// It also resets the playing position (unlike Pause()). /// It also resets the playing position (unlike pause()).
/// ///
/// \see Play, Pause /// \see Play, Pause
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Stop(); void stop();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the source buffer containing the audio data to play /// \brief Set the source buffer containing the audio data to play
@ -123,22 +123,22 @@ public :
/// \see GetBuffer /// \see GetBuffer
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetBuffer(const SoundBuffer& buffer); void setBuffer(const SoundBuffer& buffer);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set whether or not the sound should loop after reaching the end /// \brief Set whether or not the sound should loop after reaching the end
/// ///
/// If set, the sound will restart from beginning after /// If set, the sound will restart from beginning after
/// reaching the end and so on, until it is stopped or /// reaching the end and so on, until it is stopped or
/// SetLoop(false) is called. /// setLoop(false) is called.
/// The default looping state for sound is false. /// The default looping state for sound is false.
/// ///
/// \param loop True to play in loop, false to play once /// \param loop True to play in loop, false to play once
/// ///
/// \see GetLoop /// \see getLoop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetLoop(bool loop); void setLoop(bool loop);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current playing position of the sound /// \brief Change the current playing position of the sound
@ -148,10 +148,10 @@ public :
/// ///
/// \param timeOffset New playing position, from the beginning of the sound /// \param timeOffset New playing position, from the beginning of the sound
/// ///
/// \see GetPlayingOffset /// \see getPlayingOffset
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPlayingOffset(Time timeOffset); void setPlayingOffset(Time timeOffset);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the audio buffer attached to the sound /// \brief Get the audio buffer attached to the sound
@ -159,27 +159,27 @@ public :
/// \return Sound buffer attached to the sound (can be NULL) /// \return Sound buffer attached to the sound (can be NULL)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const SoundBuffer* GetBuffer() const; const SoundBuffer* getBuffer() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether or not the sound is in loop mode /// \brief Tell whether or not the sound is in loop mode
/// ///
/// \return True if the sound is looping, false otherwise /// \return True if the sound is looping, false otherwise
/// ///
/// \see SetLoop /// \see setLoop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool GetLoop() const; bool getLoop() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current playing position of the sound /// \brief Get the current playing position of the sound
/// ///
/// \return Current playing position, from the beginning of the sound /// \return Current playing position, from the beginning of the sound
/// ///
/// \see SetPlayingOffset /// \see setPlayingOffset
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time GetPlayingOffset() const; Time getPlayingOffset() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current status of the sound (stopped, paused, playing) /// \brief Get the current status of the sound (stopped, paused, playing)
@ -187,7 +187,7 @@ public :
/// \return Current status of the sound /// \return Current status of the sound
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status GetStatus() const; Status getStatus() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Overload of assignment operator /// \brief Overload of assignment operator
@ -208,7 +208,7 @@ public :
/// the sound from using a dead buffer. /// the sound from using a dead buffer.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ResetBuffer(); void resetBuffer();
private : private :
@ -242,7 +242,7 @@ private :
/// ///
/// In order to work, a sound must be given a buffer of audio /// In order to work, a sound must be given a buffer of audio
/// data to play. Audio data (samples) is stored in sf::SoundBuffer, /// data to play. Audio data (samples) is stored in sf::SoundBuffer,
/// and attached to a sound with the SetBuffer() function. /// and attached to a sound with the setBuffer() function.
/// The buffer object attached to a sound must remain alive /// The buffer object attached to a sound must remain alive
/// as long as the sound uses it. Note that multiple sounds /// as long as the sound uses it. Note that multiple sounds
/// can use the same sound buffer at the same time. /// can use the same sound buffer at the same time.
@ -250,11 +250,11 @@ private :
/// Usage example: /// Usage example:
/// \code /// \code
/// sf::SoundBuffer buffer; /// sf::SoundBuffer buffer;
/// buffer.LoadFromFile("sound.wav"); /// buffer.loadFromFile("sound.wav");
/// ///
/// sf::Sound sound; /// sf::Sound sound;
/// sound.SetBuffer(buffer); /// sound.setBuffer(buffer);
/// sound.Play(); /// sound.play();
/// \endcode /// \endcode
/// ///
/// \see sf::SoundBuffer, sf::Music /// \see sf::SoundBuffer, sf::Music

66
include/SFML/Audio/SoundBuffer.hpp
View file

@ -84,10 +84,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromMemory, LoadFromStream, LoadFromSamples, SaveToFile /// \see loadFromMemory, loadFromStream, loadFromSamples, saveToFile
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromFile(const std::string& filename); bool loadFromFile(const std::string& filename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the sound buffer from a file in memory /// \brief Load the sound buffer from a file in memory
@ -101,10 +101,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromStream, LoadFromSamples /// \see loadFromFile, loadFromStream, loadFromSamples
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromMemory(const void* data, std::size_t sizeInBytes); bool loadFromMemory(const void* data, std::size_t sizeInBytes);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the sound buffer from a custom stream /// \brief Load the sound buffer from a custom stream
@ -117,10 +117,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromMemory, LoadFromSamples /// \see loadFromFile, loadFromMemory, loadFromSamples
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromStream(InputStream& stream); bool loadFromStream(InputStream& stream);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the sound buffer from an array of audio samples /// \brief Load the sound buffer from an array of audio samples
@ -135,10 +135,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromMemory, SaveToFile /// \see loadFromFile, loadFromMemory, saveToFile
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromSamples(const Int16* samples, std::size_t sampleCount, unsigned int channelCount, unsigned int sampleRate); bool loadFromSamples(const Int16* samples, std::size_t sampleCount, unsigned int channelCount, unsigned int sampleRate);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Save the sound buffer to an audio file /// \brief Save the sound buffer to an audio file
@ -151,37 +151,37 @@ public :
/// ///
/// \return True if saving succeeded, false if it failed /// \return True if saving succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromMemory, LoadFromSamples /// \see loadFromFile, loadFromMemory, loadFromSamples
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SaveToFile(const std::string& filename) const; bool saveToFile(const std::string& filename) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the array of audio samples stored in the buffer /// \brief Get the array of audio samples stored in the buffer
/// ///
/// The format of the returned samples is 16 bits signed integer /// The format of the returned samples is 16 bits signed integer
/// (sf::Int16). The total number of samples in this array /// (sf::Int16). The total number of samples in this array
/// is given by the GetSampleCount() function. /// is given by the getSampleCount() function.
/// ///
/// \return Read-only pointer to the array of sound samples /// \return Read-only pointer to the array of sound samples
/// ///
/// \see GetSampleCount /// \see getSampleCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Int16* GetSamples() const; const Int16* getSamples() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of samples stored in the buffer /// \brief Get the number of samples stored in the buffer
/// ///
/// The array of samples can be accessed with the GetSamples() /// The array of samples can be accessed with the getSamples()
/// function. /// function.
/// ///
/// \return Number of samples /// \return Number of samples
/// ///
/// \see GetSamples /// \see getSamples
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t GetSampleCount() const; std::size_t getSampleCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the sample rate of the sound /// \brief Get the sample rate of the sound
@ -192,10 +192,10 @@ public :
/// ///
/// \return Sample rate (number of samples per second) /// \return Sample rate (number of samples per second)
/// ///
/// \see GetChannelCount, GetDuration /// \see getChannelCount, getDuration
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetSampleRate() const; unsigned int getSampleRate() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of channels used by the sound /// \brief Get the number of channels used by the sound
@ -205,20 +205,20 @@ public :
/// ///
/// \return Number of channels /// \return Number of channels
/// ///
/// \see GetSampleRate, GetDuration /// \see getSampleRate, getDuration
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetChannelCount() const; unsigned int getChannelCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the total duration of the sound /// \brief Get the total duration of the sound
/// ///
/// \return Sound duration /// \return Sound duration
/// ///
/// \see GetSampleRate, GetChannelCount /// \see getSampleRate, getChannelCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time GetDuration() const; Time getDuration() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Overload of assignment operator /// \brief Overload of assignment operator
@ -242,7 +242,7 @@ private :
/// \return True on succesful initialization, false on failure /// \return True on succesful initialization, false on failure
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Initialize(priv::SoundFile& file); bool initialize(priv::SoundFile& file);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the internal buffer with the cached audio samples /// \brief Update the internal buffer with the cached audio samples
@ -253,7 +253,7 @@ private :
/// \return True on success, false if any error happened /// \return True on success, false if any error happened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Update(unsigned int channelCount, unsigned int sampleRate); bool update(unsigned int channelCount, unsigned int sampleRate);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Add a sound to the list of sounds that use this buffer /// \brief Add a sound to the list of sounds that use this buffer
@ -261,7 +261,7 @@ private :
/// \param sound Sound instance to attach /// \param sound Sound instance to attach
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void AttachSound(Sound* sound) const; void attachSound(Sound* sound) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Remove a sound from the list of sounds that use this buffer /// \brief Remove a sound from the list of sounds that use this buffer
@ -269,7 +269,7 @@ private :
/// \param sound Sound instance to detach /// \param sound Sound instance to detach
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void DetachSound(Sound* sound) const; void detachSound(Sound* sound) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Types // Types
@ -304,7 +304,7 @@ private :
/// are like texture pixels, and a sf::SoundBuffer is similar to /// are like texture pixels, and a sf::SoundBuffer is similar to
/// a sf::Texture. /// a sf::Texture.
/// ///
/// A sound buffer can be loaded from a file (see LoadFromFile() /// A sound buffer can be loaded from a file (see loadFromFile()
/// for the complete list of supported formats), from memory, from /// for the complete list of supported formats), from memory, from
/// a custom stream (see sf::InputStream) or directly from an array /// a custom stream (see sf::InputStream) or directly from an array
/// of samples. It can also be saved back to a file. /// of samples. It can also be saved back to a file.
@ -333,25 +333,25 @@ private :
/// sf::SoundBuffer buffer; /// sf::SoundBuffer buffer;
/// ///
/// // Load it from a file /// // Load it from a file
/// if (!buffer.LoadFromFile("sound.wav")) /// if (!buffer.loadFromFile("sound.wav"))
/// { /// {
/// // error... /// // error...
/// } /// }
/// ///
/// // Create a sound source and bind it to the buffer /// // Create a sound source and bind it to the buffer
/// sf::Sound sound1; /// sf::Sound sound1;
/// sound1.SetBuffer(buffer); /// sound1.setBuffer(buffer);
/// ///
/// // Play the sound /// // Play the sound
/// sound1.Play(); /// sound1.play();
/// ///
/// // Create another sound source bound to the same buffer /// // Create another sound source bound to the same buffer
/// sf::Sound sound2; /// sf::Sound sound2;
/// sound2.SetBuffer(buffer); /// sound2.setBuffer(buffer);
/// ///
/// // Play it with a higher pitch -- the first sound remains unchanged /// // Play it with a higher pitch -- the first sound remains unchanged
/// sound2.SetPitch(2); /// sound2.setPitch(2);
/// sound2.Play(); /// sound2.play();
/// \endcode /// \endcode
/// ///
/// \see sf::Sound, sf::SoundBufferRecorder /// \see sf::Sound, sf::SoundBufferRecorder

24
include/SFML/Audio/SoundBufferRecorder.hpp
View file

@ -56,7 +56,7 @@ public :
/// \return Read-only access to the sound buffer /// \return Read-only access to the sound buffer
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const SoundBuffer& GetBuffer() const; const SoundBuffer& getBuffer() const;
private : private :
@ -66,7 +66,7 @@ private :
/// \return True to start the capture, or false to abort it /// \return True to start the capture, or false to abort it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnStart(); virtual bool onStart();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Process a new chunk of recorded samples /// \brief Process a new chunk of recorded samples
@ -77,13 +77,13 @@ private :
/// \return True to continue the capture, or false to stop it /// \return True to continue the capture, or false to stop it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnProcessSamples(const Int16* samples, std::size_t sampleCount); virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop capturing audio data /// \brief Stop capturing audio data
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnStop(); virtual void onStop();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -105,29 +105,29 @@ private :
/// through a sf::SoundBuffer, so that it can be played, saved /// through a sf::SoundBuffer, so that it can be played, saved
/// to a file, etc. /// to a file, etc.
/// ///
/// It has the same simple interface as its base class (Start(), Stop()) /// It has the same simple interface as its base class (start(), stop())
/// and adds a function to retrieve the recorded sound buffer /// and adds a function to retrieve the recorded sound buffer
/// (GetBuffer()). /// (getBuffer()).
/// ///
/// As usual, don't forget to call the IsAvailable() function /// As usual, don't forget to call the isAvailable() function
/// before using this class (see sf::SoundRecorder for more details /// before using this class (see sf::SoundRecorder for more details
/// about this). /// about this).
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// if (SoundBufferRecorder::IsAvailable()) /// if (SoundBufferRecorder::isAvailable())
/// { /// {
/// // Record some audio data /// // Record some audio data
/// SoundBufferRecorder recorder; /// SoundBufferRecorder recorder;
/// recorder.Start(); /// recorder.start();
/// ... /// ...
/// recorder.Stop(); /// recorder.stop();
/// ///
/// // Get the buffer containing the captured audio data /// // Get the buffer containing the captured audio data
/// const sf::SoundBuffer& buffer = recorder.GetBuffer(); /// const sf::SoundBuffer& buffer = recorder.getBuffer();
/// ///
/// // Save it to a file (for example...) /// // Save it to a file (for example...)
/// buffer.SaveToFile("my_record.ogg"); /// buffer.saveToFile("my_record.ogg");
/// } /// }
/// \endcode /// \endcode
/// ///

40
include/SFML/Audio/SoundRecorder.hpp
View file

@ -61,18 +61,18 @@ public :
/// ///
/// \param sampleRate Desired capture rate, in number of samples per second /// \param sampleRate Desired capture rate, in number of samples per second
/// ///
/// \see Stop /// \see stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Start(unsigned int sampleRate = 44100); void start(unsigned int sampleRate = 44100);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop the capture /// \brief Stop the capture
/// ///
/// \see Start /// \see start
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Stop(); void stop();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the sample rate /// \brief Get the sample rate
@ -84,7 +84,7 @@ public :
/// \return Sample rate, in samples per second /// \return Sample rate, in samples per second
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetSampleRate() const; unsigned int getSampleRate() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check if the system supports audio capture /// \brief Check if the system supports audio capture
@ -97,7 +97,7 @@ public :
/// \return True if audio capture is supported, false otherwise /// \return True if audio capture is supported, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsAvailable(); static bool isAvailable();
protected : protected :
@ -122,7 +122,7 @@ private :
/// \return True to start the capture, or false to abort it /// \return True to start the capture, or false to abort it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnStart(); virtual bool onStart();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Process a new chunk of recorded samples /// \brief Process a new chunk of recorded samples
@ -138,7 +138,7 @@ private :
/// \return True to continue the capture, or false to stop it /// \return True to continue the capture, or false to stop it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnProcessSamples(const Int16* samples, std::size_t sampleCount) = 0; virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount) = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop capturing audio data /// \brief Stop capturing audio data
@ -149,7 +149,7 @@ private :
/// implementation does nothing. /// implementation does nothing.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnStop(); virtual void onStop();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Function called as the entry point of the thread /// \brief Function called as the entry point of the thread
@ -158,7 +158,7 @@ private :
/// only when the capture is stopped. /// only when the capture is stopped.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Record(); void record();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the new available audio samples and process them /// \brief Get the new available audio samples and process them
@ -168,7 +168,7 @@ private :
/// forwards them to the derived class. /// forwards them to the derived class.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ProcessCapturedSamples(); void processCapturedSamples();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Clean up the recorder's internal resources /// \brief Clean up the recorder's internal resources
@ -176,7 +176,7 @@ private :
/// This function is called when the capture stops. /// This function is called when the capture stops.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void CleanUp(); void cleanup();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -220,8 +220,8 @@ private :
/// ///
/// It is important to note that the audio capture happens in a /// It is important to note that the audio capture happens in a
/// separate thread, so that it doesn't block the rest of the /// separate thread, so that it doesn't block the rest of the
/// program. In particular, the OnProcessSamples and OnStop /// program. In particular, the onProcessSamples and onStop
/// virtual functions (but not OnStart) will be called /// virtual functions (but not onStart) will be called
/// from this separate thread. It is important to keep this in /// from this separate thread. It is important to keep this in
/// mind, because you may have to take care of synchronization /// mind, because you may have to take care of synchronization
/// issues if you share data between threads. /// issues if you share data between threads.
@ -230,7 +230,7 @@ private :
/// \code /// \code
/// class CustomRecorder : public sf::SoundRecorder /// class CustomRecorder : public sf::SoundRecorder
/// { /// {
/// virtual bool OnStart() // optional /// virtual bool onStart() // optional
/// { /// {
/// // Initialize whatever has to be done before the capture starts /// // Initialize whatever has to be done before the capture starts
/// ... /// ...
@ -239,7 +239,7 @@ private :
/// return true; /// return true;
/// } /// }
/// ///
/// virtual bool OnProcessSamples(const Int16* samples, std::size_t sampleCount) /// virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount)
/// { /// {
/// // Do something with the new chunk of samples (store them, send them, ...) /// // Do something with the new chunk of samples (store them, send them, ...)
/// ... /// ...
@ -248,7 +248,7 @@ private :
/// return true; /// return true;
/// } /// }
/// ///
/// virtual void OnStop() // optional /// virtual void onStop() // optional
/// { /// {
/// // Clean up whatever has to be done after the capture ends /// // Clean up whatever has to be done after the capture ends
/// ... /// ...
@ -256,12 +256,12 @@ private :
/// } /// }
/// ///
/// // Usage /// // Usage
/// if (CustomRecorder::IsAvailable()) /// if (CustomRecorder::isAvailable())
/// { /// {
/// CustomRecorder recorder; /// CustomRecorder recorder;
/// recorder.Start(); /// recorder.start();
/// ... /// ...
/// recorder.Stop(); /// recorder.stop();
/// } /// }
/// \endcode /// \endcode
/// ///

54
include/SFML/Audio/SoundSource.hpp
View file

@ -78,10 +78,10 @@ public :
/// ///
/// \param pitch New pitch to apply to the sound /// \param pitch New pitch to apply to the sound
/// ///
/// \see GetPitch /// \see getPitch
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPitch(float pitch); void setPitch(float pitch);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the volume of the sound /// \brief Set the volume of the sound
@ -91,10 +91,10 @@ public :
/// ///
/// \param volume Volume of the sound /// \param volume Volume of the sound
/// ///
/// \see GetVolume /// \see getVolume
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetVolume(float volume); void setVolume(float volume);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the 3D position of the sound in the audio scene /// \brief Set the 3D position of the sound in the audio scene
@ -107,10 +107,10 @@ public :
/// \param y Y coordinate of the position of the sound in the scene /// \param y Y coordinate of the position of the sound in the scene
/// \param z Z coordinate of the position of the sound in the scene /// \param z Z coordinate of the position of the sound in the scene
/// ///
/// \see GetPosition /// \see getPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPosition(float x, float y, float z); void setPosition(float x, float y, float z);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the 3D position of the sound in the audio scene /// \brief Set the 3D position of the sound in the audio scene
@ -121,10 +121,10 @@ public :
/// ///
/// \param position Position of the sound in the scene /// \param position Position of the sound in the scene
/// ///
/// \see GetPosition /// \see getPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPosition(const Vector3f& position); void setPosition(const Vector3f& position);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Make the sound's position relative to the listener or absolute /// \brief Make the sound's position relative to the listener or absolute
@ -137,10 +137,10 @@ public :
/// ///
/// \param relative True to set the position relative, false to set it absolute /// \param relative True to set the position relative, false to set it absolute
/// ///
/// \see IsRelativeToListener /// \see isRelativeToListener
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetRelativeToListener(bool relative); void setRelativeToListener(bool relative);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the minimum distance of the sound /// \brief Set the minimum distance of the sound
@ -154,10 +154,10 @@ public :
/// ///
/// \param distance New minimum distance of the sound /// \param distance New minimum distance of the sound
/// ///
/// \see GetMinDistance, SetAttenuation /// \see getMinDistance, setAttenuation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetMinDistance(float distance); void setMinDistance(float distance);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the attenuation factor of the sound /// \brief Set the attenuation factor of the sound
@ -173,40 +173,40 @@ public :
/// ///
/// \param attenuation New attenuation factor of the sound /// \param attenuation New attenuation factor of the sound
/// ///
/// \see GetAttenuation, SetMinDistance /// \see getAttenuation, setMinDistance
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetAttenuation(float attenuation); void setAttenuation(float attenuation);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the pitch of the sound /// \brief Get the pitch of the sound
/// ///
/// \return Pitch of the sound /// \return Pitch of the sound
/// ///
/// \see SetPitch /// \see setPitch
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetPitch() const; float getPitch() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the volume of the sound /// \brief Get the volume of the sound
/// ///
/// \return Volume of the sound, in the range [0, 100] /// \return Volume of the sound, in the range [0, 100]
/// ///
/// \see SetVolume /// \see setVolume
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetVolume() const; float getVolume() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the 3D position of the sound in the audio scene /// \brief Get the 3D position of the sound in the audio scene
/// ///
/// \return Position of the sound /// \return Position of the sound
/// ///
/// \see SetPosition /// \see setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector3f GetPosition() const; Vector3f getPosition() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether the sound's position is relative to the /// \brief Tell whether the sound's position is relative to the
@ -214,30 +214,30 @@ public :
/// ///
/// \return True if the position is relative, false if it's absolute /// \return True if the position is relative, false if it's absolute
/// ///
/// \see SetRelativeToListener /// \see setRelativeToListener
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsRelativeToListener() const; bool isRelativeToListener() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the minimum distance of the sound /// \brief Get the minimum distance of the sound
/// ///
/// \return Minimum distance of the sound /// \return Minimum distance of the sound
/// ///
/// \see SetMinDistance, GetAttenuation /// \see setMinDistance, getAttenuation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetMinDistance() const; float getMinDistance() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the attenuation factor of the sound /// \brief Get the attenuation factor of the sound
/// ///
/// \return Attenuation factor of the sound /// \return Attenuation factor of the sound
/// ///
/// \see SetAttenuation, GetMinDistance /// \see setAttenuation, getMinDistance
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetAttenuation() const; float getAttenuation() const;
protected : protected :
@ -255,7 +255,7 @@ protected :
/// \return Current status of the sound /// \return Current status of the sound
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status GetStatus() const; Status getStatus() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data

78
include/SFML/Audio/SoundStream.hpp
View file

@ -51,8 +51,8 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct Chunk struct Chunk
{ {
const Int16* Samples; ///< Pointer to the audio samples const Int16* samples; ///< Pointer to the audio samples
std::size_t SampleCount; ///< Number of samples pointed by Samples std::size_t sampleCount; ///< Number of samples pointed by Samples
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -70,10 +70,10 @@ public :
/// This function uses its own thread so that it doesn't block /// This function uses its own thread so that it doesn't block
/// the rest of the program while the stream is played. /// the rest of the program while the stream is played.
/// ///
/// \see Pause, Stop /// \see pause, stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Play(); void play();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Pause the audio stream /// \brief Pause the audio stream
@ -81,22 +81,22 @@ public :
/// This function pauses the stream if it was playing, /// This function pauses the stream if it was playing,
/// otherwise (stream already paused or stopped) it has no effect. /// otherwise (stream already paused or stopped) it has no effect.
/// ///
/// \see Play, Stop /// \see play, stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Pause(); void pause();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop playing the audio stream /// \brief Stop playing the audio stream
/// ///
/// This function stops the stream if it was playing or paused, /// This function stops the stream if it was playing or paused,
/// and does nothing if it was already stopped. /// and does nothing if it was already stopped.
/// It also resets the playing position (unlike Pause()). /// It also resets the playing position (unlike pause()).
/// ///
/// \see Play, Pause /// \see play, pause
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Stop(); void stop();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the number of channels of the stream /// \brief Return the number of channels of the stream
@ -106,7 +106,7 @@ public :
/// \return Number of channels /// \return Number of channels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetChannelCount() const; unsigned int getChannelCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the stream sample rate of the stream /// \brief Get the stream sample rate of the stream
@ -117,7 +117,7 @@ public :
/// \return Sample rate, in number of samples per second /// \return Sample rate, in number of samples per second
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetSampleRate() const; unsigned int getSampleRate() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current status of the stream (stopped, paused, playing) /// \brief Get the current status of the stream (stopped, paused, playing)
@ -125,7 +125,7 @@ public :
/// \return Current status /// \return Current status
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status GetStatus() const; Status getStatus() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current playing position of the stream /// \brief Change the current playing position of the stream
@ -135,45 +135,45 @@ public :
/// ///
/// \param timeOffset New playing position, from the beginning of the stream /// \param timeOffset New playing position, from the beginning of the stream
/// ///
/// \see GetPlayingOffset /// \see getPlayingOffset
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPlayingOffset(Time timeOffset); void setPlayingOffset(Time timeOffset);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current playing position of the stream /// \brief Get the current playing position of the stream
/// ///
/// \return Current playing position, from the beginning of the stream /// \return Current playing position, from the beginning of the stream
/// ///
/// \see SetPlayingOffset /// \see setPlayingOffset
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time GetPlayingOffset() const; Time getPlayingOffset() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set whether or not the stream should loop after reaching the end /// \brief Set whether or not the stream should loop after reaching the end
/// ///
/// If set, the stream will restart from beginning after /// If set, the stream will restart from beginning after
/// reaching the end and so on, until it is stopped or /// reaching the end and so on, until it is stopped or
/// SetLoop(false) is called. /// setLoop(false) is called.
/// The default looping state for streams is false. /// The default looping state for streams is false.
/// ///
/// \param loop True to play in loop, false to play once /// \param loop True to play in loop, false to play once
/// ///
/// \see GetLoop /// \see getLoop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetLoop(bool loop); void setLoop(bool loop);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether or not the stream is in loop mode /// \brief Tell whether or not the stream is in loop mode
/// ///
/// \return True if the stream is looping, false otherwise /// \return True if the stream is looping, false otherwise
/// ///
/// \see SetLoop /// \see setLoop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool GetLoop() const; bool getLoop() const;
protected : protected :
@ -190,7 +190,7 @@ protected :
/// ///
/// This function must be called by derived classes as soon /// This function must be called by derived classes as soon
/// as they know the audio settings of the stream to play. /// as they know the audio settings of the stream to play.
/// Any attempt to manipulate the stream (Play(), ...) before /// Any attempt to manipulate the stream (play(), ...) before
/// calling this function will fail. /// calling this function will fail.
/// It can be called multiple times if the settings of the /// It can be called multiple times if the settings of the
/// audio stream change, but only when the stream is stopped. /// audio stream change, but only when the stream is stopped.
@ -199,7 +199,7 @@ protected :
/// \param sampleRate Sample rate, in samples per second /// \param sampleRate Sample rate, in samples per second
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Initialize(unsigned int channelCount, unsigned int sampleRate); void initialize(unsigned int channelCount, unsigned int sampleRate);
private : private :
@ -210,7 +210,7 @@ private :
/// only when the sound is stopped. /// only when the sound is stopped.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Stream(); void stream();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Request a new chunk of audio samples from the stream source /// \brief Request a new chunk of audio samples from the stream source
@ -226,7 +226,7 @@ private :
/// \return True to continue playback, false to stop /// \return True to continue playback, false to stop
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool OnGetData(Chunk& data) = 0; virtual bool onGetData(Chunk& data) = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current playing position in the stream source /// \brief Change the current playing position in the stream source
@ -237,7 +237,7 @@ private :
/// \param timeOffset New playing position, relative to the beginning of the stream /// \param timeOffset New playing position, relative to the beginning of the stream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnSeek(Time timeOffset) = 0; virtual void onSeek(Time timeOffset) = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Fill a new buffer with audio samples, and append /// \brief Fill a new buffer with audio samples, and append
@ -252,7 +252,7 @@ private :
/// \return True if the stream source has requested to stop, false otherwise /// \return True if the stream source has requested to stop, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool FillAndPushBuffer(unsigned int bufferNum); bool fillAndPushBuffer(unsigned int bufferNum);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Fill the audio buffers and put them all into the playing queue /// \brief Fill the audio buffers and put them all into the playing queue
@ -263,7 +263,7 @@ private :
/// \return True if the derived class has requested to stop, false otherwise /// \return True if the derived class has requested to stop, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool FillQueue(); bool fillQueue();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Clear all the audio buffers and empty the playing queue /// \brief Clear all the audio buffers and empty the playing queue
@ -271,7 +271,7 @@ private :
/// This function is called when the stream is stopped. /// This function is called when the stream is stopped.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ClearQueue(); void clearQueue();
enum enum
{ {
@ -320,8 +320,8 @@ private :
/// by combining this class with the network module. /// by combining this class with the network module.
/// ///
/// A derived class has to override two virtual functions: /// A derived class has to override two virtual functions:
/// \li OnGetData fills a new chunk of audio data to be played /// \li onGetData fills a new chunk of audio data to be played
/// \li OnSeek changes the current playing position in the source /// \li onSeek changes the current playing position in the source
/// ///
/// It is important to note that each SoundStream is played in its /// It is important to note that each SoundStream is played in its
/// own separate thread, so that the streaming loop doesn't block the /// own separate thread, so that the streaming loop doesn't block the
@ -336,7 +336,7 @@ private :
/// { /// {
/// public : /// public :
/// ///
/// bool Open(const std::string& location) /// bool open(const std::string& location)
/// { /// {
/// // Open the source and get audio settings /// // Open the source and get audio settings
/// ... /// ...
@ -344,22 +344,22 @@ private :
/// unsigned int sampleRate = ...; /// unsigned int sampleRate = ...;
/// ///
/// // Initialize the stream -- important! /// // Initialize the stream -- important!
/// Initialize(channelCount, sampleRate); /// initialize(channelCount, sampleRate);
/// } /// }
/// ///
/// private : /// private :
/// ///
/// virtual bool OnGetData(Chunk& data) /// virtual bool onGetData(Chunk& data)
/// { /// {
/// // Fill the chunk with audio data from the stream source /// // Fill the chunk with audio data from the stream source
/// data.Samples = ...; /// data.samples = ...;
/// data.SampleCount = ...; /// data.sampleCount = ...;
/// ///
/// // Return true to continue playing /// // Return true to continue playing
/// return true; /// return true;
/// } /// }
/// ///
/// virtual void OnSeek(Uint32 timeOffset) /// virtual void onSeek(Uint32 timeOffset)
/// { /// {
/// // Change the current position in the stream source /// // Change the current position in the stream source
/// ... /// ...
@ -368,8 +368,8 @@ private :
/// ///
/// // Usage /// // Usage
/// CustomStream stream; /// CustomStream stream;
/// stream.Open("path/to/stream"); /// stream.open("path/to/stream");
/// stream.Play(); /// stream.play();
/// \endcode /// \endcode
/// ///
/// \see sf::Music /// \see sf::Music

28
include/SFML/Graphics/CircleShape.hpp
View file

@ -56,40 +56,40 @@ public :
/// ///
/// \param radius New radius of the circle /// \param radius New radius of the circle
/// ///
/// \see GetRadius /// \see getRadius
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetRadius(float radius); void setRadius(float radius);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the radius of the circle /// \brief Get the radius of the circle
/// ///
/// \return Radius of the circle /// \return Radius of the circle
/// ///
/// \see SetRadius /// \see setRadius
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetRadius() const; float getRadius() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the number of points of the circle /// \brief Set the number of points of the circle
/// ///
/// \param count New number of points of the circle /// \param count New number of points of the circle
/// ///
/// \see GetPointCount /// \see getPointCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPointCount(unsigned int count); void setPointCount(unsigned int count);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of points of the shape /// \brief Get the number of points of the shape
/// ///
/// \return Number of points of the shape /// \return Number of points of the shape
/// ///
/// \see SetPointCount /// \see setPointCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual unsigned int GetPointCount() const; virtual unsigned int getPointCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a point of the shape /// \brief Get a point of the shape
@ -101,7 +101,7 @@ public :
/// \return Index-th point of the shape /// \return Index-th point of the shape
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2f GetPoint(unsigned int index) const; virtual Vector2f getPoint(unsigned int index) const;
private : private :
@ -129,12 +129,12 @@ private :
/// Usage example: /// Usage example:
/// \code /// \code
/// sf::CircleShape circle; /// sf::CircleShape circle;
/// circle.SetRadius(150); /// circle.setRadius(150);
/// circle.SetOutlineColor(sf::Color::Red); /// circle.setOutlineColor(sf::Color::Red);
/// circle.SetOutlineThickness(5); /// circle.setOutlineThickness(5);
/// circle.SetPosition(10, 20); /// circle.setPosition(10, 20);
/// ... /// ...
/// window.Draw(circle); /// window.draw(circle);
/// \endcode /// \endcode
/// ///
/// Since the graphics card can't draw perfect circles, we have to /// Since the graphics card can't draw perfect circles, we have to

32
include/SFML/Graphics/ConvexShape.hpp
View file

@ -58,20 +58,20 @@ public :
/// ///
/// \param count New number of points of the polygon /// \param count New number of points of the polygon
/// ///
/// \see GetPointCount /// \see getPointCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPointCount(unsigned int count); void setPointCount(unsigned int count);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of points of the polygon /// \brief Get the number of points of the polygon
/// ///
/// \return Number of points of the polygon /// \return Number of points of the polygon
/// ///
/// \see SetPointCount /// \see setPointCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual unsigned int GetPointCount() const; virtual unsigned int getPointCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the position of a point /// \brief Set the position of a point
@ -85,10 +85,10 @@ public :
/// \param index Index of the point to change, in range [0 .. GetPointCount() - 1] /// \param index Index of the point to change, in range [0 .. GetPointCount() - 1]
/// \param point New position of the point /// \param point New position of the point
/// ///
/// \see GetPoint /// \see getPoint
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPoint(unsigned int index, const Vector2f& point); void setPoint(unsigned int index, const Vector2f& point);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the position of a point /// \brief Get the position of a point
@ -99,10 +99,10 @@ public :
/// ///
/// \return Position of the index-th point of the polygon /// \return Position of the index-th point of the polygon
/// ///
/// \see SetPoint /// \see setPoint
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2f GetPoint(unsigned int index) const; virtual Vector2f getPoint(unsigned int index) const;
private : private :
@ -134,15 +134,15 @@ private :
/// Usage example: /// Usage example:
/// \code /// \code
/// sf::ConvexShape polygon; /// sf::ConvexShape polygon;
/// polygon.SetPointCount(3); /// polygon.setPointCount(3);
/// polygon.SetPoint(0, sf::Vector2f(0, 0)); /// polygon.setPoint(0, sf::Vector2f(0, 0));
/// polygon.SetPoint(1, sf::Vector2f(0, 10)); /// polygon.setPoint(1, sf::Vector2f(0, 10));
/// polygon.SetPoint(2, sf::Vector2f(25, 5)); /// polygon.setPoint(2, sf::Vector2f(25, 5));
/// polygon.SetOutlineColor(sf::Color::Red); /// polygon.setOutlineColor(sf::Color::Red);
/// polygon.SetOutlineThickness(5); /// polygon.setOutlineThickness(5);
/// polygon.SetPosition(10, 20); /// polygon.setPosition(10, 20);
/// ... /// ...
/// window.Draw(polygon); /// window.draw(polygon);
/// \endcode /// \endcode
/// ///
/// \see sf::Shape, sf::RectangleShape, sf::CircleShape /// \see sf::Shape, sf::RectangleShape, sf::CircleShape

8
include/SFML/Graphics/Drawable.hpp
View file

@ -66,7 +66,7 @@ private :
/// \param states Current render states /// \param states Current render states
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void Draw(RenderTarget& target, RenderStates states) const = 0; virtual void draw(RenderTarget& target, RenderStates states) const = 0;
}; };
} // namespace sf } // namespace sf
@ -100,14 +100,14 @@ private :
/// ///
/// private : /// private :
/// ///
/// virtual void Draw(sf::RenderTarget& target, RenderStates states) const /// virtual void draw(sf::RenderTarget& target, RenderStates states) const
/// { /// {
/// // You can draw other high-level objects /// // You can draw other high-level objects
/// target.Draw(m_sprite, states); /// target.draw(m_sprite, states);
/// ///
/// // ... or use the low-level API /// // ... or use the low-level API
/// states.Texture = &m_texture; /// states.Texture = &m_texture;
/// target.Draw(m_vertices, states); /// target.draw(m_vertices, states);
/// ///
/// // ... or draw with OpenGL directly /// // ... or draw with OpenGL directly
/// glBegin(GL_QUADS); /// glBegin(GL_QUADS);

62
include/SFML/Graphics/Font.hpp
View file

@ -88,10 +88,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromMemory, LoadFromStream /// \see loadFromMemory, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromFile(const std::string& filename); bool loadFromFile(const std::string& filename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the font from a file in memory /// \brief Load the font from a file in memory
@ -107,10 +107,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromStream /// \see loadFromFile, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromMemory(const void* data, std::size_t sizeInBytes); bool loadFromMemory(const void* data, std::size_t sizeInBytes);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the font from a custom stream /// \brief Load the font from a custom stream
@ -125,10 +125,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromMemory /// \see loadFromFile, loadFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromStream(InputStream& stream); bool loadFromStream(InputStream& stream);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Retrieve a glyph of the font /// \brief Retrieve a glyph of the font
@ -140,7 +140,7 @@ public :
/// \return The glyph corresponding to \a codePoint and \a characterSize /// \return The glyph corresponding to \a codePoint and \a characterSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Glyph& GetGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const; const Glyph& getGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the kerning offset of two glyphs /// \brief Get the kerning offset of two glyphs
@ -158,7 +158,7 @@ public :
/// \return Kerning value for \a first and \a second, in pixels /// \return Kerning value for \a first and \a second, in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int GetKerning(Uint32 first, Uint32 second, unsigned int characterSize) const; int getKerning(Uint32 first, Uint32 second, unsigned int characterSize) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the line spacing /// \brief Get the line spacing
@ -171,7 +171,7 @@ public :
/// \return Line spacing, in pixels /// \return Line spacing, in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int GetLineSpacing(unsigned int characterSize) const; int getLineSpacing(unsigned int characterSize) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Retrieve the texture containing the loaded glyphs of a certain size /// \brief Retrieve the texture containing the loaded glyphs of a certain size
@ -185,7 +185,7 @@ public :
/// \return Texture containing the glyphs of the requested size /// \return Texture containing the glyphs of the requested size
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Texture& GetTexture(unsigned int characterSize) const; const Texture& getTexture(unsigned int characterSize) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Overload of assignment operator /// \brief Overload of assignment operator
@ -209,7 +209,7 @@ public :
/// \return Reference to the built-in default font /// \return Reference to the built-in default font
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static const Font& GetDefaultFont(); static const Font& getDefaultFont();
private : private :
@ -219,11 +219,11 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct Row struct Row
{ {
Row(unsigned int top, unsigned int height) : Width(0), Top(top), Height(height) {} Row(unsigned int top, unsigned int height) : width(0), top(top), height(height) {}
unsigned int Width; ///< Current width of the row unsigned int width; ///< Current width of the row
unsigned int Top; ///< Y position of the row into the texture unsigned int top; ///< Y position of the row into the texture
unsigned int Height; ///< Height of the row unsigned int height; ///< Height of the row
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -239,17 +239,17 @@ private :
{ {
Page(); Page();
GlyphTable Glyphs; ///< Table mapping code points to their corresponding glyph GlyphTable glyphs; ///< Table mapping code points to their corresponding glyph
sf::Texture Texture; ///< Texture containing the pixels of the glyphs sf::Texture texture; ///< Texture containing the pixels of the glyphs
unsigned int NextRow; ///< Y position of the next new row in the texture unsigned int nextRow; ///< Y position of the next new row in the texture
std::vector<Row> Rows; ///< List containing the position of all the existing rows std::vector<Row> rows; ///< List containing the position of all the existing rows
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Free all the internal resources /// \brief Free all the internal resources
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Cleanup(); void cleanup();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load a new glyph and store it in the cache /// \brief Load a new glyph and store it in the cache
@ -261,7 +261,7 @@ private :
/// \return The glyph corresponding to \a codePoint and \a characterSize /// \return The glyph corresponding to \a codePoint and \a characterSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Glyph LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const; Glyph loadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Find a suitable rectangle within the texture for a glyph /// \brief Find a suitable rectangle within the texture for a glyph
@ -273,7 +273,7 @@ private :
/// \return Found rectangle within the texture /// \return Found rectangle within the texture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
IntRect FindGlyphRect(Page& page, unsigned int width, unsigned int height) const; IntRect findGlyphRect(Page& page, unsigned int width, unsigned int height) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Make sure that the given size is the current one /// \brief Make sure that the given size is the current one
@ -283,7 +283,7 @@ private :
/// \return True on success, false if any error happened /// \return True on success, false if any error happened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SetCurrentSize(unsigned int characterSize) const; bool setCurrentSize(unsigned int characterSize) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Types // Types
@ -313,7 +313,7 @@ private :
/// ///
/// Fonts can be loaded from a file, from memory or from a custom /// Fonts can be loaded from a file, from memory or from a custom
/// stream, and supports the most common types of fonts. See /// stream, and supports the most common types of fonts. See
/// the LoadFromFile function for the complete list of supported formats. /// the loadFromFile function for the complete list of supported formats.
/// ///
/// Once it is loaded, a sf::Font instance provides three /// Once it is loaded, a sf::Font instance provides three
/// types of informations about the font: /// types of informations about the font:
@ -347,22 +347,22 @@ private :
/// sf::Font font; /// sf::Font font;
/// ///
/// // Load it from a file /// // Load it from a file
/// if (!font.LoadFromFile("arial.ttf")) /// if (!font.loadFromFile("arial.ttf"))
/// { /// {
/// // error... /// // error...
/// } /// }
/// ///
/// // Create a text which uses our font /// // Create a text which uses our font
/// sf::Text text1; /// sf::Text text1;
/// text1.SetFont(font); /// text1.setFont(font);
/// text1.SetCharacterSize(30); /// text1.setCharacterSize(30);
/// text1.SetStyle(sf::Text::Regular); /// text1.setStyle(sf::Text::Regular);
/// ///
/// // Create another text using the same font, but with different parameters /// // Create another text using the same font, but with different parameters
/// sf::Text text2; /// sf::Text text2;
/// text2.SetFont(font); /// text2.setFont(font);
/// text2.SetCharacterSize(50); /// text2.setCharacterSize(50);
/// text1.SetStyle(sf::Text::Italic); /// text1.setStyle(sf::Text::Italic);
/// \endcode /// \endcode
/// ///
/// Apart from loading font files, and passing them to instances /// Apart from loading font files, and passing them to instances

8
include/SFML/Graphics/Glyph.hpp
View file

@ -46,14 +46,14 @@ public :
/// \brief Default constructor /// \brief Default constructor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Glyph() : Advance(0) {} Glyph() : advance(0) {}
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int Advance; ///< Offset to move horizontically to the next character int advance; ///< Offset to move horizontically to the next character
IntRect Bounds; ///< Bounding rectangle of the glyph, in coordinates relative to the baseline IntRect bounds; ///< Bounding rectangle of the glyph, in coordinates relative to the baseline
IntRect TextureRect; ///< Texture coordinates of the glyph inside the font's texture IntRect textureRect; ///< Texture coordinates of the glyph inside the font's texture
}; };
} // namespace sf } // namespace sf

60
include/SFML/Graphics/Image.hpp
View file

@ -63,7 +63,7 @@ public :
/// \param color Fill color /// \param color Fill color
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Create(unsigned int width, unsigned int height, const Color& color = Color(0, 0, 0)); void create(unsigned int width, unsigned int height, const Color& color = Color(0, 0, 0));
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create the image from an array of pixels /// \brief Create the image from an array of pixels
@ -78,7 +78,7 @@ public :
/// \param pixels Array of pixels to copy to the image /// \param pixels Array of pixels to copy to the image
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Create(unsigned int width, unsigned int height, const Uint8* pixels); void create(unsigned int width, unsigned int height, const Uint8* pixels);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the image from a file on disk /// \brief Load the image from a file on disk
@ -92,10 +92,10 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromMemory, LoadFromStream, SaveToFile /// \see loadFromMemory, loadFromStream, saveToFile
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromFile(const std::string& filename); bool loadFromFile(const std::string& filename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the image from a file in memory /// \brief Load the image from a file in memory
@ -110,10 +110,10 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromFile, LoadFromStream /// \see loadFromFile, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromMemory(const void* data, std::size_t size); bool loadFromMemory(const void* data, std::size_t size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the image from a custom stream /// \brief Load the image from a custom stream
@ -127,10 +127,10 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromFile, LoadFromMemory /// \see loadFromFile, loadFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromStream(InputStream& stream); bool loadFromStream(InputStream& stream);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Save the image to a file on disk /// \brief Save the image to a file on disk
@ -144,30 +144,30 @@ public :
/// ///
/// \return True if saving was successful /// \return True if saving was successful
/// ///
/// \see Create, LoadFromFile, LoadFromMemory /// \see create, loadFromFile, loadFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SaveToFile(const std::string& filename) const; bool saveToFile(const std::string& filename) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the width of the image /// \brief Return the width of the image
/// ///
/// \return Width in pixels /// \return Width in pixels
/// ///
/// \see GetHeight /// \see getHeight
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetWidth() const; unsigned int getWidth() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the height of the image /// \brief Return the height of the image
/// ///
/// \return Height in pixels /// \return Height in pixels
/// ///
/// \see GetWidth /// \see getWidth
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetHeight() const; unsigned int getHeight() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create a transparency mask from a specified color-key /// \brief Create a transparency mask from a specified color-key
@ -180,7 +180,7 @@ public :
/// \param alpha Alpha value to assign to transparent pixels /// \param alpha Alpha value to assign to transparent pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void CreateMaskFromColor(const Color& color, Uint8 alpha = 0); void createMaskFromColor(const Color& color, Uint8 alpha = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Copy pixels from another image onto this one /// \brief Copy pixels from another image onto this one
@ -202,7 +202,7 @@ public :
/// \param applyAlpha Should the copy take in account the source transparency? /// \param applyAlpha Should the copy take in account the source transparency?
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect = IntRect(0, 0, 0, 0), bool applyAlpha = false); void copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect = IntRect(0, 0, 0, 0), bool applyAlpha = false);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the color of a pixel /// \brief Change the color of a pixel
@ -215,10 +215,10 @@ public :
/// \param y Y coordinate of pixel to change /// \param y Y coordinate of pixel to change
/// \param color New color of the pixel /// \param color New color of the pixel
/// ///
/// \see GetPixel /// \see getPixel
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPixel(unsigned int x, unsigned int y, const Color& color); void setPixel(unsigned int x, unsigned int y, const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the color of a pixel /// \brief Get the color of a pixel
@ -232,8 +232,10 @@ public :
/// ///
/// \return Color of the pixel at coordinates (x, y) /// \return Color of the pixel at coordinates (x, y)
/// ///
/// \see setPixel
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Color GetPixel(unsigned int x, unsigned int y) const; Color getPixel(unsigned int x, unsigned int y) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a read-only pointer to the array of pixels /// \brief Get a read-only pointer to the array of pixels
@ -248,19 +250,19 @@ public :
/// \return Read-only pointer to the array of pixels /// \return Read-only pointer to the array of pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Uint8* GetPixelsPtr() const; const Uint8* getPixelsPtr() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Flip the image horizontally (left <-> right) /// \brief Flip the image horizontally (left <-> right)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void FlipHorizontally(); void flipHorizontally();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Flip the image vertically (top <-> bottom) /// \brief Flip the image vertically (top <-> bottom)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void FlipVertically(); void flipVertically();
private : private :
@ -293,7 +295,7 @@ private :
/// channels -- just like a sf::Color. /// channels -- just like a sf::Color.
/// All the functions that return an array of pixels follow /// All the functions that return an array of pixels follow
/// this rule, and all parameters that you pass to sf::Image /// this rule, and all parameters that you pass to sf::Image
/// functions (such as LoadFromPixels) must use this /// functions (such as loadFromPixels) must use this
/// representation as well. /// representation as well.
/// ///
/// A sf::Image can be copied, but it is a heavy resource and /// A sf::Image can be copied, but it is a heavy resource and
@ -304,24 +306,24 @@ private :
/// \code /// \code
/// // Load an image file from a file /// // Load an image file from a file
/// sf::Image background; /// sf::Image background;
/// if (!background.LoadFromFile("background.jpg")) /// if (!background.loadFromFile("background.jpg"))
/// return -1; /// return -1;
/// ///
/// // Create a 20x20 image filled with black color /// // Create a 20x20 image filled with black color
/// sf::Image image; /// sf::Image image;
/// if (!image.Create(20, 20, sf::Color::Black)) /// if (!image.create(20, 20, sf::Color::Black))
/// return -1; /// return -1;
/// ///
/// // Copy image1 on image2 at position (10, 10) /// // Copy image1 on image2 at position (10, 10)
/// image.Copy(background, 10, 10); /// image.copy(background, 10, 10);
/// ///
/// // Make the top-left pixel transparent /// // Make the top-left pixel transparent
/// sf::Color color = image.GetPixel(0, 0); /// sf::Color color = image.getPixel(0, 0);
/// color.a = 0; /// color.a = 0;
/// image.SetPixel(0, 0, color); /// image.setPixel(0, 0, color);
/// ///
/// // Save the image to a file /// // Save the image to a file
/// if (!image.SaveToFile("result.png")) /// if (!image.saveToFile("result.png"))
/// return -1; /// return -1;
/// \endcode /// \endcode
/// ///

38
include/SFML/Graphics/Rect.hpp
View file

@ -100,10 +100,10 @@ public :
/// ///
/// \return True if the point is inside, false otherwise /// \return True if the point is inside, false otherwise
/// ///
/// \see Intersects /// \see intersects
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Contains(T x, T y) const; bool contains(T x, T y) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check if a point is inside the rectangle's area /// \brief Check if a point is inside the rectangle's area
@ -112,10 +112,10 @@ public :
/// ///
/// \return True if the point is inside, false otherwise /// \return True if the point is inside, false otherwise
/// ///
/// \see Intersects /// \see intersects
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Contains(const Vector2<T>& point) const; bool contains(const Vector2<T>& point) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check the intersection between two rectangles /// \brief Check the intersection between two rectangles
@ -124,10 +124,10 @@ public :
/// ///
/// \return True if rectangles overlap, false otherwise /// \return True if rectangles overlap, false otherwise
/// ///
/// \see Contains /// \see contains
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Intersects(const Rect<T>& rectangle) const; bool intersects(const Rect<T>& rectangle) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check the intersection between two rectangles /// \brief Check the intersection between two rectangles
@ -140,18 +140,18 @@ public :
/// ///
/// \return True if rectangles overlap, false otherwise /// \return True if rectangles overlap, false otherwise
/// ///
/// \see Contains /// \see contains
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Intersects(const Rect<T>& rectangle, Rect<T>& intersection) const; bool intersects(const Rect<T>& rectangle, Rect<T>& intersection) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
T Left; ///< Left coordinate of the rectangle T left; ///< Left coordinate of the rectangle
T Top; ///< Top coordinate of the rectangle T top; ///< Top coordinate of the rectangle
T Width; ///< Width of the rectangle T width; ///< Width of the rectangle
T Height; ///< Height of the rectangle T height; ///< Height of the rectangle
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -202,18 +202,18 @@ typedef Rect<float> FloatRect;
/// ///
/// A rectangle is defined by its top-left corner and its size. /// A rectangle is defined by its top-left corner and its size.
/// It is a very simple class defined for convenience, so /// It is a very simple class defined for convenience, so
/// its member variables (Left, Top, Width and Height) are public /// its member variables (left, top, width and height) are public
/// and can be accessed directly, just like the vector classes /// and can be accessed directly, just like the vector classes
/// (Vector2 and Vector3). /// (Vector2 and Vector3).
/// ///
/// To keep things simple, sf::Rect doesn't define /// To keep things simple, sf::Rect doesn't define
/// functions to emulate the properties that are not directly /// functions to emulate the properties that are not directly
/// members (such as Right, Bottom, Center, etc.), it rather /// members (such as right, bottom, center, etc.), it rather
/// only provides intersection functions. /// only provides intersection functions.
/// ///
/// sf::Rect uses the usual rules for its boundaries: /// sf::Rect uses the usual rules for its boundaries:
/// \li The Left and Top edges are included in the rectangle's area /// \li The left and top edges are included in the rectangle's area
/// \li The right (Left + Width) and bottom (Top + Height) edges are excluded from the rectangle's area /// \li The right (left + width) and bottom (top + height) edges are excluded from the rectangle's area
/// ///
/// This means that sf::IntRect(0, 0, 1, 1) and sf::IntRect(1, 1, 1, 1) /// This means that sf::IntRect(0, 0, 1, 1) and sf::IntRect(1, 1, 1, 1)
/// don't intersect. /// don't intersect.
@ -236,12 +236,12 @@ typedef Rect<float> FloatRect;
/// sf::IntRect r2(position, size); /// sf::IntRect r2(position, size);
/// ///
/// // Test intersections with the point (3, 1) /// // Test intersections with the point (3, 1)
/// bool b1 = r1.Contains(3, 1); // true /// bool b1 = r1.contains(3, 1); // true
/// bool b2 = r2.Contains(3, 1); // false /// bool b2 = r2.contains(3, 1); // false
/// ///
/// // Test the intersection between r1 and r2 /// // Test the intersection between r1 and r2
/// sf::IntRect result; /// sf::IntRect result;
/// bool b3 = r1.Intersects(r2, result); // true /// bool b3 = r1.intersects(r2, result); // true
/// // result == (4, 2, 16, 3) /// // result == (4, 2, 16, 3)
/// \endcode /// \endcode
/// ///

65
include/SFML/Graphics/Rect.inl
View file

@ -26,10 +26,10 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
Rect<T>::Rect() : Rect<T>::Rect() :
Left (0), left (0),
Top (0), top (0),
Width (0), width (0),
Height(0) height(0)
{ {
} }
@ -38,10 +38,10 @@ Height(0)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
Rect<T>::Rect(T left, T top, T width, T height) : Rect<T>::Rect(T left, T top, T width, T height) :
Left (left), left (left),
Top (top), top (top),
Width (width), width (width),
Height(height) height(height)
{ {
} }
@ -50,10 +50,10 @@ Height(height)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
Rect<T>::Rect(const Vector2<T>& position, const Vector2<T>& size) : Rect<T>::Rect(const Vector2<T>& position, const Vector2<T>& size) :
Left (position.x), left (position.x),
Top (position.y), top (position.y),
Width (size.x), width (size.x),
Height(size.y) height(size.y)
{ {
} }
@ -63,53 +63,53 @@ Height(size.y)
template <typename T> template <typename T>
template <typename U> template <typename U>
Rect<T>::Rect(const Rect<U>& rectangle) : Rect<T>::Rect(const Rect<U>& rectangle) :
Left (static_cast<T>(rectangle.Left)), left (static_cast<T>(rectangle.left)),
Top (static_cast<T>(rectangle.Top)), top (static_cast<T>(rectangle.Top)),
Width (static_cast<T>(rectangle.Width)), width (static_cast<T>(rectangle.Width)),
Height(static_cast<T>(rectangle.Height)) height(static_cast<T>(rectangle.Height))
{ {
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
bool Rect<T>::Contains(T x, T y) const bool Rect<T>::contains(T x, T y) const
{ {
return (x >= Left) && (x < Left + Width) && (y >= Top) && (y < Top + Height); return (x >= left) && (x < left + width) && (y >= top) && (y < top + height);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
bool Rect<T>::Contains(const Vector2<T>& point) const bool Rect<T>::contains(const Vector2<T>& point) const
{ {
return Contains(point.x, point.y); return contains(point.x, point.y);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
bool Rect<T>::Intersects(const Rect<T>& rectangle) const bool Rect<T>::intersects(const Rect<T>& rectangle) const
{ {
Rect<T> intersection; Rect<T> intersection;
return Intersects(rectangle, intersection); return intersects(rectangle, intersection);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename T> template <typename T>
bool Rect<T>::Intersects(const Rect<T>& rectangle, Rect<T>& intersection) const bool Rect<T>::intersects(const Rect<T>& rectangle, Rect<T>& intersection) const
{ {
// Compute the intersection boundaries // Compute the intersection boundaries
T left = std::max(Left, rectangle.Left); T interLeft = std::max(left, rectangle.left);
T top = std::max(Top, rectangle.Top); T interTop = std::max(top, rectangle.top);
T right = std::min(Left + Width, rectangle.Left + rectangle.Width); T interRight = std::min(left + width, rectangle.left + rectangle.width);
T bottom = std::min(Top + Height, rectangle.Top + rectangle.Height); T interBottom = std::min(top + height, rectangle.top + rectangle.height);
// If the intersection is valid (positive non zero area), then there is an intersection // If the intersection is valid (positive non zero area), then there is an intersection
if ((left < right) && (top < bottom)) if ((interLeft < interRight) && (interTop < interBottom))
{ {
intersection = Rect<T>(left, top, right - left, bottom - top); intersection = Rect<T>(interLeft, interTop, interRight - interLeft, interBottom - interTop);
return true; return true;
} }
else else
@ -124,8 +124,8 @@ bool Rect<T>::Intersects(const Rect<T>& rectangle, Rect<T>& intersection) const
template <typename T> template <typename T>
inline bool operator ==(const Rect<T>& left, const Rect<T>& right) inline bool operator ==(const Rect<T>& left, const Rect<T>& right)
{ {
return (left.Left == right.Left) && (left.Width == right.Width) && return (left.left == right.left) && (left.width == right.width) &&
(left.Top == right.Top) && (left.Height == right.Height); (left.top == right.top) && (left.height == right.height);
} }
@ -133,6 +133,5 @@ inline bool operator ==(const Rect<T>& left, const Rect<T>& right)
template <typename T> template <typename T>
inline bool operator !=(const Rect<T>& left, const Rect<T>& right) inline bool operator !=(const Rect<T>& left, const Rect<T>& right)
{ {
return (left.Left != right.Left) || (left.Width != right.Width) || return !(left == right);
(left.Top != right.Top) || (left.Height != right.Height);
} }

22
include/SFML/Graphics/RectangleShape.hpp
View file

@ -55,20 +55,20 @@ public :
/// ///
/// \param size New size of the rectangle /// \param size New size of the rectangle
/// ///
/// \see GetSize /// \see getSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetSize(const Vector2f& size); void setSize(const Vector2f& size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the size of the rectangle /// \brief Get the size of the rectangle
/// ///
/// \return Size of the rectangle /// \return Size of the rectangle
/// ///
/// \see SetSize /// \see setSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vector2f& GetSize() const; const Vector2f& getSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of points defining the shape /// \brief Get the number of points defining the shape
@ -76,7 +76,7 @@ public :
/// \return Number of points of the shape /// \return Number of points of the shape
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual unsigned int GetPointCount() const; virtual unsigned int getPointCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a point of the shape /// \brief Get a point of the shape
@ -88,7 +88,7 @@ public :
/// \return Index-th point of the shape /// \return Index-th point of the shape
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2f GetPoint(unsigned int index) const; virtual Vector2f getPoint(unsigned int index) const;
private : private :
@ -115,12 +115,12 @@ private :
/// Usage example: /// Usage example:
/// \code /// \code
/// sf::RectangleShape rectangle; /// sf::RectangleShape rectangle;
/// rectangle.SetSize(sf::Vector2f(100, 50)); /// rectangle.setSize(sf::Vector2f(100, 50));
/// rectangle.SetOutlineColor(sf::Color::Red); /// rectangle.setOutlineColor(sf::Color::Red);
/// rectangle.SetOutlineThickness(5); /// rectangle.setOutlineThickness(5);
/// rectangle.SetPosition(10, 20); /// rectangle.setPosition(10, 20);
/// ... /// ...
/// window.Draw(rectangle); /// window.draw(rectangle);
/// \endcode /// \endcode
/// ///
/// \see sf::Shape, sf::CircleShape, sf::ConvexShape /// \see sf::Shape, sf::CircleShape, sf::ConvexShape

22
include/SFML/Graphics/RenderStates.hpp
View file

@ -66,7 +66,7 @@ public :
/// \param blendMode Blend mode to use /// \param blendMode Blend mode to use
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderStates(sf::BlendMode blendMode); RenderStates(BlendMode blendMode);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct a default set of render states with a custom transform /// \brief Construct a default set of render states with a custom transform
@ -74,7 +74,7 @@ public :
/// \param transform Transform to use /// \param transform Transform to use
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderStates(const sf::Transform& transform); RenderStates(const Transform& transform);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct a default set of render states with a custom texture /// \brief Construct a default set of render states with a custom texture
@ -82,7 +82,7 @@ public :
/// \param texture Texture to use /// \param texture Texture to use
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderStates(const sf::Texture* texture); RenderStates(const Texture* texture);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct a default set of render states with a custom shader /// \brief Construct a default set of render states with a custom shader
@ -90,7 +90,7 @@ public :
/// \param shader Shader to use /// \param shader Shader to use
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderStates(const sf::Shader* shader); RenderStates(const Shader* shader);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct a set of render states with all its attributes /// \brief Construct a set of render states with all its attributes
@ -101,8 +101,8 @@ public :
/// \param shader Shader to use /// \param shader Shader to use
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderStates(sf::BlendMode blendMode, const sf::Transform& transform, RenderStates(BlendMode blendMode, const Transform& transform,
const sf::Texture* texture, const sf::Shader* shader); const Texture* texture, const Shader* shader);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Static member data // Static member data
@ -112,10 +112,10 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf::BlendMode BlendMode; ///< Blending mode BlendMode blendMode; ///< Blending mode
sf::Transform Transform; ///< Transform Transform transform; ///< Transform
const sf::Texture* Texture; ///< Texture const Texture* texture; ///< Texture
const sf::Shader* Shader; ///< Shader const Shader* shader; ///< Shader
}; };
} // namespace sf } // namespace sf
@ -158,7 +158,7 @@ public :
/// function: sf::RenderStates has an implicit one-argument /// function: sf::RenderStates has an implicit one-argument
/// constructor for each state. /// constructor for each state.
/// \code /// \code
/// window.Draw(sprite, shader); /// window.draw(sprite, shader);
/// \endcode /// \endcode
/// ///
/// When you're inside the Draw function of a drawable /// When you're inside the Draw function of a drawable

86
include/SFML/Graphics/RenderTarget.hpp
View file

@ -67,7 +67,7 @@ public :
/// \param color Fill color to use to clear the render target /// \param color Fill color to use to clear the render target
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Clear(const Color& color = Color(0, 0, 0, 255)); void clear(const Color& color = Color(0, 0, 0, 255));
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current active view /// \brief Change the current active view
@ -81,24 +81,24 @@ public :
/// so it is not necessary to keep the original one alive /// so it is not necessary to keep the original one alive
/// after calling this function. /// after calling this function.
/// To restore the original view of the target, you can pass /// To restore the original view of the target, you can pass
/// the result of GetDefaultView() to this function. /// the result of getDefaultView() to this function.
/// ///
/// \param view New view to use /// \param view New view to use
/// ///
/// \see GetView, GetDefaultView /// \see getView, getDefaultView
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetView(const View& view); void setView(const View& view);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the view currently in use in the render target /// \brief Get the view currently in use in the render target
/// ///
/// \return The view object that is currently used /// \return The view object that is currently used
/// ///
/// \see SetView, GetDefaultView /// \see setView, getDefaultView
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const View& GetView() const; const View& getView() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the default view of the render target /// \brief Get the default view of the render target
@ -108,10 +108,10 @@ public :
/// ///
/// \return The default view of the render target /// \return The default view of the render target
/// ///
/// \see SetView, GetView /// \see setView, getView
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const View& GetDefaultView() const; const View& getDefaultView() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the viewport of a view, applied to this render target /// \brief Get the viewport of a view, applied to this render target
@ -126,7 +126,7 @@ public :
/// \return Viewport rectangle, expressed in pixels /// \return Viewport rectangle, expressed in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
IntRect GetViewport(const View& view) const; IntRect getViewport(const View& view) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a point from target coordinates to view coordinates /// \brief Convert a point from target coordinates to view coordinates
@ -150,7 +150,7 @@ public :
/// \return The converted point, in "world" units /// \return The converted point, in "world" units
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f ConvertCoords(unsigned int x, unsigned int y) const; Vector2f convertCoords(unsigned int x, unsigned int y) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a point from target coordinates to view coordinates /// \brief Convert a point from target coordinates to view coordinates
@ -176,7 +176,7 @@ public :
/// \return The converted point, in "world" units /// \return The converted point, in "world" units
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f ConvertCoords(unsigned int x, unsigned int y, const View& view) const; Vector2f convertCoords(unsigned int x, unsigned int y, const View& view) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Draw a drawable object to the render-target /// \brief Draw a drawable object to the render-target
@ -185,7 +185,7 @@ public :
/// \param states Render states to use for drawing /// \param states Render states to use for drawing
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Draw(const Drawable& drawable, const RenderStates& states = RenderStates::Default); void draw(const Drawable& drawable, const RenderStates& states = RenderStates::Default);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Draw primitives defined by an array of vertices /// \brief Draw primitives defined by an array of vertices
@ -196,7 +196,7 @@ public :
/// \param states Render states to use for drawing /// \param states Render states to use for drawing
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Draw(const Vertex* vertices, unsigned int vertexCount, void draw(const Vertex* vertices, unsigned int vertexCount,
PrimitiveType type, const RenderStates& states = RenderStates::Default); PrimitiveType type, const RenderStates& states = RenderStates::Default);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -204,10 +204,8 @@ public :
/// ///
/// \return Size in pixels /// \return Size in pixels
/// ///
/// \see GetHeight
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2u GetSize() const = 0; virtual Vector2u getSize() const = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Save the current OpenGL render states and matrices /// \brief Save the current OpenGL render states and matrices
@ -222,10 +220,10 @@ public :
/// calls Draw functions. Example: /// calls Draw functions. Example:
/// \code /// \code
/// // OpenGL code here... /// // OpenGL code here...
/// window.PushGLStates(); /// window.pushGLStates();
/// window.Draw(...); /// window.draw(...);
/// window.Draw(...); /// window.draw(...);
/// window.PopGLStates(); /// window.popGLStates();
/// // OpenGL code here... /// // OpenGL code here...
/// \endcode /// \endcode
/// ///
@ -238,44 +236,44 @@ public :
/// saved and restored). Take a look at the ResetGLStates /// saved and restored). Take a look at the ResetGLStates
/// function if you do so. /// function if you do so.
/// ///
/// \see PopGLStates /// \see popGLStates
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void PushGLStates(); void pushGLStates();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Restore the previously saved OpenGL render states and matrices /// \brief Restore the previously saved OpenGL render states and matrices
/// ///
/// See the description of PushGLStates to get a detailed /// See the description of pushGLStates to get a detailed
/// description of these functions. /// description of these functions.
/// ///
/// \see PushGLStates /// \see pushGLStates
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void PopGLStates(); void popGLStates();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Reset the internal OpenGL states so that the target is ready for drawing /// \brief Reset the internal OpenGL states so that the target is ready for drawing
/// ///
/// This function can be used when you mix SFML drawing /// This function can be used when you mix SFML drawing
/// and direct OpenGL rendering, if you choose not to use /// and direct OpenGL rendering, if you choose not to use
/// PushGLStates/PopGLStates. It makes sure that all OpenGL /// pushGLStates/popGLStates. It makes sure that all OpenGL
/// states needed by SFML are set, so that subsequent Draw() /// states needed by SFML are set, so that subsequent draw()
/// calls will work as expected. /// calls will work as expected.
/// ///
/// Example: /// Example:
/// \code /// \code
/// // OpenGL code here... /// // OpenGL code here...
/// glPushAttrib(...); /// glPushAttrib(...);
/// window.ResetGLStates(); /// window.resetGLStates();
/// window.Draw(...); /// window.draw(...);
/// window.Draw(...); /// window.draw(...);
/// glPopAttrib(...); /// glPopAttrib(...);
/// // OpenGL code here... /// // OpenGL code here...
/// \endcode /// \endcode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ResetGLStates(); void resetGLStates();
protected : protected :
@ -292,13 +290,13 @@ protected :
/// target is created and ready for drawing. /// target is created and ready for drawing.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Initialize(); void initialize();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Apply the current view /// \brief Apply the current view
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ApplyCurrentView(); void applyCurrentView();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Apply a new blending mode /// \brief Apply a new blending mode
@ -306,7 +304,7 @@ protected :
/// \param mode Blending mode to apply /// \param mode Blending mode to apply
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ApplyBlendMode(BlendMode mode); void applyBlendMode(BlendMode mode);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Apply a new transform /// \brief Apply a new transform
@ -314,7 +312,7 @@ protected :
/// \param transform Transform to apply /// \param transform Transform to apply
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ApplyTransform(const Transform& transform); void applyTransform(const Transform& transform);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Apply a new texture /// \brief Apply a new texture
@ -322,7 +320,7 @@ protected :
/// \param texture Texture to apply /// \param texture Texture to apply
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ApplyTexture(const Texture* texture); void applyTexture(const Texture* texture);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Apply a new shader /// \brief Apply a new shader
@ -330,7 +328,7 @@ protected :
/// \param shader Shader to apply /// \param shader Shader to apply
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ApplyShader(const Shader* shader); void applyShader(const Shader* shader);
private : private :
@ -346,7 +344,7 @@ private :
/// \return True if the function succeeded /// \return True if the function succeeded
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool Activate(bool active) = 0; virtual bool activate(bool active) = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Render states cache /// \brief Render states cache
@ -356,11 +354,11 @@ private :
{ {
enum {VertexCacheSize = 4}; enum {VertexCacheSize = 4};
bool ViewChanged; ///< Has the current view changed since last draw? bool viewChanged; ///< Has the current view changed since last draw?
BlendMode LastBlendMode; ///< Cached blending mode BlendMode lastBlendMode; ///< Cached blending mode
Uint64 LastTextureId; ///< Cached texture Uint64 lastTextureId; ///< Cached texture
bool UseVertexCache; ///< Did we previously use the vertex cache? bool useVertexCache; ///< Did we previously use the vertex cache?
Vertex VertexCache[VertexCacheSize]; ///< Pre-transformed vertices cache Vertex vertexCache[VertexCacheSize]; ///< Pre-transformed vertices cache
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -397,7 +395,7 @@ private :
/// OpenGL stuff. It is even possible to mix together OpenGL calls /// OpenGL stuff. It is even possible to mix together OpenGL calls
/// and regular SFML drawing commands. When doing so, make sure that /// and regular SFML drawing commands. When doing so, make sure that
/// OpenGL states are not messed up by calling the /// OpenGL states are not messed up by calling the
/// PushGLStates/PopGLStates functions. /// pushGLStates/popGLStates functions.
/// ///
/// \see sf::RenderWindow, sf::RenderTexture, sf::View /// \see sf::RenderWindow, sf::RenderTexture, sf::View
/// ///

50
include/SFML/Graphics/RenderTexture.hpp
View file

@ -52,9 +52,9 @@ public :
/// \brief Default constructor /// \brief Default constructor
/// ///
/// Constructs an empty, invalid render-texture. You must /// Constructs an empty, invalid render-texture. You must
/// call Create to have a valid render-texture. /// call create to have a valid render-texture.
/// ///
/// \see Create /// \see create
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
RenderTexture(); RenderTexture();
@ -83,30 +83,30 @@ public :
/// \return True if creation has been successful /// \return True if creation has been successful
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Create(unsigned int width, unsigned int height, bool depthBuffer = false); bool create(unsigned int width, unsigned int height, bool depthBuffer = false);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Enable or disable texture smoothing /// \brief Enable or disable texture smoothing
/// ///
/// This function is similar to Texture::SetSmooth. /// This function is similar to Texture::setSmooth.
/// This parameter is disabled by default. /// This parameter is disabled by default.
/// ///
/// \param smooth True to enable smoothing, false to disable it /// \param smooth True to enable smoothing, false to disable it
/// ///
/// \see IsSmooth /// \see isSmooth
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetSmooth(bool smooth); void setSmooth(bool smooth);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether the smooth filtering is enabled or not /// \brief Tell whether the smooth filtering is enabled or not
/// ///
/// \return True if texture smoothing is enabled /// \return True if texture smoothing is enabled
/// ///
/// \see SetSmooth /// \see setSmooth
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsSmooth() const; bool isSmooth() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Activate of deactivate the render-texture for rendering /// \brief Activate of deactivate the render-texture for rendering
@ -123,7 +123,7 @@ public :
/// \return True if operation was successful, false otherwise /// \return True if operation was successful, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SetActive(bool active = true); bool setActive(bool active = true);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the contents of the target texture /// \brief Update the contents of the target texture
@ -134,18 +134,18 @@ public :
/// it may leave the texture in an undefined state. /// it may leave the texture in an undefined state.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Display(); void display();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the size of the rendering region of the texture /// \brief Return the size of the rendering region of the texture
/// ///
/// The returned value is the size that you passed to /// The returned value is the size that you passed to
/// the Create function. /// the create function.
/// ///
/// \return Size in pixels /// \return Size in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2u GetSize() const; virtual Vector2u getSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a read-only reference to the target texture /// \brief Get a read-only reference to the target texture
@ -161,7 +161,7 @@ public :
/// \return Const reference to the texture /// \return Const reference to the texture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Texture& GetTexture() const; const Texture& getTexture() const;
private : private :
@ -176,7 +176,7 @@ private :
/// \return True if the function succeeded /// \return True if the function succeeded
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool Activate(bool active); virtual bool activate(bool active);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -215,35 +215,35 @@ private :
/// ///
/// // Create a new render-texture /// // Create a new render-texture
/// sf::RenderTexture texture; /// sf::RenderTexture texture;
/// if (!texture.Create(500, 500)) /// if (!texture.create(500, 500))
/// return -1 /// return -1
/// ///
/// // The main loop /// // The main loop
/// while (window.IsOpen()) /// while (window.isOpen())
/// { /// {
/// // Event processing /// // Event processing
/// // ... /// // ...
/// ///
/// // Clear the whole texture with red color /// // Clear the whole texture with red color
/// texture.Clear(sf::Color::Red); /// texture.clear(sf::Color::Red);
/// ///
/// // Draw stuff to the texture /// // Draw stuff to the texture
/// texture.Draw(sprite); // sprite is a sf::Sprite /// texture.draw(sprite); // sprite is a sf::Sprite
/// texture.Draw(shape); // shape is a sf::Shape /// texture.draw(shape); // shape is a sf::Shape
/// texture.Draw(text); // text is a sf::Text /// texture.draw(text); // text is a sf::Text
/// ///
/// // We're done drawing to the texture /// // We're done drawing to the texture
/// texture.Display(); /// texture.display();
/// ///
/// // Now we start rendering to the window, clear it first /// // Now we start rendering to the window, clear it first
/// window.Clear(); /// window.clear();
/// ///
/// // Draw the texture /// // Draw the texture
/// sf::Sprite sprite(texture.GetTexture()); /// sf::Sprite sprite(texture.getTexture());
/// window.Draw(sprite); /// window.draw(sprite);
/// ///
/// // End the current frame and display its contents on screen /// // End the current frame and display its contents on screen
/// window.Display(); /// window.display();
/// } /// }
/// \endcode /// \endcode
/// ///

48
include/SFML/Graphics/RenderWindow.hpp
View file

@ -109,7 +109,7 @@ public :
/// \return Size in pixels /// \return Size in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2u GetSize() const; virtual Vector2u getSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Copy the current contents of the window to an image /// \brief Copy the current contents of the window to an image
@ -118,14 +118,14 @@ public :
/// screenshots of the application. If you want to update an /// screenshots of the application. If you want to update an
/// image with the contents of the window and then use it for /// image with the contents of the window and then use it for
/// drawing, you should rather use a sf::Texture and its /// drawing, you should rather use a sf::Texture and its
/// Update(Window&) function. /// update(Window&) function.
/// You can also draw things directly to a texture with the /// You can also draw things directly to a texture with the
/// sf::RenderTexture class. /// sf::RenderTexture class.
/// ///
/// \return Image containing the captured contents /// \return Image containing the captured contents
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Image Capture() const; Image capture() const;
private : private :
@ -137,7 +137,7 @@ private :
/// the window is created. /// the window is created.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnCreate(); virtual void onCreate();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Function called after the window has been resized /// \brief Function called after the window has been resized
@ -146,7 +146,7 @@ private :
/// perform custom actions when the size of the window changes. /// perform custom actions when the size of the window changes.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnResize(); virtual void onResize();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Activate the target for rendering /// \brief Activate the target for rendering
@ -156,7 +156,7 @@ private :
/// \return True if the function succeeded /// \return True if the function succeeded
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual bool Activate(bool active); virtual bool activate(bool active);
}; };
} // namespace sf } // namespace sf
@ -188,30 +188,30 @@ private :
/// sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window"); /// sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window");
/// ///
/// // Limit the framerate to 60 frames per second (this step is optional) /// // Limit the framerate to 60 frames per second (this step is optional)
/// window.SetFramerateLimit(60); /// window.setFramerateLimit(60);
/// ///
/// // The main loop - ends as soon as the window is closed /// // The main loop - ends as soon as the window is closed
/// while (window.IsOpen()) /// while (window.isOpen())
/// { /// {
/// // Event processing /// // Event processing
/// sf::Event event; /// sf::Event event;
/// while (window.PollEvent(event)) /// while (window.pollEvent(event))
/// { /// {
/// // Request for closing the window /// // Request for closing the window
/// if (event.Type == sf::Event::Closed) /// if (event.type == sf::Event::Closed)
/// window.Close(); /// window.close();
/// } /// }
/// ///
/// // Clear the whole window before rendering a new frame /// // Clear the whole window before rendering a new frame
/// window.Clear(); /// window.clear();
/// ///
/// // Draw some graphical entities /// // Draw some graphical entities
/// window.Draw(sprite); /// window.draw(sprite);
/// window.Draw(circle); /// window.draw(circle);
/// window.Draw(text); /// window.draw(text);
/// ///
/// // End the current frame and display its contents on screen /// // End the current frame and display its contents on screen
/// window.Display(); /// window.display();
/// } /// }
/// \endcode /// \endcode
/// ///
@ -233,15 +233,15 @@ private :
/// ... /// ...
/// ///
/// // Start the rendering loop /// // Start the rendering loop
/// while (window.IsOpen()) /// while (window.isOpen())
/// { /// {
/// // Process events /// // Process events
/// ... /// ...
/// ///
/// // Draw a background sprite /// // Draw a background sprite
/// window.PushGLStates(); /// window.pushGLStates();
/// window.Draw(sprite); /// window.draw(sprite);
/// window.PopGLStates(); /// window.popGLStates();
/// ///
/// // Draw a 3D object using OpenGL /// // Draw a 3D object using OpenGL
/// glBegin(GL_QUADS); /// glBegin(GL_QUADS);
@ -250,12 +250,12 @@ private :
/// glEnd(); /// glEnd();
/// ///
/// // Draw text on top of the 3D object /// // Draw text on top of the 3D object
/// window.PushGLStates(); /// window.pushGLStates();
/// window.Draw(text); /// window.draw(text);
/// window.PopGLStates(); /// window.popGLStates();
/// ///
/// // Finally, display the rendered frame on screen /// // Finally, display the rendered frame on screen
/// window.Display(); /// window.display();
/// } /// }
/// \endcode /// \endcode
/// ///

114
include/SFML/Graphics/Shader.hpp
View file

@ -63,7 +63,7 @@ public :
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Special type/value that can be passed to SetParameter, /// \brief Special type/value that can be passed to setParameter,
/// and that represents the texture of the object being drawn /// and that represents the texture of the object being drawn
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -102,10 +102,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromMemory, LoadFromStream /// \see loadFromMemory, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromFile(const std::string& filename, Type type); bool loadFromFile(const std::string& filename, Type type);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load both the vertex and fragment shaders from files /// \brief Load both the vertex and fragment shaders from files
@ -123,10 +123,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromMemory, LoadFromStream /// \see loadFromMemory, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromFile(const std::string& vertexShaderFilename, const std::string& fragmentShaderFilename); bool loadFromFile(const std::string& vertexShaderFilename, const std::string& fragmentShaderFilename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load either the vertex or fragment shader from a source code in memory /// \brief Load either the vertex or fragment shader from a source code in memory
@ -143,10 +143,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromStream /// \see loadFromFile, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromMemory(const std::string& shader, Type type); bool loadFromMemory(const std::string& shader, Type type);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load both the vertex and fragment shaders from source codes in memory /// \brief Load both the vertex and fragment shaders from source codes in memory
@ -164,10 +164,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromStream /// \see loadFromFile, loadFromStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromMemory(const std::string& vertexShader, const std::string& fragmentShader); bool loadFromMemory(const std::string& vertexShader, const std::string& fragmentShader);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load either the vertex or fragment shader from a custom stream /// \brief Load either the vertex or fragment shader from a custom stream
@ -184,10 +184,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromMemory /// \see loadFromFile, loadFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromStream(InputStream& stream, Type type); bool loadFromStream(InputStream& stream, Type type);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load both the vertex and fragment shaders from custom streams /// \brief Load both the vertex and fragment shaders from custom streams
@ -205,10 +205,10 @@ public :
/// ///
/// \return True if loading succeeded, false if it failed /// \return True if loading succeeded, false if it failed
/// ///
/// \see LoadFromFile, LoadFromMemory /// \see loadFromFile, loadFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromStream(InputStream& vertexShaderStream, InputStream& fragmentShaderStream); bool loadFromStream(InputStream& vertexShaderStream, InputStream& fragmentShaderStream);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a float parameter of the shader /// \brief Change a float parameter of the shader
@ -222,14 +222,14 @@ public :
/// uniform float myparam; // this is the variable in the shader /// uniform float myparam; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("myparam", 5.2f); /// shader.setParameter("myparam", 5.2f);
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
/// \param x Value to assign /// \param x Value to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, float x); void setParameter(const std::string& name, float x);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a 2-components vector parameter of the shader /// \brief Change a 2-components vector parameter of the shader
@ -243,7 +243,7 @@ public :
/// uniform vec2 myparam; // this is the variable in the shader /// uniform vec2 myparam; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("myparam", 5.2f, 6.0f); /// shader.setParameter("myparam", 5.2f, 6.0f);
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
@ -251,7 +251,7 @@ public :
/// \param y Second component of the value to assign /// \param y Second component of the value to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, float x, float y); void setParameter(const std::string& name, float x, float y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a 3-components vector parameter of the shader /// \brief Change a 3-components vector parameter of the shader
@ -265,7 +265,7 @@ public :
/// uniform vec3 myparam; // this is the variable in the shader /// uniform vec3 myparam; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("myparam", 5.2f, 6.0f, -8.1f); /// shader.setParameter("myparam", 5.2f, 6.0f, -8.1f);
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
@ -274,7 +274,7 @@ public :
/// \param z Third component of the value to assign /// \param z Third component of the value to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, float x, float y, float z); void setParameter(const std::string& name, float x, float y, float z);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a 4-components vector parameter of the shader /// \brief Change a 4-components vector parameter of the shader
@ -288,7 +288,7 @@ public :
/// uniform vec4 myparam; // this is the variable in the shader /// uniform vec4 myparam; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("myparam", 5.2f, 6.0f, -8.1f, 0.4f); /// shader.setParameter("myparam", 5.2f, 6.0f, -8.1f, 0.4f);
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
@ -298,7 +298,7 @@ public :
/// \param w Fourth component of the value to assign /// \param w Fourth component of the value to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, float x, float y, float z, float w); void setParameter(const std::string& name, float x, float y, float z, float w);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a 2-components vector parameter of the shader /// \brief Change a 2-components vector parameter of the shader
@ -312,14 +312,14 @@ public :
/// uniform vec2 myparam; // this is the variable in the shader /// uniform vec2 myparam; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("myparam", sf::Vector2f(5.2f, 6.0f)); /// shader.setParameter("myparam", sf::Vector2f(5.2f, 6.0f));
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
/// \param vector Vector to assign /// \param vector Vector to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, const Vector2f& vector); void setParameter(const std::string& name, const Vector2f& vector);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a 3-components vector parameter of the shader /// \brief Change a 3-components vector parameter of the shader
@ -333,14 +333,14 @@ public :
/// uniform vec3 myparam; // this is the variable in the shader /// uniform vec3 myparam; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("myparam", sf::Vector3f(5.2f, 6.0f, -8.1f)); /// shader.setParameter("myparam", sf::Vector3f(5.2f, 6.0f, -8.1f));
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
/// \param vector Vector to assign /// \param vector Vector to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, const Vector3f& vector); void setParameter(const std::string& name, const Vector3f& vector);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a color parameter of the shader /// \brief Change a color parameter of the shader
@ -360,14 +360,14 @@ public :
/// uniform vec4 color; // this is the variable in the shader /// uniform vec4 color; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("color", sf::Color(255, 128, 0, 255)); /// shader.setParameter("color", sf::Color(255, 128, 0, 255));
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
/// \param color Color to assign /// \param color Color to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, const Color& color); void setParameter(const std::string& name, const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a matrix parameter of the shader /// \brief Change a matrix parameter of the shader
@ -383,14 +383,14 @@ public :
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Translate(5, 10); /// transform.Translate(5, 10);
/// shader.SetParameter("matrix", transform); /// shader.setParameter("matrix", transform);
/// \endcode /// \endcode
/// ///
/// \param name Name of the parameter in the shader /// \param name Name of the parameter in the shader
/// \param transform Transform to assign /// \param transform Transform to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, const sf::Transform& transform); void setParameter(const std::string& name, const sf::Transform& transform);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a texture parameter of the shader /// \brief Change a texture parameter of the shader
@ -406,7 +406,7 @@ public :
/// \code /// \code
/// sf::Texture texture; /// sf::Texture texture;
/// ... /// ...
/// shader.SetParameter("the_texture", texture); /// shader.setParameter("the_texture", texture);
/// \endcode /// \endcode
/// It is important to note that \a texture must remain alive as long /// It is important to note that \a texture must remain alive as long
/// as the shader uses it, no copy is made internally. /// as the shader uses it, no copy is made internally.
@ -415,14 +415,14 @@ public :
/// known in advance, you can pass the special value /// known in advance, you can pass the special value
/// sf::Shader::CurrentTexture: /// sf::Shader::CurrentTexture:
/// \code /// \code
/// shader.SetParameter("the_texture", sf::Shader::CurrentTexture). /// shader.setParameter("the_texture", sf::Shader::CurrentTexture).
/// \endcode /// \endcode
/// ///
/// \param name Name of the texture in the shader /// \param name Name of the texture in the shader
/// \param texture Texture to assign /// \param texture Texture to assign
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, const Texture& texture); void setParameter(const std::string& name, const Texture& texture);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change a texture parameter of the shader /// \brief Change a texture parameter of the shader
@ -439,13 +439,13 @@ public :
/// uniform sampler2D current; // this is the variable in the shader /// uniform sampler2D current; // this is the variable in the shader
/// \endcode /// \endcode
/// \code /// \code
/// shader.SetParameter("current", sf::Shader::CurrentTexture); /// shader.setParameter("current", sf::Shader::CurrentTexture);
/// \endcode /// \endcode
/// ///
/// \param name Name of the texture in the shader /// \param name Name of the texture in the shader
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetParameter(const std::string& name, CurrentTextureType); void setParameter(const std::string& name, CurrentTextureType);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Bind the shader for rendering (activate it) /// \brief Bind the shader for rendering (activate it)
@ -454,16 +454,16 @@ public :
/// you want to use the shader with a custom OpenGL rendering /// you want to use the shader with a custom OpenGL rendering
/// instead of a SFML drawable. /// instead of a SFML drawable.
/// \code /// \code
/// window.SetActive(); /// window.setActive();
/// shader.Bind(); /// shader.bind();
/// ... render OpenGL geometry ... /// ... render OpenGL geometry ...
/// shader.Unbind(); /// shader.unbind();
/// \endcode /// \endcode
/// ///
/// \see Unbind /// \see unbind
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Bind() const; void bind() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Unbind the shader (deactivate it) /// \brief Unbind the shader (deactivate it)
@ -472,10 +472,10 @@ public :
/// you want to use the shader with a custom OpenGL rendering /// you want to use the shader with a custom OpenGL rendering
/// instead of a SFML drawable. /// instead of a SFML drawable.
/// ///
/// \see Bind /// \see bind
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Unbind() const; void unbind() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether or not the system supports shaders /// \brief Tell whether or not the system supports shaders
@ -487,7 +487,7 @@ public :
/// \return True if shaders are supported, false otherwise /// \return True if shaders are supported, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsAvailable(); static bool isAvailable();
private : private :
@ -503,7 +503,7 @@ private :
/// \return True on success, false if any error happened /// \return True on success, false if any error happened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Compile(const char* vertexShaderCode, const char* fragmentShaderCode); bool compile(const char* vertexShaderCode, const char* fragmentShaderCode);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Bind all the textures used by the shader /// \brief Bind all the textures used by the shader
@ -512,7 +512,7 @@ private :
/// updates the corresponding variables in the shader accordingly. /// updates the corresponding variables in the shader accordingly.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void BindTextures() const; void bindTextures() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Types // Types
@ -563,13 +563,13 @@ private :
/// \li transforms (matrices) /// \li transforms (matrices)
/// ///
/// The value of the variables can be changed at any time /// The value of the variables can be changed at any time
/// with either the various overloads of the SetParameter function: /// with either the various overloads of the setParameter function:
/// \code /// \code
/// shader.SetParameter("offset", 2.f); /// shader.setParameter("offset", 2.f);
/// shader.SetParameter("color", 0.5f, 0.8f, 0.3f); /// shader.setParameter("color", 0.5f, 0.8f, 0.3f);
/// shader.SetParameter("matrix", transform); // transform is a sf::Transform /// shader.setParameter("matrix", transform); // transform is a sf::Transform
/// shader.SetParameter("overlay", texture); // texture is a sf::Texture /// shader.setParameter("overlay", texture); // texture is a sf::Texture
/// shader.SetParameter("texture", sf::Shader::CurrentTexture); /// shader.setParameter("texture", sf::Shader::CurrentTexture);
/// \endcode /// \endcode
/// ///
/// The special Shader::CurrentTexture argument maps the /// The special Shader::CurrentTexture argument maps the
@ -579,14 +579,14 @@ private :
/// To apply a shader to a drawable, you must pass it as an /// To apply a shader to a drawable, you must pass it as an
/// additional parameter to the Draw function: /// additional parameter to the Draw function:
/// \code /// \code
/// window.Draw(sprite, shader); /// window.draw(sprite, shader);
/// \endcode /// \endcode
/// ///
/// ... which is in fact just a shortcut for this: /// ... which is in fact just a shortcut for this:
/// \code /// \code
/// sf::RenderStates states; /// sf::RenderStates states;
/// states.Shader = shader; /// states.shader = shader;
/// window.Draw(sprite, states); /// window.draw(sprite, states);
/// \endcode /// \endcode
/// ///
/// Shaders can be used on any drawable, but some combinations are /// Shaders can be used on any drawable, but some combinations are
@ -605,7 +605,7 @@ private :
/// \li draw everything to a sf::RenderTexture, then draw it to /// \li draw everything to a sf::RenderTexture, then draw it to
/// the main target using the shader /// the main target using the shader
/// \li draw everything directly to the main target, then use /// \li draw everything directly to the main target, then use
/// sf::Texture::Update(Window&) to copy its contents to a texture /// sf::Texture::update(Window&) to copy its contents to a texture
/// and draw it to the main target using the shader /// and draw it to the main target using the shader
/// ///
/// The first technique is more optimized because it doesn't involve /// The first technique is more optimized because it doesn't involve
@ -617,10 +617,10 @@ private :
/// sf::Shader can also be used directly as a raw shader for /// sf::Shader can also be used directly as a raw shader for
/// custom OpenGL geometry. /// custom OpenGL geometry.
/// \code /// \code
/// window.SetActive(); /// window.setActive();
/// shader.Bind(); /// shader.bind();
/// ... render OpenGL geometry ... /// ... render OpenGL geometry ...
/// shader.Unbind(); /// shader.unbind();
/// \endcode /// \endcode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

70
include/SFML/Graphics/Shape.hpp
View file

@ -68,10 +68,10 @@ public :
/// \param texture New texture /// \param texture New texture
/// \param resetRect Should the texture rect be reset to the size of the new texture? /// \param resetRect Should the texture rect be reset to the size of the new texture?
/// ///
/// \see GetTexture, SetTextureRect /// \see getTexture, setTextureRect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetTexture(const Texture* texture, bool resetRect = false); void setTexture(const Texture* texture, bool resetRect = false);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the sub-rectangle of the texture that the shape will display /// \brief Set the sub-rectangle of the texture that the shape will display
@ -82,10 +82,10 @@ public :
/// ///
/// \param rect Rectangle defining the region of the texture to display /// \param rect Rectangle defining the region of the texture to display
/// ///
/// \see GetTextureRect, SetTexture /// \see getTextureRect, setTexture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetTextureRect(const IntRect& rect); void setTextureRect(const IntRect& rect);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the fill color of the shape /// \brief Set the fill color of the shape
@ -99,10 +99,10 @@ public :
/// ///
/// \param color New color of the shape /// \param color New color of the shape
/// ///
/// \see GetFillColor, SetOutlineColor /// \see getFillColor, setOutlineColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetFillColor(const Color& color); void setFillColor(const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the outline color of the shape /// \brief Set the outline color of the shape
@ -112,10 +112,10 @@ public :
/// ///
/// \param color New outline color of the shape /// \param color New outline color of the shape
/// ///
/// \see GetOutlineColor, SetFillColor /// \see getOutlineColor, setFillColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetOutlineColor(const Color& color); void setOutlineColor(const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the thickness of the shape's outline /// \brief Set the thickness of the shape's outline
@ -126,10 +126,10 @@ public :
/// ///
/// \param thickness New outline thickness /// \param thickness New outline thickness
/// ///
/// \see GetOutlineThickness /// \see getOutlineThickness
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetOutlineThickness(float thickness); void setOutlineThickness(float thickness);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the source texture of the shape /// \brief Get the source texture of the shape
@ -140,58 +140,60 @@ public :
/// ///
/// \return Pointer to the shape's texture /// \return Pointer to the shape's texture
/// ///
/// \see SetTexture /// \see setTexture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Texture* GetTexture() const; const Texture* getTexture() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the sub-rectangle of the texture displayed by the shape /// \brief Get the sub-rectangle of the texture displayed by the shape
/// ///
/// \return Texture rectangle of the shape /// \return Texture rectangle of the shape
/// ///
/// \see SetTextureRect /// \see setTextureRect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const IntRect& GetTextureRect() const; const IntRect& getTextureRect() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the fill color of the shape /// \brief Get the fill color of the shape
/// ///
/// \return Fill color of the shape /// \return Fill color of the shape
/// ///
/// \see SetFillColor /// \see setFillColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Color& GetFillColor() const; const Color& getFillColor() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the outline color of the shape /// \brief Get the outline color of the shape
/// ///
/// \return Outline color of the shape /// \return Outline color of the shape
/// ///
/// \see SetOutlineColor /// \see setOutlineColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Color& GetOutlineColor() const; const Color& getOutlineColor() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the outline thickness of the shape /// \brief Get the outline thickness of the shape
/// ///
/// \return Outline thickness of the shape /// \return Outline thickness of the shape
/// ///
/// \see SetOutlineThickness /// \see setOutlineThickness
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetOutlineThickness() const; float getOutlineThickness() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the total number of points of the shape /// \brief Get the total number of points of the shape
/// ///
/// \return Number of points of the shape /// \return Number of points of the shape
/// ///
/// \see getPoint
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual unsigned int GetPointCount() const = 0; virtual unsigned int getPointCount() const = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a point of the shape /// \brief Get a point of the shape
@ -202,8 +204,10 @@ public :
/// ///
/// \return Index-th point of the shape /// \return Index-th point of the shape
/// ///
/// \see getPointCount
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2f GetPoint(unsigned int index) const = 0; virtual Vector2f getPoint(unsigned int index) const = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the local bounding rectangle of the entity /// \brief Get the local bounding rectangle of the entity
@ -217,7 +221,7 @@ public :
/// \return Local bounding rectangle of the entity /// \return Local bounding rectangle of the entity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetLocalBounds() const; FloatRect getLocalBounds() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the global bounding rectangle of the entity /// \brief Get the global bounding rectangle of the entity
@ -231,7 +235,7 @@ public :
/// \return Global bounding rectangle of the entity /// \return Global bounding rectangle of the entity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetGlobalBounds() const; FloatRect getGlobalBounds() const;
protected : protected :
@ -246,10 +250,10 @@ protected :
/// ///
/// This function must be called by the derived class everytime /// This function must be called by the derived class everytime
/// the shape's points change (ie. the result of either /// the shape's points change (ie. the result of either
/// GetPointCount or GetPoint is different). /// getPointCount or getPoint is different).
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(); void update();
private : private :
@ -260,31 +264,31 @@ private :
/// \param states Current render states /// \param states Current render states
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void Draw(RenderTarget& target, RenderStates states) const; virtual void draw(RenderTarget& target, RenderStates states) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the fill vertices' color /// \brief Update the fill vertices' color
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdateFillColors(); void updateFillColors();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the fill vertices' texture coordinates /// \brief Update the fill vertices' texture coordinates
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdateTexCoords(); void updateTexCoords();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the outline vertices' position /// \brief Update the outline vertices' position
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdateOutline(); void updateOutline();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the outline vertices' color /// \brief Update the outline vertices' color
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdateOutlineColors(); void updateOutlineColors();
private : private :
@ -333,8 +337,8 @@ private :
/// ///
/// You can write your own derived shape class, there are only /// You can write your own derived shape class, there are only
/// two virtual functions to override: /// two virtual functions to override:
/// \li GetOutlinePointCount must return the number of points of the shape /// \li getPointCount must return the number of points of the shape
/// \li GetOutlinePoint must return the points of the shape /// \li getPoint must return the points of the shape
/// ///
/// \see sf::RectangleShape, sf::CircleShape, sf::ConvexShape, sf::Transformable /// \see sf::RectangleShape, sf::CircleShape, sf::ConvexShape, sf::Transformable
/// ///

50
include/SFML/Graphics/Sprite.hpp
View file

@ -61,7 +61,7 @@ public :
/// ///
/// \param texture Source texture /// \param texture Source texture
/// ///
/// \see SetTexture /// \see setTexture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
explicit Sprite(const Texture& texture); explicit Sprite(const Texture& texture);
@ -72,7 +72,7 @@ public :
/// \param texture Source texture /// \param texture Source texture
/// \param rectangle Sub-rectangle of the texture to assign to the sprite /// \param rectangle Sub-rectangle of the texture to assign to the sprite
/// ///
/// \see SetTexture, SetTextureRect /// \see setTexture, setTextureRect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Sprite(const Texture& texture, const IntRect& rectangle); Sprite(const Texture& texture, const IntRect& rectangle);
@ -93,10 +93,10 @@ public :
/// \param texture New texture /// \param texture New texture
/// \param resetRect Should the texture rect be reset to the size of the new texture? /// \param resetRect Should the texture rect be reset to the size of the new texture?
/// ///
/// \see GetTexture, SetTextureRect /// \see getTexture, setTextureRect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetTexture(const Texture& texture, bool resetRect = false); void setTexture(const Texture& texture, bool resetRect = false);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the sub-rectangle of the texture that the sprite will display /// \brief Set the sub-rectangle of the texture that the sprite will display
@ -107,10 +107,10 @@ public :
/// ///
/// \param rectangle Rectangle defining the region of the texture to display /// \param rectangle Rectangle defining the region of the texture to display
/// ///
/// \see GetTextureRect, SetTexture /// \see getTextureRect, setTexture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetTextureRect(const IntRect& rectangle); void setTextureRect(const IntRect& rectangle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the global color of the sprite /// \brief Set the global color of the sprite
@ -122,10 +122,10 @@ public :
/// ///
/// \param color New color of the sprite /// \param color New color of the sprite
/// ///
/// \see GetColor /// \see getColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetColor(const Color& color); void setColor(const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the source texture of the sprite /// \brief Get the source texture of the sprite
@ -136,30 +136,30 @@ public :
/// ///
/// \return Pointer to the sprite's texture /// \return Pointer to the sprite's texture
/// ///
/// \see SetTexture /// \see setTexture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Texture* GetTexture() const; const Texture* getTexture() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the sub-rectangle of the texture displayed by the sprite /// \brief Get the sub-rectangle of the texture displayed by the sprite
/// ///
/// \return Texture rectangle of the sprite /// \return Texture rectangle of the sprite
/// ///
/// \see SetTextureRect /// \see setTextureRect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const IntRect& GetTextureRect() const; const IntRect& getTextureRect() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the global color of the sprite /// \brief Get the global color of the sprite
/// ///
/// \return Global color of the sprite /// \return Global color of the sprite
/// ///
/// \see SetColor /// \see setColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Color& GetColor() const; const Color& getColor() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the local bounding rectangle of the entity /// \brief Get the local bounding rectangle of the entity
@ -173,7 +173,7 @@ public :
/// \return Local bounding rectangle of the entity /// \return Local bounding rectangle of the entity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetLocalBounds() const; FloatRect getLocalBounds() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the global bounding rectangle of the entity /// \brief Get the global bounding rectangle of the entity
@ -187,7 +187,7 @@ public :
/// \return Global bounding rectangle of the entity /// \return Global bounding rectangle of the entity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetGlobalBounds() const; FloatRect getGlobalBounds() const;
private : private :
@ -198,19 +198,19 @@ private :
/// \param states Current render states /// \param states Current render states
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void Draw(RenderTarget& target, RenderStates states) const; virtual void draw(RenderTarget& target, RenderStates states) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the vertices' positions /// \brief Update the vertices' positions
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdatePositions(); void updatePositions();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the vertices' texture coordinates /// \brief Update the vertices' texture coordinates
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdateTexCoords(); void updateTexCoords();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -259,17 +259,17 @@ private :
/// \code /// \code
/// // Declare and load a texture /// // Declare and load a texture
/// sf::Texture texture; /// sf::Texture texture;
/// texture.LoadFromFile("texture.png"); /// texture.loadFromFile("texture.png");
/// ///
/// // Create a sprite /// // Create a sprite
/// sf::Sprite sprite; /// sf::Sprite sprite;
/// sprite.SetTexture(texture); /// sprite.setTexture(texture);
/// sprite.SetTextureRect(sf::IntRect(10, 10, 50, 30)); /// sprite.setTextureRect(sf::IntRect(10, 10, 50, 30));
/// sprite.SetColor(sf::Color(255, 255, 255, 200)); /// sprite.setColor(sf::Color(255, 255, 255, 200));
/// sprite.SetPosition(100, 25); /// sprite.setPosition(100, 25);
/// ///
/// // Draw it /// // Draw it
/// window.Draw(sprite); /// window.draw(sprite);
/// \endcode /// \endcode
/// ///
/// \see sf::Texture, sf::Transformable /// \see sf::Texture, sf::Transformable

72
include/SFML/Graphics/Text.hpp
View file

@ -77,7 +77,7 @@ public :
/// \param characterSize Base size of characters, in pixels /// \param characterSize Base size of characters, in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
explicit Text(const String& string, const Font& font = Font::GetDefaultFont(), unsigned int characterSize = 30); explicit Text(const String& string, const Font& font = Font::getDefaultFont(), unsigned int characterSize = 30);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the text's string /// \brief Set the text's string
@ -95,10 +95,10 @@ public :
/// ///
/// \param string New string /// \param string New string
/// ///
/// \see GetString /// \see getString
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetString(const String& string); void setString(const String& string);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the text's font /// \brief Set the text's font
@ -110,14 +110,14 @@ public :
/// If the font is destroyed and the text tries to /// If the font is destroyed and the text tries to
/// use it, the behaviour is undefined. /// use it, the behaviour is undefined.
/// Texts have a valid font by default, which the built-in /// Texts have a valid font by default, which the built-in
/// Font::GetDefaultFont(). /// Font::getDefaultFont().
/// ///
/// \param font New font /// \param font New font
/// ///
/// \see GetFont /// \see getFont
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetFont(const Font& font); void setFont(const Font& font);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the character size /// \brief Set the character size
@ -126,10 +126,10 @@ public :
/// ///
/// \param size New character size, in pixels /// \param size New character size, in pixels
/// ///
/// \see GetCharacterSize /// \see getCharacterSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetCharacterSize(unsigned int size); void setCharacterSize(unsigned int size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the text's style /// \brief Set the text's style
@ -140,10 +140,10 @@ public :
/// ///
/// \param style New style /// \param style New style
/// ///
/// \see GetStyle /// \see getStyle
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetStyle(Uint32 style); void setStyle(Uint32 style);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the global color of the text /// \brief Set the global color of the text
@ -152,10 +152,10 @@ public :
/// ///
/// \param color New color of the text /// \param color New color of the text
/// ///
/// \see GetColor /// \see getColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetColor(const Color& color); void setColor(const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the text's string /// \brief Get the text's string
@ -164,17 +164,17 @@ public :
/// be converted to standard string types. So, the following /// be converted to standard string types. So, the following
/// lines of code are all valid: /// lines of code are all valid:
/// \code /// \code
/// sf::String s1 = text.GetString(); /// sf::String s1 = text.getString();
/// std::string s2 = text.GetString(); /// std::string s2 = text.getString();
/// std::wstring s3 = text.GetString(); /// std::wstring s3 = text.getString();
/// \endcode /// \endcode
/// ///
/// \return Text's string /// \return Text's string
/// ///
/// \see GetString /// \see setString
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const String& GetString() const; const String& getString() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the text's font /// \brief Get the text's font
@ -184,40 +184,40 @@ public :
/// ///
/// \return Text's font /// \return Text's font
/// ///
/// \see SetFont /// \see setFont
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Font& GetFont() const; const Font& getFont() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the character size /// \brief Get the character size
/// ///
/// \return Size of the characters, in pixels /// \return Size of the characters, in pixels
/// ///
/// \see SetCharacterSize /// \see setCharacterSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetCharacterSize() const; unsigned int getCharacterSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the text's style /// \brief Get the text's style
/// ///
/// \return Text's style /// \return Text's style
/// ///
/// \see SetStyle /// \see setStyle
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Uint32 GetStyle() const; Uint32 getStyle() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the global color of the text /// \brief Get the global color of the text
/// ///
/// \return Global color of the text /// \return Global color of the text
/// ///
/// \see SetColor /// \see setColor
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Color& GetColor() const; const Color& getColor() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the position of the \a index-th character /// \brief Return the position of the \a index-th character
@ -234,7 +234,7 @@ public :
/// \return Position of the character /// \return Position of the character
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f FindCharacterPos(std::size_t index) const; Vector2f findCharacterPos(std::size_t index) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the local bounding rectangle of the entity /// \brief Get the local bounding rectangle of the entity
@ -248,7 +248,7 @@ public :
/// \return Local bounding rectangle of the entity /// \return Local bounding rectangle of the entity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetLocalBounds() const; FloatRect getLocalBounds() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the global bounding rectangle of the entity /// \brief Get the global bounding rectangle of the entity
@ -262,7 +262,7 @@ public :
/// \return Global bounding rectangle of the entity /// \return Global bounding rectangle of the entity
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetGlobalBounds() const; FloatRect getGlobalBounds() const;
private : private :
@ -273,13 +273,13 @@ private :
/// \param states Current render states /// \param states Current render states
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void Draw(RenderTarget& target, RenderStates states) const; virtual void draw(RenderTarget& target, RenderStates states) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the text's geometry /// \brief Update the text's geometry
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void UpdateGeometry(); void updateGeometry();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -335,17 +335,17 @@ private :
/// \code /// \code
/// // Declare and load a font /// // Declare and load a font
/// sf::Font font; /// sf::Font font;
/// font.LoadFromFile("arial.ttf"); /// font.loadFromFile("arial.ttf");
/// ///
/// // Create a text /// // Create a text
/// sf::Text text("hello"); /// sf::Text text("hello");
/// text.SetFont(font); /// text.setFont(font);
/// text.SetCharacterSize(30); /// text.setCharacterSize(30);
/// text.SetStyle(sf::Text::Bold); /// text.setStyle(sf::Text::Bold);
/// text.SetColor(sf::Color::Red); /// text.setColor(sf::Color::Red);
/// ///
/// // Draw it /// // Draw it
/// window.Draw(text); /// window.draw(text);
/// \endcode /// \endcode
/// ///
/// Note that you don't need to load a font to draw text, /// Note that you don't need to load a font to draw text,

100
include/SFML/Graphics/Texture.hpp
View file

@ -93,7 +93,7 @@ public :
/// \return True if creation was successful /// \return True if creation was successful
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Create(unsigned int width, unsigned int height); bool create(unsigned int width, unsigned int height);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the texture from a file on disk /// \brief Load the texture from a file on disk
@ -101,8 +101,8 @@ public :
/// This function is a shortcut for the following code: /// This function is a shortcut for the following code:
/// \code /// \code
/// sf::Image image; /// sf::Image image;
/// image.LoadFromFile(filename); /// image.loadFromFile(filename);
/// texture.LoadFromImage(image, area); /// texture.loadFromImage(image, area);
/// \endcode /// \endcode
/// ///
/// The \a area argument can be used to load only a sub-rectangle /// The \a area argument can be used to load only a sub-rectangle
@ -112,7 +112,7 @@ public :
/// is adjusted to fit the image size. /// is adjusted to fit the image size.
/// ///
/// The maximum size for a texture depends on the graphics /// The maximum size for a texture depends on the graphics
/// driver and can be retrieved with the GetMaximumSize function. /// driver and can be retrieved with the getMaximumSize function.
/// ///
/// If this function fails, the texture is left unchanged. /// If this function fails, the texture is left unchanged.
/// ///
@ -121,10 +121,10 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromMemory, LoadFromStream, LoadFromImage /// \see loadFromMemory, loadFromStream, loadFromImage
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromFile(const std::string& filename, const IntRect& area = IntRect()); bool loadFromFile(const std::string& filename, const IntRect& area = IntRect());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the texture from a file in memory /// \brief Load the texture from a file in memory
@ -132,8 +132,8 @@ public :
/// This function is a shortcut for the following code: /// This function is a shortcut for the following code:
/// \code /// \code
/// sf::Image image; /// sf::Image image;
/// image.LoadFromMemory(data, size); /// image.loadFromMemory(data, size);
/// texture.LoadFromImage(image, area); /// texture.loadFromImage(image, area);
/// \endcode /// \endcode
/// ///
/// The \a area argument can be used to load only a sub-rectangle /// The \a area argument can be used to load only a sub-rectangle
@ -143,7 +143,7 @@ public :
/// is adjusted to fit the image size. /// is adjusted to fit the image size.
/// ///
/// The maximum size for a texture depends on the graphics /// The maximum size for a texture depends on the graphics
/// driver and can be retrieved with the GetMaximumSize function. /// driver and can be retrieved with the getMaximumSize function.
/// ///
/// If this function fails, the texture is left unchanged. /// If this function fails, the texture is left unchanged.
/// ///
@ -153,10 +153,10 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromFile, LoadFromStream, LoadFromImage /// \see loadFromFile, loadFromStream, loadFromImage
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromMemory(const void* data, std::size_t size, const IntRect& area = IntRect()); bool loadFromMemory(const void* data, std::size_t size, const IntRect& area = IntRect());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the texture from a file in memory /// \brief Load the texture from a file in memory
@ -164,8 +164,8 @@ public :
/// This function is a shortcut for the following code: /// This function is a shortcut for the following code:
/// \code /// \code
/// sf::Image image; /// sf::Image image;
/// image.LoadFromStream(stream); /// image.loadFromStream(stream);
/// texture.LoadFromImage(image, area); /// texture.loadFromImage(image, area);
/// \endcode /// \endcode
/// ///
/// The \a area argument can be used to load only a sub-rectangle /// The \a area argument can be used to load only a sub-rectangle
@ -175,7 +175,7 @@ public :
/// is adjusted to fit the image size. /// is adjusted to fit the image size.
/// ///
/// The maximum size for a texture depends on the graphics /// The maximum size for a texture depends on the graphics
/// driver and can be retrieved with the GetMaximumSize function. /// driver and can be retrieved with the getMaximumSize function.
/// ///
/// If this function fails, the texture is left unchanged. /// If this function fails, the texture is left unchanged.
/// ///
@ -184,10 +184,10 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromFile, LoadFromMemory, LoadFromImage /// \see loadFromFile, loadFromMemory, loadFromImage
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromStream(sf::InputStream& stream, const IntRect& area = IntRect()); bool loadFromStream(sf::InputStream& stream, const IntRect& area = IntRect());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Load the texture from an image /// \brief Load the texture from an image
@ -199,7 +199,7 @@ public :
/// is adjusted to fit the image size. /// is adjusted to fit the image size.
/// ///
/// The maximum size for a texture depends on the graphics /// The maximum size for a texture depends on the graphics
/// driver and can be retrieved with the GetMaximumSize function. /// driver and can be retrieved with the getMaximumSize function.
/// ///
/// If this function fails, the texture is left unchanged. /// If this function fails, the texture is left unchanged.
/// ///
@ -208,30 +208,30 @@ public :
/// ///
/// \return True if loading was successful /// \return True if loading was successful
/// ///
/// \see LoadFromFile, LoadFromMemory /// \see loadFromFile, loadFromMemory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool LoadFromImage(const Image& image, const IntRect& area = IntRect()); bool loadFromImage(const Image& image, const IntRect& area = IntRect());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the width of the texture /// \brief Return the width of the texture
/// ///
/// \return Width in pixels /// \return Width in pixels
/// ///
/// \see GetHeight /// \see getHeight
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetWidth() const; unsigned int getWidth() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the height of the texture /// \brief Return the height of the texture
/// ///
/// \return Height in pixels /// \return Height in pixels
/// ///
/// \see GetWidth /// \see getWidth
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetHeight() const; unsigned int getHeight() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Copy the texture pixels to an image /// \brief Copy the texture pixels to an image
@ -243,10 +243,10 @@ public :
/// ///
/// \return Image containing the texture's pixels /// \return Image containing the texture's pixels
/// ///
/// \see LoadFromImage /// \see loadFromImage
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Image CopyToImage() const; Image copyToImage() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the whole texture from an array of pixels /// \brief Update the whole texture from an array of pixels
@ -264,7 +264,7 @@ public :
/// \param pixels Array of pixels to copy to the texture /// \param pixels Array of pixels to copy to the texture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(const Uint8* pixels); void update(const Uint8* pixels);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update a part of the texture from an array of pixels /// \brief Update a part of the texture from an array of pixels
@ -286,7 +286,7 @@ public :
/// \param y Y offset in the texture where to copy the source pixels /// \param y Y offset in the texture where to copy the source pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(const Uint8* pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y); void update(const Uint8* pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the texture from an image /// \brief Update the texture from an image
@ -306,7 +306,7 @@ public :
/// \param image Image to copy to the texture /// \param image Image to copy to the texture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(const Image& image); void update(const Image& image);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update a part of the texture from an image /// \brief Update a part of the texture from an image
@ -323,7 +323,7 @@ public :
/// \param y Y offset in the texture where to copy the source image /// \param y Y offset in the texture where to copy the source image
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(const Image& image, unsigned int x, unsigned int y); void update(const Image& image, unsigned int x, unsigned int y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the texture from the contents of a window /// \brief Update the texture from the contents of a window
@ -343,7 +343,7 @@ public :
/// \param window Window to copy to the texture /// \param window Window to copy to the texture
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(const Window& window); void update(const Window& window);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update a part of the texture from the contents of a window /// \brief Update a part of the texture from the contents of a window
@ -360,7 +360,7 @@ public :
/// \param y Y offset in the texture where to copy the source window /// \param y Y offset in the texture where to copy the source window
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Update(const Window& window, unsigned int x, unsigned int y); void update(const Window& window, unsigned int x, unsigned int y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Activate the texture for rendering /// \brief Activate the texture for rendering
@ -382,7 +382,7 @@ public :
/// \param coordinateType Type of texture coordinates to use /// \param coordinateType Type of texture coordinates to use
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Bind(CoordinateType coordinateType = Normalized) const; void bind(CoordinateType coordinateType = Normalized) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Enable or disable the smooth filter /// \brief Enable or disable the smooth filter
@ -395,20 +395,20 @@ public :
/// ///
/// \param smooth True to enable smoothing, false to disable it /// \param smooth True to enable smoothing, false to disable it
/// ///
/// \see IsSmooth /// \see isSmooth
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetSmooth(bool smooth); void setSmooth(bool smooth);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether the smooth filter is enabled or not /// \brief Tell whether the smooth filter is enabled or not
/// ///
/// \return True if smoothing is enabled, false if it is disabled /// \return True if smoothing is enabled, false if it is disabled
/// ///
/// \see SetSmooth /// \see setSmooth
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsSmooth() const; bool isSmooth() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Enable or disable repeating /// \brief Enable or disable repeating
@ -429,20 +429,20 @@ public :
/// ///
/// \param repeated True to repeat the texture, false to disable repeating /// \param repeated True to repeat the texture, false to disable repeating
/// ///
/// \see IsRepeated /// \see isRepeated
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetRepeated(bool repeated); void setRepeated(bool repeated);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether the texture is repeated or not /// \brief Tell whether the texture is repeated or not
/// ///
/// \return True if repeat mode is enabled, false if it is disabled /// \return True if repeat mode is enabled, false if it is disabled
/// ///
/// \see SetRepeated /// \see setRepeated
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsRepeated() const; bool isRepeated() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Overload of assignment operator /// \brief Overload of assignment operator
@ -464,7 +464,7 @@ public :
/// \return Maximum size allowed for textures, in pixels /// \return Maximum size allowed for textures, in pixels
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static unsigned int GetMaximumSize(); static unsigned int getMaximumSize();
private : private :
@ -484,7 +484,7 @@ private :
/// \return Valid nearest size (greater than or equal to specified size) /// \return Valid nearest size (greater than or equal to specified size)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static unsigned int GetValidSize(unsigned int size); static unsigned int getValidSize(unsigned int size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -518,7 +518,7 @@ private :
/// Being stored in the graphics card memory has some drawbacks. /// Being stored in the graphics card memory has some drawbacks.
/// A texture cannot be manipulated as freely as a sf::Image, /// A texture cannot be manipulated as freely as a sf::Image,
/// you need to prepare the pixels first and then upload them /// you need to prepare the pixels first and then upload them
/// to the texture in a single operation (see Texture::Update). /// to the texture in a single operation (see Texture::update).
/// ///
/// sf::Texture makes it easy to convert from/to sf::Image, but /// sf::Texture makes it easy to convert from/to sf::Image, but
/// keep in mind that these calls require transfers between /// keep in mind that these calls require transfers between
@ -531,7 +531,7 @@ private :
/// However, if you want to perform some modifications on the pixels /// However, if you want to perform some modifications on the pixels
/// before creating the final texture, you can load your file to a /// before creating the final texture, you can load your file to a
/// sf::Image, do whatever you need with the pixels, and then call /// sf::Image, do whatever you need with the pixels, and then call
/// Texture::LoadFromImage. /// Texture::loadFromImage.
/// ///
/// Since they live in the graphics card memory, the pixels of a texture /// Since they live in the graphics card memory, the pixels of a texture
/// cannot be accessed without a slow copy first. And they cannot be /// cannot be accessed without a slow copy first. And they cannot be
@ -552,15 +552,15 @@ private :
/// ///
/// // Load a texture from a file /// // Load a texture from a file
/// sf::Texture texture; /// sf::Texture texture;
/// if (!texture.LoadFromFile("texture.png")) /// if (!texture.loadFromFile("texture.png"))
/// return -1; /// return -1;
/// ///
/// // Assign it to a sprite /// // Assign it to a sprite
/// sf::Sprite sprite; /// sf::Sprite sprite;
/// sprite.SetTexture(texture); /// sprite.setTexture(texture);
/// ///
/// // Draw the textured sprite /// // Draw the textured sprite
/// window.Draw(sprite); /// window.draw(sprite);
/// \endcode /// \endcode
/// ///
/// \code /// \code
@ -569,7 +569,7 @@ private :
/// ///
/// // Create an empty texture /// // Create an empty texture
/// sf::Texture texture; /// sf::Texture texture;
/// if (!texture.Create(640, 480)) /// if (!texture.create(640, 480))
/// return -1; /// return -1;
/// ///
/// // Create a sprite that will display the texture /// // Create a sprite that will display the texture
@ -581,10 +581,10 @@ private :
/// ///
/// // update the texture /// // update the texture
/// sf::Uint8* pixels = ...; // get a fresh chunk of pixels (the next frame of a movie, for example) /// sf::Uint8* pixels = ...; // get a fresh chunk of pixels (the next frame of a movie, for example)
/// texture.Update(pixels); /// texture.update(pixels);
/// ///
/// // draw it /// // draw it
/// window.Draw(sprite); /// window.draw(sprite);
/// ///
/// ... /// ...
/// } /// }

90
include/SFML/Graphics/Transform.hpp
View file

@ -78,13 +78,13 @@ public :
/// ///
/// \code /// \code
/// sf::Transform transform = ...; /// sf::Transform transform = ...;
/// glLoadMatrixf(transform.GetMatrix()); /// glLoadMatrixf(transform.getMatrix());
/// \endcode /// \endcode
/// ///
/// \return Pointer to a 4x4 matrix /// \return Pointer to a 4x4 matrix
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const float* GetMatrix() const; const float* getMatrix() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the inverse of the transform /// \brief Return the inverse of the transform
@ -95,7 +95,7 @@ public :
/// \return A new transform which is the inverse of self /// \return A new transform which is the inverse of self
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform GetInverse() const; Transform getInverse() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Transform a 2D point /// \brief Transform a 2D point
@ -106,7 +106,7 @@ public :
/// \return Transformed point /// \return Transformed point
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f TransformPoint(float x, float y) const; Vector2f transformPoint(float x, float y) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Transform a 2D point /// \brief Transform a 2D point
@ -116,7 +116,7 @@ public :
/// \return Transformed point /// \return Transformed point
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f TransformPoint(const Vector2f& point) const; Vector2f transformPoint(const Vector2f& point) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Transform a rectangle /// \brief Transform a rectangle
@ -132,7 +132,7 @@ public :
/// \return Transformed rectangle /// \return Transformed rectangle
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect TransformRect(const FloatRect& rectangle) const; FloatRect transformRect(const FloatRect& rectangle) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with another one /// \brief Combine the current transform with another one
@ -146,7 +146,7 @@ public :
/// \return Reference to *this /// \return Reference to *this
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Combine(const Transform& transform); Transform& combine(const Transform& transform);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a translation /// \brief Combine the current transform with a translation
@ -155,7 +155,7 @@ public :
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Translate(100, 200).Rotate(45); /// transform.translate(100, 200).rotate(45);
/// \endcode /// \endcode
/// ///
/// \param x Offset to apply on X axis /// \param x Offset to apply on X axis
@ -163,10 +163,10 @@ public :
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Rotate, Scale /// \see rotate, scale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Translate(float x, float y); Transform& translate(float x, float y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a translation /// \brief Combine the current transform with a translation
@ -175,17 +175,17 @@ public :
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Translate(sf::Vector2f(100, 200)).Rotate(45); /// transform.translate(sf::Vector2f(100, 200)).rotate(45);
/// \endcode /// \endcode
/// ///
/// \param offset Translation offset to apply /// \param offset Translation offset to apply
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Rotate, Scale /// \see rotate, scale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Translate(const Vector2f& offset); Transform& translate(const Vector2f& offset);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a rotation /// \brief Combine the current transform with a rotation
@ -194,17 +194,17 @@ public :
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Rotate(90).Translate(50, 20); /// transform.rotate(90).translate(50, 20);
/// \endcode /// \endcode
/// ///
/// \param angle Rotation angle, in degrees /// \param angle Rotation angle, in degrees
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Scale /// \see translate, scale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Rotate(float angle); Transform& rotate(float angle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a rotation /// \brief Combine the current transform with a rotation
@ -212,13 +212,13 @@ public :
/// The center of rotation is provided for convenience as a second /// The center of rotation is provided for convenience as a second
/// argument, so that you can build rotations around arbitrary points /// argument, so that you can build rotations around arbitrary points
/// more easily (and efficiently) than the usual /// more easily (and efficiently) than the usual
/// Translate(-center).Rotate(angle).Translate(center). /// translate(-center).rotate(angle).translate(center).
/// ///
/// This function returns a reference to *this, so that calls /// This function returns a reference to *this, so that calls
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Rotate(90, 8, 3).Translate(50, 20); /// transform.rotate(90, 8, 3).translate(50, 20);
/// \endcode /// \endcode
/// ///
/// \param angle Rotation angle, in degrees /// \param angle Rotation angle, in degrees
@ -227,10 +227,10 @@ public :
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Scale /// \see translate, scale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Rotate(float angle, float centerX, float centerY); Transform& rotate(float angle, float centerX, float centerY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a rotation /// \brief Combine the current transform with a rotation
@ -238,13 +238,13 @@ public :
/// The center of rotation is provided for convenience as a second /// The center of rotation is provided for convenience as a second
/// argument, so that you can build rotations around arbitrary points /// argument, so that you can build rotations around arbitrary points
/// more easily (and efficiently) than the usual /// more easily (and efficiently) than the usual
/// Translate(-center).Rotate(angle).Translate(center). /// translate(-center).rotate(angle).translate(center).
/// ///
/// This function returns a reference to *this, so that calls /// This function returns a reference to *this, so that calls
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Rotate(90, sf::Vector2f(8, 3)).Translate(sf::Vector2f(50, 20)); /// transform.rotate(90, sf::Vector2f(8, 3)).translate(sf::Vector2f(50, 20));
/// \endcode /// \endcode
/// ///
/// \param angle Rotation angle, in degrees /// \param angle Rotation angle, in degrees
@ -252,10 +252,10 @@ public :
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Scale /// \see translate, scale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Rotate(float angle, const Vector2f& center); Transform& rotate(float angle, const Vector2f& center);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a scaling /// \brief Combine the current transform with a scaling
@ -264,7 +264,7 @@ public :
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Scale(2, 1).Rotate(45); /// transform.scale(2, 1).rotate(45);
/// \endcode /// \endcode
/// ///
/// \param scaleX Scaling factor on the X axis /// \param scaleX Scaling factor on the X axis
@ -272,10 +272,10 @@ public :
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Rotate /// \see translate, rotate
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Scale(float scaleX, float scaleY); Transform& scale(float scaleX, float scaleY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a scaling /// \brief Combine the current transform with a scaling
@ -283,13 +283,13 @@ public :
/// The center of scaling is provided for convenience as a second /// The center of scaling is provided for convenience as a second
/// argument, so that you can build scaling around arbitrary points /// argument, so that you can build scaling around arbitrary points
/// more easily (and efficiently) than the usual /// more easily (and efficiently) than the usual
/// Translate(-center).Scale(factors).Translate(center). /// translate(-center).scale(factors).translate(center).
/// ///
/// This function returns a reference to *this, so that calls /// This function returns a reference to *this, so that calls
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Scale(2, 1, 8, 3).Rotate(45); /// transform.scale(2, 1, 8, 3).rotate(45);
/// \endcode /// \endcode
/// ///
/// \param scaleX Scaling factor on X axis /// \param scaleX Scaling factor on X axis
@ -299,10 +299,10 @@ public :
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Rotate /// \see translate, rotate
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Scale(float scaleX, float scaleY, float centerX, float centerY); Transform& scale(float scaleX, float scaleY, float centerX, float centerY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a scaling /// \brief Combine the current transform with a scaling
@ -311,17 +311,17 @@ public :
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Scale(sf::Vector2f(2, 1)).Rotate(45); /// transform.scale(sf::Vector2f(2, 1)).rotate(45);
/// \endcode /// \endcode
/// ///
/// \param factors Scaling factors /// \param factors Scaling factors
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Rotate /// \see translate, rotate
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Scale(const Vector2f& factors); Transform& scale(const Vector2f& factors);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Combine the current transform with a scaling /// \brief Combine the current transform with a scaling
@ -329,13 +329,13 @@ public :
/// The center of scaling is provided for convenience as a second /// The center of scaling is provided for convenience as a second
/// argument, so that you can build scaling around arbitrary points /// argument, so that you can build scaling around arbitrary points
/// more easily (and efficiently) than the usual /// more easily (and efficiently) than the usual
/// Translate(-center).Scale(factors).Translate(center). /// translate(-center).scale(factors).translate(center).
/// ///
/// This function returns a reference to *this, so that calls /// This function returns a reference to *this, so that calls
/// can be chained. /// can be chained.
/// \code /// \code
/// sf::Transform transform; /// sf::Transform transform;
/// transform.Scale(sf::Vector2f(2, 1), sf::Vector2f(8, 3)).Rotate(45); /// transform.scale(sf::Vector2f(2, 1), sf::Vector2f(8, 3)).rotate(45);
/// \endcode /// \endcode
/// ///
/// \param factors Scaling factors /// \param factors Scaling factors
@ -343,10 +343,10 @@ public :
/// ///
/// \return Reference to *this /// \return Reference to *this
/// ///
/// \see Translate, Rotate /// \see translate, rotate
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Transform& Scale(const Vector2f& factors, const Vector2f& center); Transform& scale(const Vector2f& factors, const Vector2f& center);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Static member data // Static member data
@ -365,7 +365,7 @@ private:
/// \relates sf::Transform /// \relates sf::Transform
/// \brief Overload of binary operator * to combine two transforms /// \brief Overload of binary operator * to combine two transforms
/// ///
/// This call is equivalent to calling Transform(left).Combine(right). /// This call is equivalent to calling Transform(left).combine(right).
/// ///
/// \param left Left operand (the first transform) /// \param left Left operand (the first transform)
/// \param right Right operand (the second transform) /// \param right Right operand (the second transform)
@ -379,7 +379,7 @@ SFML_GRAPHICS_API Transform operator *(const Transform& left, const Transform& r
/// \relates sf::Transform /// \relates sf::Transform
/// \brief Overload of binary operator *= to combine two transforms /// \brief Overload of binary operator *= to combine two transforms
/// ///
/// This call is equivalent to calling left.Combine(right). /// This call is equivalent to calling left.combine(right).
/// ///
/// \param left Left operand (the first transform) /// \param left Left operand (the first transform)
/// \param right Right operand (the second transform) /// \param right Right operand (the second transform)
@ -393,7 +393,7 @@ SFML_GRAPHICS_API Transform& operator *=(Transform& left, const Transform& right
/// \relates sf::Transform /// \relates sf::Transform
/// \brief Overload of binary operator * to transform a point /// \brief Overload of binary operator * to transform a point
/// ///
/// This call is equivalent to calling left.TransformPoint(right). /// This call is equivalent to calling left.transformPoint(right).
/// ///
/// \param left Left operand (the transform) /// \param left Left operand (the transform)
/// \param right Right operand (the point to transform) /// \param right Right operand (the point to transform)
@ -431,18 +431,18 @@ SFML_GRAPHICS_API Vector2f operator *(const Transform& left, const Vector2f& rig
/// \code /// \code
/// // define a translation transform /// // define a translation transform
/// sf::Transform translation; /// sf::Transform translation;
/// translation.Translate(20, 50); /// translation.translate(20, 50);
/// ///
/// // define a rotation transform /// // define a rotation transform
/// sf::Transform rotation; /// sf::Transform rotation;
/// rotation.Rotate(45); /// rotation.rotate(45);
/// ///
/// // combine them /// // combine them
/// sf::Transform transform = translation * rotation; /// sf::Transform transform = translation * rotation;
/// ///
/// // use the result to transform stuff... /// // use the result to transform stuff...
/// sf::Vector2f point = transform.TransformPoint(10, 20); /// sf::Vector2f point = transform.transformPoint(10, 20);
/// sf::FloatRect rect = transform.TransformRect(sf::FloatRect(0, 0, 10, 100)); /// sf::FloatRect rect = transform.transformRect(sf::FloatRect(0, 0, 10, 100));
/// \endcode /// \endcode
/// ///
/// \see sf::Transformable, sf::RenderStates /// \see sf::Transformable, sf::RenderStates

144
include/SFML/Graphics/Transformable.hpp
View file

@ -55,7 +55,7 @@ public :
virtual ~Transformable(); virtual ~Transformable();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the position of the object /// \brief set the position of the object
/// ///
/// This function completely overwrites the previous position. /// This function completely overwrites the previous position.
/// See Move to apply an offset based on the previous position instead. /// See Move to apply an offset based on the previous position instead.
@ -64,13 +64,13 @@ public :
/// \param x X coordinate of the new position /// \param x X coordinate of the new position
/// \param y Y coordinate of the new position /// \param y Y coordinate of the new position
/// ///
/// \see Move, GetPosition /// \see move, getPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPosition(float x, float y); void setPosition(float x, float y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the position of the object /// \brief set the position of the object
/// ///
/// This function completely overwrites the previous position. /// This function completely overwrites the previous position.
/// See Move to apply an offset based on the previous position instead. /// See Move to apply an offset based on the previous position instead.
@ -78,13 +78,13 @@ public :
/// ///
/// \param position New position /// \param position New position
/// ///
/// \see Move, GetPosition /// \see move, getPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPosition(const Vector2f& position); void setPosition(const Vector2f& position);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the orientation of the object /// \brief set the orientation of the object
/// ///
/// This function completely overwrites the previous rotation. /// This function completely overwrites the previous rotation.
/// See Rotate to add an angle based on the previous rotation instead. /// See Rotate to add an angle based on the previous rotation instead.
@ -92,13 +92,13 @@ public :
/// ///
/// \param angle New rotation, in degrees /// \param angle New rotation, in degrees
/// ///
/// \see Rotate, GetRotation /// \see rotate, getRotation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetRotation(float angle); void setRotation(float angle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the scale factors of the object /// \brief set the scale factors of the object
/// ///
/// This function completely overwrites the previous scale. /// This function completely overwrites the previous scale.
/// See Scale to add a factor based on the previous scale instead. /// See Scale to add a factor based on the previous scale instead.
@ -107,13 +107,13 @@ public :
/// \param factorX New horizontal scale factor /// \param factorX New horizontal scale factor
/// \param factorY New vertical scale factor /// \param factorY New vertical scale factor
/// ///
/// \see Scale, GetScale /// \see scale, getScale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetScale(float factorX, float factorY); void setScale(float factorX, float factorY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the scale factors of the object /// \brief set the scale factors of the object
/// ///
/// This function completely overwrites the previous scale. /// This function completely overwrites the previous scale.
/// See Scale to add a factor based on the previous scale instead. /// See Scale to add a factor based on the previous scale instead.
@ -121,13 +121,13 @@ public :
/// ///
/// \param factors New scale factors /// \param factors New scale factors
/// ///
/// \see Scale, GetScale /// \see scale, getScale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetScale(const Vector2f& factors); void setScale(const Vector2f& factors);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the local origin of the object /// \brief set the local origin of the object
/// ///
/// The origin of an object defines the center point for /// The origin of an object defines the center point for
/// all transformations (position, scale, rotation). /// all transformations (position, scale, rotation).
@ -139,13 +139,13 @@ public :
/// \param x X coordinate of the new origin /// \param x X coordinate of the new origin
/// \param y Y coordinate of the new origin /// \param y Y coordinate of the new origin
/// ///
/// \see GetOrigin /// \see getOrigin
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetOrigin(float x, float y); void setOrigin(float x, float y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the local origin of the object /// \brief set the local origin of the object
/// ///
/// The origin of an object defines the center point for /// The origin of an object defines the center point for
/// all transformations (position, scale, rotation). /// all transformations (position, scale, rotation).
@ -156,160 +156,160 @@ public :
/// ///
/// \param origin New origin /// \param origin New origin
/// ///
/// \see GetOrigin /// \see getOrigin
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetOrigin(const Vector2f& origin); void setOrigin(const Vector2f& origin);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the position of the object /// \brief get the position of the object
/// ///
/// \return Current position /// \return Current position
/// ///
/// \see SetPosition /// \see setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vector2f& GetPosition() const; const Vector2f& getPosition() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the orientation of the object /// \brief get the orientation of the object
/// ///
/// The rotation is always in the range [0, 360]. /// The rotation is always in the range [0, 360].
/// ///
/// \return Current rotation, in degrees /// \return Current rotation, in degrees
/// ///
/// \see SetRotation /// \see setRotation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetRotation() const; float getRotation() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current scale of the object /// \brief get the current scale of the object
/// ///
/// \return Current scale factors /// \return Current scale factors
/// ///
/// \see SetScale /// \see setScale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vector2f& GetScale() const; const Vector2f& getScale() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the local origin of the object /// \brief get the local origin of the object
/// ///
/// \return Current origin /// \return Current origin
/// ///
/// \see SetOrigin /// \see setOrigin
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vector2f& GetOrigin() const; const Vector2f& getOrigin() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Move the object by a given offset /// \brief Move the object by a given offset
/// ///
/// This function adds to the current position of the object, /// This function adds to the current position of the object,
/// unlike SetPosition which overwrites it. /// unlike setPosition which overwrites it.
/// Thus, it is equivalent to the following code: /// Thus, it is equivalent to the following code:
/// \code /// \code
/// sf::Vector2f pos = object.GetPosition(); /// sf::Vector2f pos = object.getPosition();
/// object.SetPosition(pos.x + offsetX, pos.y + offsetY); /// object.setPosition(pos.x + offsetX, pos.y + offsetY);
/// \endcode /// \endcode
/// ///
/// \param offsetX X offset /// \param offsetX X offset
/// \param offsetY Y offset /// \param offsetY Y offset
/// ///
/// \see SetPosition /// \see setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Move(float offsetX, float offsetY); void move(float offsetX, float offsetY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Move the object by a given offset /// \brief Move the object by a given offset
/// ///
/// This function adds to the current position of the object, /// This function adds to the current position of the object,
/// unlike SetPosition which overwrites it. /// unlike setPosition which overwrites it.
/// Thus, it is equivalent to the following code: /// Thus, it is equivalent to the following code:
/// \code /// \code
/// object.SetPosition(object.GetPosition() + offset); /// object.setPosition(object.getPosition() + offset);
/// \endcode /// \endcode
/// ///
/// \param offset Offset /// \param offset Offset
/// ///
/// \see SetPosition /// \see setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Move(const Vector2f& offset); void move(const Vector2f& offset);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Rotate the object /// \brief Rotate the object
/// ///
/// This function adds to the current rotation of the object, /// This function adds to the current rotation of the object,
/// unlike SetRotation which overwrites it. /// unlike setRotation which overwrites it.
/// Thus, it is equivalent to the following code: /// Thus, it is equivalent to the following code:
/// \code /// \code
/// object.SetRotation(object.GetRotation() + angle); /// object.setRotation(object.getRotation() + angle);
/// \endcode /// \endcode
/// ///
/// \param angle Angle of rotation, in degrees /// \param angle Angle of rotation, in degrees
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Rotate(float angle); void rotate(float angle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Scale the object /// \brief Scale the object
/// ///
/// This function multiplies the current scale of the object, /// This function multiplies the current scale of the object,
/// unlike SetScale which overwrites it. /// unlike setScale which overwrites it.
/// Thus, it is equivalent to the following code: /// Thus, it is equivalent to the following code:
/// \code /// \code
/// sf::Vector2f scale = object.GetScale(); /// sf::Vector2f scale = object.getScale();
/// object.SetScale(scale.x * factorX, scale.y * factorY); /// object.setScale(scale.x * factorX, scale.y * factorY);
/// \endcode /// \endcode
/// ///
/// \param factorX Horizontal scale factor /// \param factorX Horizontal scale factor
/// \param factorY Vertical scale factor /// \param factorY Vertical scale factor
/// ///
/// \see SetScale /// \see setScale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Scale(float factorX, float factorY); void scale(float factorX, float factorY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Scale the object /// \brief Scale the object
/// ///
/// This function multiplies the current scale of the object, /// This function multiplies the current scale of the object,
/// unlike SetScale which overwrites it. /// unlike setScale which overwrites it.
/// Thus, it is equivalent to the following code: /// Thus, it is equivalent to the following code:
/// \code /// \code
/// sf::Vector2f scale = object.GetScale(); /// sf::Vector2f scale = object.getScale();
/// object.SetScale(scale.x * factor.x, scale.y * factor.y); /// object.setScale(scale.x * factor.x, scale.y * factor.y);
/// \endcode /// \endcode
/// ///
/// \param factor Scale factors /// \param factor Scale factors
/// ///
/// \see SetScale /// \see setScale
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Scale(const Vector2f& factor); void scale(const Vector2f& factor);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the combined transform of the object /// \brief get the combined transform of the object
/// ///
/// \return Transform combining the position/rotation/scale/origin of the object /// \return Transform combining the position/rotation/scale/origin of the object
/// ///
/// \see GetInverseTransform /// \see getInverseTransform
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Transform& GetTransform() const; const Transform& getTransform() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the inverse of the combined transform of the object /// \brief get the inverse of the combined transform of the object
/// ///
/// \return Inverse of the combined transformations applied to the object /// \return Inverse of the combined transformations applied to the object
/// ///
/// \see GetTransform /// \see getTransform
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Transform& GetInverseTransform() const; const Transform& getInverseTransform() const;
private : private :
@ -377,17 +377,17 @@ private :
/// \code /// \code
/// class MyEntity : public sf::Transformable, public sf::Drawable /// class MyEntity : public sf::Transformable, public sf::Drawable
/// { /// {
/// virtual void Draw(sf::RenderTarget& target, sf::RenderStates states) const /// virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const
/// { /// {
/// states.Transform *= GetTransform(); /// states.transform *= getTransform();
/// target.Draw(..., states); /// target.draw(..., states);
/// } /// }
/// }; /// };
/// ///
/// MyEntity entity; /// MyEntity entity;
/// entity.SetPosition(10, 20); /// entity.setPosition(10, 20);
/// entity.SetRotation(45); /// entity.setRotation(45);
/// window.Draw(entity); /// window.draw(entity);
/// \endcode /// \endcode
/// ///
/// It can also be used as a member, if you don't want to use /// It can also be used as a member, if you don't want to use
@ -397,18 +397,18 @@ private :
/// class MyEntity /// class MyEntity
/// { /// {
/// public : /// public :
/// void setPosition(const MyVector& v) /// void SetPosition(const MyVector& v)
/// { /// {
/// m_transform.SetPosition(v.x(), v.y()); /// myTransform.setPosition(v.x(), v.y());
/// } /// }
/// ///
/// void draw(sf::RenderTarget& target) const /// void Draw(sf::RenderTarget& target) const
/// { /// {
/// target.Draw(..., m_transform.GetTransform()); /// target.draw(..., myTransform.getTransform());
/// } /// }
/// ///
/// private : /// private :
/// sf::Transformable m_transform; /// sf::Transformable myTransform;
/// }; /// };
/// \endcode /// \endcode
/// ///

12
include/SFML/Graphics/Vertex.hpp
View file

@ -68,7 +68,7 @@ public :
/// \param color Vertex color /// \param color Vertex color
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vertex(const Vector2f& position, const sf::Color& color); Vertex(const Vector2f& position, const Color& color);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct the vertex from its position and texture coordinates /// \brief Construct the vertex from its position and texture coordinates
@ -89,14 +89,14 @@ public :
/// \param texCoords Vertex texture coordinates /// \param texCoords Vertex texture coordinates
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vertex(const Vector2f& position, const sf::Color& color, const Vector2f& texCoords); Vertex(const Vector2f& position, const Color& color, const Vector2f& texCoords);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f Position; ///< 2D position of the vertex Vector2f position; ///< 2D position of the vertex
sf::Color Color; ///< Color of the vertex Color color; ///< Color of the vertex
Vector2f TexCoords; ///< Coordinates of the texture's pixel to map to the vertex Vector2f texCoords; ///< Coordinates of the texture's pixel to map to the vertex
}; };
} // namespace sf } // namespace sf
@ -136,7 +136,7 @@ public :
/// }; /// };
/// ///
/// // draw it /// // draw it
/// window.Draw(vertices, 4, sf::Quads); /// window.draw(vertices, 4, sf::Quads);
/// \endcode /// \endcode
/// ///
/// Note: although texture coordinates are supposed to be an integer /// Note: although texture coordinates are supposed to be an integer

30
include/SFML/Graphics/VertexArray.hpp
View file

@ -69,7 +69,7 @@ public :
/// \return Number of vertices in the array /// \return Number of vertices in the array
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetVertexCount() const; unsigned int getVertexCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a read-write access to a vertex by its index /// \brief Get a read-write access to a vertex by its index
@ -82,7 +82,7 @@ public :
/// ///
/// \return Reference to the index-th vertex /// \return Reference to the index-th vertex
/// ///
/// \see GetVertexCount /// \see getVertexCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vertex& operator [](unsigned int index); Vertex& operator [](unsigned int index);
@ -98,7 +98,7 @@ public :
/// ///
/// \return Const reference to the index-th vertex /// \return Const reference to the index-th vertex
/// ///
/// \see GetVertexCount /// \see getVertexCount
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vertex& operator [](unsigned int index) const; const Vertex& operator [](unsigned int index) const;
@ -112,7 +112,7 @@ public :
/// reallocating all the memory. /// reallocating all the memory.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Clear(); void clear();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Resize the vertex array /// \brief Resize the vertex array
@ -126,7 +126,7 @@ public :
/// \param vertexCount New size of the array (number of vertices) /// \param vertexCount New size of the array (number of vertices)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Resize(unsigned int vertexCount); void resize(unsigned int vertexCount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Add a vertex to the array /// \brief Add a vertex to the array
@ -134,7 +134,7 @@ public :
/// \param vertex Vertex to add /// \param vertex Vertex to add
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Append(const Vertex& vertex); void append(const Vertex& vertex);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the type of primitives to draw /// \brief Set the type of primitives to draw
@ -150,7 +150,7 @@ public :
/// \param type Type of primitive /// \param type Type of primitive
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPrimitiveType(PrimitiveType type); void setPrimitiveType(PrimitiveType type);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the type of primitives drawn by the vertex array /// \brief Get the type of primitives drawn by the vertex array
@ -158,7 +158,7 @@ public :
/// \return Primitive type /// \return Primitive type
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
PrimitiveType GetPrimitiveType() const; PrimitiveType getPrimitiveType() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Compute the bounding rectangle of the vertex array /// \brief Compute the bounding rectangle of the vertex array
@ -169,7 +169,7 @@ public :
/// \return Bounding rectangle of the vertex array /// \return Bounding rectangle of the vertex array
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FloatRect GetBounds() const; FloatRect getBounds() const;
private : private :
@ -180,7 +180,7 @@ private :
/// \param states Current render states /// \param states Current render states
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void Draw(RenderTarget& target, RenderStates states) const; virtual void draw(RenderTarget& target, RenderStates states) const;
private: private:
@ -210,12 +210,12 @@ private:
/// Example: /// Example:
/// \code /// \code
/// sf::VertexArray lines(sf::LinesStrip, 4); /// sf::VertexArray lines(sf::LinesStrip, 4);
/// lines[0].Position = sf::Vector2f(10, 0); /// lines[0].position = sf::Vector2f(10, 0);
/// lines[1].Position = sf::Vector2f(20, 0); /// lines[1].position = sf::Vector2f(20, 0);
/// lines[2].Position = sf::Vector2f(30, 5); /// lines[2].position = sf::Vector2f(30, 5);
/// lines[3].Position = sf::Vector2f(40, 2); /// lines[3].position = sf::Vector2f(40, 2);
/// ///
/// window.Draw(lines); /// window.draw(lines);
/// \endcode /// \endcode
/// ///
/// \see sf::Vertex /// \see sf::Vertex

84
include/SFML/Graphics/View.hpp
View file

@ -75,20 +75,20 @@ public :
/// \param x X coordinate of the new center /// \param x X coordinate of the new center
/// \param y Y coordinate of the new center /// \param y Y coordinate of the new center
/// ///
/// \see SetSize, GetCenter /// \see setSize, getCenter
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetCenter(float x, float y); void setCenter(float x, float y);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the center of the view /// \brief Set the center of the view
/// ///
/// \param center New center /// \param center New center
/// ///
/// \see SetSize, GetCenter /// \see setSize, getCenter
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetCenter(const Vector2f& center); void setCenter(const Vector2f& center);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the size of the view /// \brief Set the size of the view
@ -96,20 +96,20 @@ public :
/// \param width New width of the view /// \param width New width of the view
/// \param height New height of the view /// \param height New height of the view
/// ///
/// \see SetCenter, GetCenter /// \see setCenter, getCenter
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetSize(float width, float height); void setSize(float width, float height);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the size of the view /// \brief Set the size of the view
/// ///
/// \param size New size /// \param size New size
/// ///
/// \see SetCenter, GetCenter /// \see setCenter, getCenter
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetSize(const Vector2f& size); void setSize(const Vector2f& size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the orientation of the view /// \brief Set the orientation of the view
@ -118,10 +118,10 @@ public :
/// ///
/// \param angle New angle, in degrees /// \param angle New angle, in degrees
/// ///
/// \see GetRotation /// \see getRotation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetRotation(float angle); void setRotation(float angle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the target viewport /// \brief Set the target viewport
@ -130,15 +130,15 @@ public :
/// view are displayed, expressed as a factor (between 0 and 1) /// view are displayed, expressed as a factor (between 0 and 1)
/// of the size of the RenderTarget to which the view is applied. /// of the size of the RenderTarget to which the view is applied.
/// For example, a view which takes the left side of the target would /// For example, a view which takes the left side of the target would
/// be defined with View.SetViewport(sf::FloatRect(0, 0, 0.5, 1)). /// be defined with View.setViewport(sf::FloatRect(0, 0, 0.5, 1)).
/// By default, a view has a viewport which covers the entire target. /// By default, a view has a viewport which covers the entire target.
/// ///
/// \param viewport New viewport rectangle /// \param viewport New viewport rectangle
/// ///
/// \see GetViewport /// \see getViewport
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetViewport(const FloatRect& viewport); void setViewport(const FloatRect& viewport);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Reset the view to the given rectangle /// \brief Reset the view to the given rectangle
@ -147,50 +147,50 @@ public :
/// ///
/// \param rectangle Rectangle defining the zone to display /// \param rectangle Rectangle defining the zone to display
/// ///
/// \see SetCenter, SetSize, SetRotation /// \see setCenter, setSize, setRotation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Reset(const FloatRect& rectangle); void reset(const FloatRect& rectangle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the center of the view /// \brief Get the center of the view
/// ///
/// \return Center of the view /// \return Center of the view
/// ///
/// \see GetSize, SetCenter /// \see getSize, setCenter
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vector2f& GetCenter() const; const Vector2f& getCenter() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the size of the view /// \brief Get the size of the view
/// ///
/// \return Size of the view /// \return Size of the view
/// ///
/// \see GetCenter, SetSize /// \see getCenter, setSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Vector2f& GetSize() const; const Vector2f& getSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current orientation of the view /// \brief Get the current orientation of the view
/// ///
/// \return Rotation angle of the view, in degrees /// \return Rotation angle of the view, in degrees
/// ///
/// \see SetRotation /// \see setRotation
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float GetRotation() const; float getRotation() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the target viewport rectangle of the view /// \brief Get the target viewport rectangle of the view
/// ///
/// \return Viewport rectangle, expressed as a factor of the target size /// \return Viewport rectangle, expressed as a factor of the target size
/// ///
/// \see SetViewport /// \see setViewport
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const FloatRect& GetViewport() const; const FloatRect& getViewport() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Move the view relatively to its current position /// \brief Move the view relatively to its current position
@ -198,30 +198,30 @@ public :
/// \param offsetX X coordinate of the move offset /// \param offsetX X coordinate of the move offset
/// \param offsetY Y coordinate of the move offset /// \param offsetY Y coordinate of the move offset
/// ///
/// \see SetCenter, Rotate, Zoom /// \see setCenter, rotate, zoom
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Move(float offsetX, float offsetY); void move(float offsetX, float offsetY);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Move the view relatively to its current position /// \brief Move the view relatively to its current position
/// ///
/// \param offset Move offset /// \param offset Move offset
/// ///
/// \see SetCenter, Rotate, Zoom /// \see setCenter, rotate, zoom
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Move(const Vector2f& offset); void move(const Vector2f& offset);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Rotate the view relatively to its current orientation /// \brief Rotate the view relatively to its current orientation
/// ///
/// \param angle Angle to rotate, in degrees /// \param angle Angle to rotate, in degrees
/// ///
/// \see SetRotation, Move, Zoom /// \see setRotation, move, zoom
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Rotate(float angle); void rotate(float angle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Resize the view rectangle relatively to its current size /// \brief Resize the view rectangle relatively to its current size
@ -235,10 +235,10 @@ public :
/// ///
/// \param factor Zoom factor to apply /// \param factor Zoom factor to apply
/// ///
/// \see SetSize, Move, Rotate /// \see setSize, move, rotate
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Zoom(float factor); void zoom(float factor);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the projection transform of the view /// \brief Get the projection transform of the view
@ -247,10 +247,10 @@ public :
/// ///
/// \return Projection transform defining the view /// \return Projection transform defining the view
/// ///
/// \see GetInverseTransform /// \see getInverseTransform
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Transform& GetTransform() const; const Transform& getTransform() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the inverse projection transform of the view /// \brief Get the inverse projection transform of the view
@ -259,10 +259,10 @@ public :
/// ///
/// \return Inverse of the projection transform defining the view /// \return Inverse of the projection transform defining the view
/// ///
/// \see GetTransform /// \see getTransform
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Transform& GetInverseTransform() const; const Transform& getInverseTransform() const;
private : private :
@ -315,25 +315,25 @@ private :
/// sf::View view; /// sf::View view;
/// ///
/// // Initialize the view to a rectangle located at (100, 100) and with a size of 400x200 /// // Initialize the view to a rectangle located at (100, 100) and with a size of 400x200
/// view.Reset(sf::FloatRect(100, 100, 400, 200)); /// view.reset(sf::FloatRect(100, 100, 400, 200));
/// ///
/// // Rotate it by 45 degrees /// // Rotate it by 45 degrees
/// view.Rotate(45); /// view.rotate(45);
/// ///
/// // Set its target viewport to be half of the window /// // Set its target viewport to be half of the window
/// view.SetViewport(sf::FloatRect(0.f, 0.f, 0.5f, 1.f)); /// view.setViewport(sf::FloatRect(0.f, 0.f, 0.5f, 1.f));
/// ///
/// // Apply it /// // Apply it
/// window.SetView(view); /// window.setView(view);
/// ///
/// // Render stuff /// // Render stuff
/// window.Draw(someSprite); /// window.draw(someSprite);
/// ///
/// // Set the default view back /// // Set the default view back
/// window.SetView(window.GetDefaultView()); /// window.setView(window.getDefaultView());
/// ///
/// // Render stuff not affected by the view /// // Render stuff not affected by the view
/// window.Draw(someText); /// window.draw(someText);
/// \endcode /// \endcode
/// ///
/// \see sf::RenderWindow, sf::RenderTexture /// \see sf::RenderWindow, sf::RenderTexture

96
include/SFML/Network/Ftp.hpp
View file

@ -154,7 +154,7 @@ public :
/// \return True if the status is a success, false if it is a failure /// \return True if the status is a success, false if it is a failure
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsOk() const; bool isOk() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the status code of the response /// \brief Get the status code of the response
@ -162,7 +162,7 @@ public :
/// \return Status code /// \return Status code
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status GetStatus() const; Status getStatus() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the full message contained in the response /// \brief Get the full message contained in the response
@ -170,7 +170,7 @@ public :
/// \return The response message /// \return The response message
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const std::string& GetMessage() const; const std::string& getMessage() const;
private : private :
@ -203,7 +203,7 @@ public :
/// \return Directory name /// \return Directory name
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const std::string& GetDirectory() const; const std::string& getDirectory() const;
private : private :
@ -237,7 +237,7 @@ public :
/// \return Array containing the requested filenames /// \return Array containing the requested filenames
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const std::vector<std::string>& GetFilenames() const; const std::vector<std::string>& getFilenames() const;
private : private :
@ -275,20 +275,20 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see Disconnect /// \see disconnect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response Connect(const IpAddress& server, unsigned short port = 21, Time timeout = Time::Zero); Response connect(const IpAddress& server, unsigned short port = 21, Time timeout = Time::Zero);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Close the connection with the server /// \brief Close the connection with the server
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see Connect /// \see connect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response Disconnect(); Response disconnect();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Log in using an anonymous account /// \brief Log in using an anonymous account
@ -299,7 +299,7 @@ public :
/// \return Server response to the request /// \return Server response to the request
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response Login(); Response login();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Log in using a username and a password /// \brief Log in using a username and a password
@ -313,7 +313,7 @@ public :
/// \return Server response to the request /// \return Server response to the request
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response Login(const std::string& name, const std::string& password); Response login(const std::string& name, const std::string& password);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Send a null command to keep the connection alive /// \brief Send a null command to keep the connection alive
@ -324,7 +324,7 @@ public :
/// \return Server response to the request /// \return Server response to the request
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response KeepAlive(); Response keepAlive();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current working directory /// \brief Get the current working directory
@ -334,10 +334,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see GetDirectoryListing, ChangeDirectory, ParentDirectory /// \see getDirectoryListing, changeDirectory, parentDirectory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
DirectoryResponse GetWorkingDirectory(); DirectoryResponse getWorkingDirectory();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the contents of the given directory /// \brief Get the contents of the given directory
@ -351,10 +351,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see GetWorkingDirectory, ChangeDirectory, ParentDirectory /// \see getWorkingDirectory, changeDirectory, parentDirectory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
ListingResponse GetDirectoryListing(const std::string& directory = ""); ListingResponse getDirectoryListing(const std::string& directory = "");
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current working directory /// \brief Change the current working directory
@ -365,20 +365,20 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see GetWorkingDirectory, GetDirectoryListing, ParentDirectory /// \see getWorkingDirectory, getDirectoryListing, parentDirectory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response ChangeDirectory(const std::string& directory); Response changeDirectory(const std::string& directory);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Go to the parent directory of the current one /// \brief Go to the parent directory of the current one
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see GetWorkingDirectory, GetDirectoryListing, ChangeDirectory /// \see getWorkingDirectory, getDirectoryListing, changeDirectory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response ParentDirectory(); Response parentDirectory();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create a new directory /// \brief Create a new directory
@ -390,10 +390,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see DeleteDirectory /// \see deleteDirectory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response CreateDirectory(const std::string& name); Response createDirectory(const std::string& name);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Remove an existing directory /// \brief Remove an existing directory
@ -407,10 +407,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see CreateDirectory /// \see createDirectory
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response DeleteDirectory(const std::string& name); Response deleteDirectory(const std::string& name);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Rename an existing file /// \brief Rename an existing file
@ -423,10 +423,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see DeleteFile /// \see deleteFile
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response RenameFile(const std::string& file, const std::string& newName); Response renameFile(const std::string& file, const std::string& newName);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Remove an existing file /// \brief Remove an existing file
@ -440,10 +440,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see RenameFile /// \see renameFile
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response DeleteFile(const std::string& name); Response deleteFile(const std::string& name);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Download a file from the server /// \brief Download a file from the server
@ -459,10 +459,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see Upload /// \see upload
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response Download(const std::string& remoteFile, const std::string& localPath, TransferMode mode = Binary); Response download(const std::string& remoteFile, const std::string& localPath, TransferMode mode = Binary);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Upload a file to the server /// \brief Upload a file to the server
@ -478,8 +478,10 @@ public :
/// ///
/// \return Server response to the request /// \return Server response to the request
/// ///
/// \see download
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response Upload(const std::string& localFile, const std::string& remotePath, TransferMode mode = Binary); Response upload(const std::string& localFile, const std::string& remotePath, TransferMode mode = Binary);
private : private :
@ -492,7 +494,7 @@ private :
/// \return Server response to the request /// \return Server response to the request
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response SendCommand(const std::string& command, const std::string& parameter = ""); Response sendCommand(const std::string& command, const std::string& parameter = "");
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Receive a response from the server /// \brief Receive a response from the server
@ -503,7 +505,7 @@ private :
/// \return Server response to the request /// \return Server response to the request
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response GetResponse(); Response getResponse();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Utility class for exchanging datas with the server /// \brief Utility class for exchanging datas with the server
@ -543,11 +545,11 @@ private :
/// ///
/// Every command returns a FTP response, which contains the /// Every command returns a FTP response, which contains the
/// status code as well as a message from the server. Some /// status code as well as a message from the server. Some
/// commands such as GetWorkingDirectory and GetDirectoryListing /// commands such as getWorkingDirectory and getDirectoryListing
/// return additional data, and use a class derived from /// return additional data, and use a class derived from
/// sf::Ftp::Response to provide this data. /// sf::Ftp::Response to provide this data.
/// ///
/// All commands, especially Upload and Download, may take some /// All commands, especially upload and download, may take some
/// time to complete. This is important to know if you don't want /// time to complete. This is important to know if you don't want
/// to block your application while the server is completing /// to block your application while the server is completing
/// the task. /// the task.
@ -558,32 +560,32 @@ private :
/// sf::Ftp ftp; /// sf::Ftp ftp;
/// ///
/// // Connect to the server /// // Connect to the server
/// sf::Ftp::Response response = ftp.Connect("ftp://ftp.myserver.com"); /// sf::Ftp::Response response = ftp.connect("ftp://ftp.myserver.com");
/// if (response.IsOk()) /// if (response.isOk())
/// std::cout << "Connected" << std::endl; /// std::cout << "Connected" << std::endl;
/// ///
/// // Log in /// // Log in
/// response = ftp.Login("laurent", "dF6Zm89D"); /// response = ftp.login("laurent", "dF6Zm89D");
/// if (response.IsOk()) /// if (response.isOk())
/// std::cout << "Logged in" << std::endl; /// std::cout << "Logged in" << std::endl;
/// ///
/// // Print the working directory /// // Print the working directory
/// sf::Ftp::DirectoryResponse directory = ftp.GetWorkingDirectory(); /// sf::Ftp::DirectoryResponse directory = ftp.getWorkingDirectory();
/// if (directory.IsOk()) /// if (directory.isOk())
/// std::cout << "Working directory: " << directory.GetDirectory() << std::endl; /// std::cout << "Working directory: " << directory.getDirectory() << std::endl;
/// ///
/// // Create a new directory /// // Create a new directory
/// response = ftp.CreateDirectory("files"); /// response = ftp.createDirectory("files");
/// if (response.IsOk()) /// if (response.isOk())
/// std::cout << "Created new directory" << std::endl; /// std::cout << "Created new directory" << std::endl;
/// ///
/// // Upload a file to this new directory /// // Upload a file to this new directory
/// response = ftp.Upload("local-path/file.txt", "files", sf::Ftp::Ascii); /// response = ftp.upload("local-path/file.txt", "files", sf::Ftp::Ascii);
/// if (response.IsOk()) /// if (response.isOk())
/// std::cout << "File uploaded" << std::endl; /// std::cout << "File uploaded" << std::endl;
/// ///
/// // Disconnect from the server (optional) /// // Disconnect from the server (optional)
/// ftp.Disconnect(); /// ftp.disconnect();
/// \endcode /// \endcode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

44
include/SFML/Network/Http.hpp
View file

@ -92,7 +92,7 @@ public :
/// \param value Value of the field /// \param value Value of the field
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetField(const std::string& field, const std::string& value); void setField(const std::string& field, const std::string& value);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the request method /// \brief Set the request method
@ -104,7 +104,7 @@ public :
/// \param method Method to use for the request /// \param method Method to use for the request
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetMethod(Method method); void setMethod(Method method);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the requested URI /// \brief Set the requested URI
@ -116,7 +116,7 @@ public :
/// \param uri URI to request, relative to the host /// \param uri URI to request, relative to the host
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetUri(const std::string& uri); void setUri(const std::string& uri);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the HTTP version for the request /// \brief Set the HTTP version for the request
@ -127,7 +127,7 @@ public :
/// \param minor Minor HTTP version number /// \param minor Minor HTTP version number
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetHttpVersion(unsigned int major, unsigned int minor); void setHttpVersion(unsigned int major, unsigned int minor);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the body of the request /// \brief Set the body of the request
@ -139,7 +139,7 @@ public :
/// \param body Content of the body /// \param body Content of the body
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetBody(const std::string& body); void setBody(const std::string& body);
private : private :
@ -154,7 +154,7 @@ public :
/// \return String containing the request, ready to be sent /// \return String containing the request, ready to be sent
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::string Prepare() const; std::string prepare() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check if the request defines a field /// \brief Check if the request defines a field
@ -166,7 +166,7 @@ public :
/// \return True if the field exists, false otherwise /// \return True if the field exists, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool HasField(const std::string& field) const; bool hasField(const std::string& field) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Types // Types
@ -178,7 +178,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
FieldTable m_fields; ///< Fields of the header associated to their value FieldTable m_fields; ///< Fields of the header associated to their value
Method m_method; ///< Method to use for the request Method m_method; ///< Method to use for the request
std::string m_uRI; ///< Target URI of the request std::string m_uri; ///< Target URI of the request
unsigned int m_majorVersion; ///< Major HTTP version unsigned int m_majorVersion; ///< Major HTTP version
unsigned int m_minorVersion; ///< Minor HTTP version unsigned int m_minorVersion; ///< Minor HTTP version
std::string m_body; ///< Body of the request std::string m_body; ///< Body of the request
@ -252,7 +252,7 @@ public :
/// \return Value of the field, or empty string if not found /// \return Value of the field, or empty string if not found
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const std::string& GetField(const std::string& field) const; const std::string& getField(const std::string& field) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the response status code /// \brief Get the response status code
@ -265,27 +265,27 @@ public :
/// \return Status code of the response /// \return Status code of the response
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status GetStatus() const; Status getStatus() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the major HTTP version number of the response /// \brief Get the major HTTP version number of the response
/// ///
/// \return Major HTTP version number /// \return Major HTTP version number
/// ///
/// \see GetMinorHttpVersion /// \see getMinorHttpVersion
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetMajorHttpVersion() const; unsigned int getMajorHttpVersion() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the minor HTTP version number of the response /// \brief Get the minor HTTP version number of the response
/// ///
/// \return Minor HTTP version number /// \return Minor HTTP version number
/// ///
/// \see GetMajorHttpVersion /// \see getMajorHttpVersion
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetMinorHttpVersion() const; unsigned int getMinorHttpVersion() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the body of the response /// \brief Get the body of the response
@ -299,7 +299,7 @@ public :
/// \return The response body /// \return The response body
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const std::string& GetBody() const; const std::string& getBody() const;
private : private :
@ -314,7 +314,7 @@ public :
/// \param data Content of the response to parse /// \param data Content of the response to parse
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Parse(const std::string& data); void parse(const std::string& data);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Types // Types
@ -368,7 +368,7 @@ public :
/// \param port Port to use for connection /// \param port Port to use for connection
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetHost(const std::string& host, unsigned short port = 0); void setHost(const std::string& host, unsigned short port = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Send a HTTP request and return the server's response. /// \brief Send a HTTP request and return the server's response.
@ -388,7 +388,7 @@ public :
/// \return Server's response /// \return Server's response
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Response SendRequest(const Request& request, Time timeout = Time::Zero); Response sendRequest(const Request& request, Time timeout = Time::Zero);
private : private :
@ -444,19 +444,19 @@ private :
/// sf::Http http; /// sf::Http http;
/// ///
/// // We'll work on http://www.sfml-dev.org /// // We'll work on http://www.sfml-dev.org
/// http.SetHost("http://www.sfml-dev.org"); /// http.setHost("http://www.sfml-dev.org");
/// ///
/// // Prepare a request to get the 'features.php' page /// // Prepare a request to get the 'features.php' page
/// sf::Http::Request request("features.php"); /// sf::Http::Request request("features.php");
/// ///
/// // Send the request /// // Send the request
/// sf::Http::Response response = http.SendRequest(request); /// sf::Http::Response response = http.sendRequest(request);
/// ///
/// // Check the status code and display the result /// // Check the status code and display the result
/// sf::Http::Response::Status status = response.GetStatus(); /// sf::Http::Response::Status status = response.getStatus();
/// if (status == sf::Http::Response::Ok) /// if (status == sf::Http::Response::Ok)
/// { /// {
/// std::cout << response.GetBody() << std::endl; /// std::cout << response.getBody() << std::endl;
/// } /// }
/// else /// else
/// { /// {

24
include/SFML/Network/IpAddress.hpp
View file

@ -103,7 +103,7 @@ public :
/// ///
/// \param address 4 bytes of the address packed into a 32-bits integer /// \param address 4 bytes of the address packed into a 32-bits integer
/// ///
/// \see ToInteger /// \see toInteger
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
explicit IpAddress(Uint32 address); explicit IpAddress(Uint32 address);
@ -117,10 +117,10 @@ public :
/// ///
/// \return String representation of the address /// \return String representation of the address
/// ///
/// \see ToInteger /// \see toInteger
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::string ToString() const; std::string toString() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get an integer representation of the address /// \brief Get an integer representation of the address
@ -133,10 +133,10 @@ public :
/// ///
/// \return 32-bits unsigned integer representation of the address /// \return 32-bits unsigned integer representation of the address
/// ///
/// \see ToString /// \see toString
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Uint32 ToInteger() const; Uint32 toInteger() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the computer's local address /// \brief Get the computer's local address
@ -144,15 +144,15 @@ public :
/// The local address is the address of the computer from the /// The local address is the address of the computer from the
/// LAN point of view, i.e. something like 192.168.1.56. It is /// LAN point of view, i.e. something like 192.168.1.56. It is
/// meaningful only for communications over the local network. /// meaningful only for communications over the local network.
/// Unlike GetPublicAddress, this function is fast and may be /// Unlike getPublicAddress, this function is fast and may be
/// used safely anywhere. /// used safely anywhere.
/// ///
/// \return Local IP address of the computer /// \return Local IP address of the computer
/// ///
/// \see GetPublicAddress /// \see getPublicAddress
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static IpAddress GetLocalAddress(); static IpAddress getLocalAddress();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the computer's public address /// \brief Get the computer's public address
@ -173,10 +173,10 @@ public :
/// ///
/// \return Public IP address of the computer /// \return Public IP address of the computer
/// ///
/// \see GetLocalAddress /// \see getLocalAddress
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static IpAddress GetPublicAddress(Time timeout = Time::Zero); static IpAddress getPublicAddress(Time timeout = Time::Zero);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Static member data // Static member data
@ -306,8 +306,8 @@ SFML_NETWORK_API std::ostream& operator <<(std::ostream& stream, const IpAddress
/// sf::IpAddress a5("my_computer"); // a local address created from a network name /// sf::IpAddress a5("my_computer"); // a local address created from a network name
/// sf::IpAddress a6("89.54.1.169"); // a distant address /// sf::IpAddress a6("89.54.1.169"); // a distant address
/// sf::IpAddress a7("www.google.com"); // a distant address created from a network name /// sf::IpAddress a7("www.google.com"); // a distant address created from a network name
/// sf::IpAddress a8 = sf::IpAddress::GetLocalAddress(); // my address on the local network /// sf::IpAddress a8 = sf::IpAddress::getLocalAddress(); // my address on the local network
/// sf::IpAddress a9 = sf::IpAddress::GetPublicAddress(); // my address on the internet /// sf::IpAddress a9 = sf::IpAddress::getPublicAddress(); // my address on the internet
/// \endcode /// \endcode
/// ///
/// Note that sf::IpAddress currently doesn't support IPv6 /// Note that sf::IpAddress currently doesn't support IPv6

48
include/SFML/Network/Packet.hpp
View file

@ -71,20 +71,20 @@ public :
/// \param data Pointer to the sequence of bytes to append /// \param data Pointer to the sequence of bytes to append
/// \param sizeInBytes Number of bytes to append /// \param sizeInBytes Number of bytes to append
/// ///
/// \see Clear /// \see clear
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Append(const void* data, std::size_t sizeInBytes); void append(const void* data, std::size_t sizeInBytes);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Clear the packet /// \brief Clear the packet
/// ///
/// After calling Clear, the packet is empty. /// After calling Clear, the packet is empty.
/// ///
/// \see Append /// \see append
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Clear(); void clear();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a pointer to the data contained in the packet /// \brief Get a pointer to the data contained in the packet
@ -96,23 +96,23 @@ public :
/// ///
/// \return Pointer to the data /// \return Pointer to the data
/// ///
/// \see GetDataSize /// \see getDataSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const char* GetData() const; const char* getData() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the size of the data contained in the packet /// \brief Get the size of the data contained in the packet
/// ///
/// This function returns the number of bytes pointed to by /// This function returns the number of bytes pointed to by
/// what GetData returns. /// what getData returns.
/// ///
/// \return Data size, in bytes /// \return Data size, in bytes
/// ///
/// \see GetData /// \see getData
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t GetDataSize() const; std::size_t getDataSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell if the reading position has reached the /// \brief Tell if the reading position has reached the
@ -126,7 +126,7 @@ public :
/// \see operator bool /// \see operator bool
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool EndOfPacket() const; bool endOfPacket() const;
public: public:
@ -165,7 +165,7 @@ public:
/// ///
/// \return True if last data extraction from packet was successful /// \return True if last data extraction from packet was successful
/// ///
/// \see EndOfPacket /// \see endOfPacket
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
operator BoolType() const; operator BoolType() const;
@ -230,7 +230,7 @@ private :
/// \return True if \a size bytes can be read from the packet /// \return True if \a size bytes can be read from the packet
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool CheckSize(std::size_t size); bool checkSize(std::size_t size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Called before the packet is sent over the network /// \brief Called before the packet is sent over the network
@ -247,10 +247,10 @@ private :
/// ///
/// \return Pointer to the array of bytes to send /// \return Pointer to the array of bytes to send
/// ///
/// \see OnReceive /// \see onReceive
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual const char* OnSend(std::size_t& size); virtual const char* onSend(std::size_t& size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Called after the packet is received over the network /// \brief Called after the packet is received over the network
@ -266,8 +266,10 @@ private :
/// \param data Pointer to the received bytes /// \param data Pointer to the received bytes
/// \param size Number of bytes /// \param size Number of bytes
/// ///
/// \see onSend
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnReceive(const char* data, std::size_t size); virtual void onReceive(const char* data, std::size_t size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -316,13 +318,13 @@ private :
/// packet << x << s << d; /// packet << x << s << d;
/// ///
/// // Send it over the network (socket is a valid sf::TcpSocket) /// // Send it over the network (socket is a valid sf::TcpSocket)
/// socket.Send(packet); /// socket.send(packet);
/// ///
/// ----------------------------------------------------------------- /// -----------------------------------------------------------------
/// ///
/// // Receive the packet at the other end /// // Receive the packet at the other end
/// sf::Packet packet; /// sf::Packet packet;
/// socket.Receive(packet); /// socket.receive(packet);
/// ///
/// // Extract the variables contained in the packet /// // Extract the variables contained in the packet
/// sf::Uint32 x; /// sf::Uint32 x;
@ -369,26 +371,26 @@ private :
/// and after it is received. This is typically used to /// and after it is received. This is typically used to
/// handle automatic compression or encryption of the data. /// handle automatic compression or encryption of the data.
/// This is achieved by inheriting from sf::Packet, and overriding /// This is achieved by inheriting from sf::Packet, and overriding
/// the OnSend and OnReceive functions. /// the onSend and onReceive functions.
/// ///
/// Here is an example: /// Here is an example:
/// \code /// \code
/// class ZipPacket : public sf::Packet /// class ZipPacket : public sf::Packet
/// { /// {
/// virtual const char* OnSend(std::size_t& size) /// virtual const char* onSend(std::size_t& size)
/// { /// {
/// const char* srcData = GetData(); /// const char* srcData = getData();
/// std::size_t srcSize = GetDataSize(); /// std::size_t srcSize = getDataSize();
/// ///
/// return MySuperZipFunction(srcData, srcSize, &size); /// return MySuperZipFunction(srcData, srcSize, &size);
/// } /// }
/// ///
/// virtual void OnReceive(const char* data, std::size_t size) /// virtual void onReceive(const char* data, std::size_t size)
/// { /// {
/// std::size_t dstSize; /// std::size_t dstSize;
/// const char* dstData = MySuperUnzipFunction(data, size, &dstSize); /// const char* dstData = MySuperUnzipFunction(data, size, &dstSize);
/// ///
/// Append(dstData, dstSize); /// append(dstData, dstSize);
/// } /// }
/// }; /// };
/// ///

16
include/SFML/Network/Socket.hpp
View file

@ -89,20 +89,20 @@ public :
/// ///
/// \param blocking True to set the socket as blocking, false for non-blocking /// \param blocking True to set the socket as blocking, false for non-blocking
/// ///
/// \see IsBlocking /// \see isBlocking
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetBlocking(bool blocking); void setBlocking(bool blocking);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether the socket is in blocking or non-blocking mode /// \brief Tell whether the socket is in blocking or non-blocking mode
/// ///
/// \return True if the socket is blocking, false otherwise /// \return True if the socket is blocking, false otherwise
/// ///
/// \see SetBlocking /// \see setBlocking
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsBlocking() const; bool isBlocking() const;
protected : protected :
@ -136,7 +136,7 @@ protected :
/// \return The internal (OS-specific) handle of the socket /// \return The internal (OS-specific) handle of the socket
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SocketHandle GetHandle() const; SocketHandle getHandle() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create the internal representation of the socket /// \brief Create the internal representation of the socket
@ -144,7 +144,7 @@ protected :
/// This function can only be accessed by derived classes. /// This function can only be accessed by derived classes.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Create(); void create();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create the internal representation of the socket /// \brief Create the internal representation of the socket
@ -155,7 +155,7 @@ protected :
/// \param handle OS-specific handle of the socket to wrap /// \param handle OS-specific handle of the socket to wrap
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Create(SocketHandle handle); void create(SocketHandle handle);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Close the socket gracefully /// \brief Close the socket gracefully
@ -163,7 +163,7 @@ protected :
/// This function can only be accessed by derived classes. /// This function can only be accessed by derived classes.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Close(); void close();
private : private :

38
include/SFML/Network/SocketSelector.hpp
View file

@ -73,10 +73,10 @@ public :
/// ///
/// \param socket Reference to the socket to add /// \param socket Reference to the socket to add
/// ///
/// \see Remove, Clear /// \see remove, clear
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Add(Socket& socket); void add(Socket& socket);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Remove a socket from the selector /// \brief Remove a socket from the selector
@ -86,10 +86,10 @@ public :
/// ///
/// \param socket Reference to the socket to remove /// \param socket Reference to the socket to remove
/// ///
/// \see Add, Clear /// \see add, clear
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Remove(Socket& socket); void remove(Socket& socket);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Remove all the sockets stored in the selector /// \brief Remove all the sockets stored in the selector
@ -98,17 +98,17 @@ public :
/// removes all the references that the selector has to /// removes all the references that the selector has to
/// external sockets. /// external sockets.
/// ///
/// \see Add, Remove /// \see add, remove
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Clear(); void clear();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Wait until one or more sockets are ready to receive /// \brief Wait until one or more sockets are ready to receive
/// ///
/// This function returns as soon as at least one socket has /// This function returns as soon as at least one socket has
/// some data available to be received. To know which sockets are /// some data available to be received. To know which sockets are
/// ready, use the IsReady function. /// ready, use the isReady function.
/// If you use a timeout and no socket is ready before the timeout /// If you use a timeout and no socket is ready before the timeout
/// is over, the function returns false. /// is over, the function returns false.
/// ///
@ -116,17 +116,17 @@ public :
/// ///
/// \return True if there are sockets ready, false otherwise /// \return True if there are sockets ready, false otherwise
/// ///
/// \see IsReady /// \see isReady
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Wait(Time timeout = Time::Zero); bool wait(Time timeout = Time::Zero);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Test a socket to know if it is ready to receive data /// \brief Test a socket to know if it is ready to receive data
/// ///
/// This function must be used after a call to Wait, to know /// This function must be used after a call to Wait, to know
/// which sockets are ready to receive data. If a socket is /// which sockets are ready to receive data. If a socket is
/// ready, a call to Receive will never block because we know /// ready, a call to receive will never block because we know
/// that there is data available to read. /// that there is data available to read.
/// Note that if this function returns true for a TcpListener, /// Note that if this function returns true for a TcpListener,
/// this means that it is ready to accept a new connection. /// this means that it is ready to accept a new connection.
@ -135,10 +135,10 @@ public :
/// ///
/// \return True if the socket is ready to read, false otherwise /// \return True if the socket is ready to read, false otherwise
/// ///
/// \see IsReady /// \see isReady
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsReady(Socket& socket) const; bool isReady(Socket& socket) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Overload of assignment operator /// \brief Overload of assignment operator
@ -199,7 +199,7 @@ private :
/// \code /// \code
/// // Create a socket to listen to new connections /// // Create a socket to listen to new connections
/// sf::TcpListener listener; /// sf::TcpListener listener;
/// listener.Listen(55001); /// listener.listen(55001);
/// ///
/// // Create a list to store the future clients /// // Create a list to store the future clients
/// std::list<sf::TcpSocket*> clients; /// std::list<sf::TcpSocket*> clients;
@ -208,16 +208,16 @@ private :
/// sf::SocketSelector selector; /// sf::SocketSelector selector;
/// ///
/// // Add the listener to the selector /// // Add the listener to the selector
/// selector.Add(listener); /// selector.add(listener);
/// ///
/// // Endless loop that waits for new connections /// // Endless loop that waits for new connections
/// while (running) /// while (running)
/// { /// {
/// // Make the selector wait for data on any socket /// // Make the selector wait for data on any socket
/// if (selector.Wait()) /// if (selector.wait())
/// { /// {
/// // Test the listener /// // Test the listener
/// if (selector.IsReady(listener)) /// if (selector.isReady(listener))
/// { /// {
/// // The listener is ready: there is a pending connection /// // The listener is ready: there is a pending connection
/// sf::TcpSocket* client = new sf::TcpSocket; /// sf::TcpSocket* client = new sf::TcpSocket;
@ -228,7 +228,7 @@ private :
/// ///
/// // Add the new client to the selector so that we will /// // Add the new client to the selector so that we will
/// // be notified when he sends something /// // be notified when he sends something
/// selector.Add(*client); /// selector.add(*client);
/// } /// }
/// } /// }
/// else /// else
@ -237,11 +237,11 @@ private :
/// for (std::list<sf::TcpSocket*>::iterator it = clients.begin(); it != clients.end(); ++it) /// for (std::list<sf::TcpSocket*>::iterator it = clients.begin(); it != clients.end(); ++it)
/// { /// {
/// sf::TcpSocket& client = **it; /// sf::TcpSocket& client = **it;
/// if (selector.IsReady(client)) /// if (selector.isReady(client))
/// { /// {
/// // The client has sent some data, we can receive it /// // The client has sent some data, we can receive it
/// sf::Packet packet; /// sf::Packet packet;
/// if (client.Receive(packet) == sf::Socket::Done) /// if (client.receive(packet) == sf::Socket::Done)
/// { /// {
/// ... /// ...
/// } /// }

28
include/SFML/Network/TcpListener.hpp
View file

@ -58,10 +58,10 @@ public :
/// ///
/// \return Port to which the socket is bound /// \return Port to which the socket is bound
/// ///
/// \see Listen /// \see listen
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned short GetLocalPort() const; unsigned short getLocalPort() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Start listening for connections /// \brief Start listening for connections
@ -75,10 +75,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Accept, Close /// \see accept, close
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Listen(unsigned short port); Status listen(unsigned short port);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Stop listening and close the socket /// \brief Stop listening and close the socket
@ -86,10 +86,10 @@ public :
/// This function gracefully stops the listener. If the /// This function gracefully stops the listener. If the
/// socket is not listening, this function has no effect. /// socket is not listening, this function has no effect.
/// ///
/// \see Listen /// \see listen
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Close(); void close();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Accept a new connection /// \brief Accept a new connection
@ -101,10 +101,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Listen /// \see listen
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Accept(TcpSocket& socket); Status accept(TcpSocket& socket);
}; };
@ -122,7 +122,7 @@ public :
/// a given port and waits for connections on that port. /// a given port and waits for connections on that port.
/// This is all it can do. /// This is all it can do.
/// ///
/// When a new connection is received, you must call Accept and /// When a new connection is received, you must call accept and
/// the listener returns a new instance of sf::TcpSocket that /// the listener returns a new instance of sf::TcpSocket that
/// is properly initialized and can be used to communicate with /// is properly initialized and can be used to communicate with
/// the new client. /// the new client.
@ -134,7 +134,7 @@ public :
/// ///
/// A listener is automatically closed on destruction, like all /// A listener is automatically closed on destruction, like all
/// other types of socket. However if you want to stop listening /// other types of socket. However if you want to stop listening
/// before the socket is destroyed, you can call its Close() /// before the socket is destroyed, you can call its close()
/// function. /// function.
/// ///
/// Usage example: /// Usage example:
@ -142,17 +142,17 @@ public :
/// // Create a listener socket and make it wait for new /// // Create a listener socket and make it wait for new
/// // connections on port 55001 /// // connections on port 55001
/// sf::TcpListener listener; /// sf::TcpListener listener;
/// listener.Listen(55001); /// listener.listen(55001);
/// ///
/// // Endless loop that waits for new connections /// // Endless loop that waits for new connections
/// while (running) /// while (running)
/// { /// {
/// sf::TcpSocket client; /// sf::TcpSocket client;
/// if (listener.Accept(client) == sf::Socket::Done) /// if (listener.accept(client) == sf::Socket::Done)
/// { /// {
/// // A new client just connected! /// // A new client just connected!
/// std::cout << "New connection received from " << client.GetRemoteAddress() << std::endl; /// std::cout << "New connection received from " << client.getRemoteAddress() << std::endl;
/// DoSomethingWith(client); /// doSomethingWith(client);
/// } /// }
/// } /// }
/// \endcode /// \endcode

56
include/SFML/Network/TcpSocket.hpp
View file

@ -60,10 +60,10 @@ public :
/// ///
/// \return Port to which the socket is bound /// \return Port to which the socket is bound
/// ///
/// \see Connect, GetRemotePort /// \see connect, getRemotePort
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned short GetLocalPort() const; unsigned short getLocalPort() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the address of the connected peer /// \brief Get the address of the connected peer
@ -73,10 +73,10 @@ public :
/// ///
/// \return Address of the remote peer /// \return Address of the remote peer
/// ///
/// \see GetRemotePort /// \see getRemotePort
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
IpAddress GetRemoteAddress() const; IpAddress getRemoteAddress() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the port of the connected peer to which /// \brief Get the port of the connected peer to which
@ -86,10 +86,10 @@ public :
/// ///
/// \return Remote port to which the socket is connected /// \return Remote port to which the socket is connected
/// ///
/// \see GetRemoteAddress /// \see getRemoteAddress
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned short GetRemotePort() const; unsigned short getRemotePort() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Connect the socket to a remote peer /// \brief Connect the socket to a remote peer
@ -105,10 +105,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Disconnect /// \see disconnect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Connect(const IpAddress& remoteAddress, unsigned short remotePort, Time timeout = Time::Zero); Status connect(const IpAddress& remoteAddress, unsigned short remotePort, Time timeout = Time::Zero);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Disconnect the socket from its remote peer /// \brief Disconnect the socket from its remote peer
@ -119,7 +119,7 @@ public :
/// \see Connect /// \see Connect
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Disconnect(); void disconnect();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Send raw data to the remote peer /// \brief Send raw data to the remote peer
@ -131,10 +131,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Receive /// \see receive
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Send(const char* data, std::size_t size); Status send(const char* data, std::size_t size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Receive raw data from the remote peer /// \brief Receive raw data from the remote peer
@ -149,10 +149,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Send /// \see send
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Receive(char* data, std::size_t size, std::size_t& received); Status receive(char* data, std::size_t size, std::size_t& received);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Send a formatted packet of data to the remote peer /// \brief Send a formatted packet of data to the remote peer
@ -163,10 +163,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Receive /// \see receive
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Send(Packet& packet); Status send(Packet& packet);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Receive a formatted packet of data from the remote peer /// \brief Receive a formatted packet of data from the remote peer
@ -179,10 +179,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Send /// \see send
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Receive(Packet& packet); Status receive(Packet& packet);
private: private:
@ -227,10 +227,10 @@ private:
/// ///
/// When a socket is connected to a remote host, you can /// When a socket is connected to a remote host, you can
/// retrieve informations about this host with the /// retrieve informations about this host with the
/// GetRemoteAddress and GetRemotePort functions. You can /// getRemoteAddress and GetRemotePort functions. You can
/// also get the local port to which the socket is bound /// also get the local port to which the socket is bound
/// (which is automatically chosen when the socket is connected), /// (which is automatically chosen when the socket is connected),
/// with the GetLocalPort function. /// with the getLocalPort function.
/// ///
/// Sending and receiving data can use either the low-level /// Sending and receiving data can use either the low-level
/// or the high-level functions. The low-level functions /// or the high-level functions. The low-level functions
@ -245,7 +245,7 @@ private:
/// ///
/// The socket is automatically disconnected when it is destroyed, /// The socket is automatically disconnected when it is destroyed,
/// but if you want to explicitely close the connection while /// but if you want to explicitely close the connection while
/// the socket instance is still alive, you can call Disconnect. /// the socket instance is still alive, you can call disconnect.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
@ -253,38 +253,38 @@ private:
/// ///
/// // Create a socket and connect it to 192.168.1.50 on port 55001 /// // Create a socket and connect it to 192.168.1.50 on port 55001
/// sf::TcpSocket socket; /// sf::TcpSocket socket;
/// socket.Connect("192.168.1.50", 55001); /// socket.connect("192.168.1.50", 55001);
/// ///
/// // Send a message to the connected host /// // Send a message to the connected host
/// std::string message = "Hi, I am a client"; /// std::string message = "Hi, I am a client";
/// socket.Send(message.c_str(), message.size() + 1); /// socket.send(message.c_str(), message.size() + 1);
/// ///
/// // Receive an answer from the server /// // Receive an answer from the server
/// char buffer[1024]; /// char buffer[1024];
/// std::size_t received = 0; /// std::size_t received = 0;
/// socket.Receive(buffer, sizeof(buffer), received); /// socket.receive(buffer, sizeof(buffer), received);
/// std::cout << "The server said: " << buffer << std::endl; /// std::cout << "The server said: " << buffer << std::endl;
/// ///
/// // ----- The server ----- /// // ----- The server -----
/// ///
/// // Create a listener to wait for incoming connections on port 55001 /// // Create a listener to wait for incoming connections on port 55001
/// sf::TcpListener listener; /// sf::TcpListener listener;
/// listener.Listen(55001); /// listener.listen(55001);
/// ///
/// // Wait for a connection /// // Wait for a connection
/// sf::TcpSocket socket; /// sf::TcpSocket socket;
/// listener.Accept(socket); /// listener.accept(socket);
/// std::cout << "New client connected: " << socket.GetRemoteAddress() << std::endl; /// std::cout << "New client connected: " << socket.getRemoteAddress() << std::endl;
/// ///
/// // Receive a message from the client /// // Receive a message from the client
/// char buffer[1024]; /// char buffer[1024];
/// std::size_t received = 0; /// std::size_t received = 0;
/// socket.Receive(buffer, sizeof(buffer), received); /// socket.receive(buffer, sizeof(buffer), received);
/// std::cout << "The client said: " << buffer << std::endl; /// std::cout << "The client said: " << buffer << std::endl;
/// ///
/// // Send an answer /// // Send an answer
/// std::string message = "Welcome, client"; /// std::string message = "Welcome, client";
/// socket.Send(message.c_str(), message.size() + 1); /// socket.send(message.c_str(), message.size() + 1);
/// \endcode /// \endcode
/// ///
/// \see sf::Socket, sf::UdpSocket, sf::Packet /// \see sf::Socket, sf::UdpSocket, sf::Packet

52
include/SFML/Network/UdpSocket.hpp
View file

@ -68,10 +68,10 @@ public :
/// ///
/// \return Port to which the socket is bound /// \return Port to which the socket is bound
/// ///
/// \see Bind /// \see bind
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned short GetLocalPort() const; unsigned short getLocalPort() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Bind the socket to a specific port /// \brief Bind the socket to a specific port
@ -80,16 +80,16 @@ public :
/// able to receive data on that port. /// able to receive data on that port.
/// You can use the special value Socket::AnyPort to tell the /// You can use the special value Socket::AnyPort to tell the
/// system to automatically pick an available port, and then /// system to automatically pick an available port, and then
/// call GetLocalPort to retrieve the chosen port. /// call getLocalPort to retrieve the chosen port.
/// ///
/// \param port Port to bind the socket to /// \param port Port to bind the socket to
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Unbind, GetLocalPort /// \see unbind, getLocalPort
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Bind(unsigned short port); Status bind(unsigned short port);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Unbind the socket from the local port to which it is bound /// \brief Unbind the socket from the local port to which it is bound
@ -98,10 +98,10 @@ public :
/// available after this function is called. If the /// available after this function is called. If the
/// socket is not bound to a port, this function has no effect. /// socket is not bound to a port, this function has no effect.
/// ///
/// \see Bind /// \see bind
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Unbind(); void unbind();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Send raw data to a remote peer /// \brief Send raw data to a remote peer
@ -117,10 +117,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Receive /// \see receive
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Send(const char* data, std::size_t size, const IpAddress& remoteAddress, unsigned short remotePort); Status send(const char* data, std::size_t size, const IpAddress& remoteAddress, unsigned short remotePort);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Receive raw data from a remote peer /// \brief Receive raw data from a remote peer
@ -140,10 +140,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Send /// \see send
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Receive(char* data, std::size_t size, std::size_t& received, IpAddress& remoteAddress, unsigned short& remotePort); Status receive(char* data, std::size_t size, std::size_t& received, IpAddress& remoteAddress, unsigned short& remotePort);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Send a formatted packet of data to a remote peer /// \brief Send a formatted packet of data to a remote peer
@ -158,18 +158,16 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Receive /// \see receive
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Send(Packet& packet, const IpAddress& remoteAddress, unsigned short remotePort); Status send(Packet& packet, const IpAddress& remoteAddress, unsigned short remotePort);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Receive a formatted packet of data from a remote peer /// \brief Receive a formatted packet of data from a remote peer
/// ///
/// In blocking mode, this function will wait until the whole packet /// In blocking mode, this function will wait until the whole packet
/// has been received. /// has been received.
/// Warning: this functon doesn't properly handle mixed data
/// received from multiple peers.
/// ///
/// \param packet Packet to fill with the received data /// \param packet Packet to fill with the received data
/// \param remoteAddress Address of the peer that sent the data /// \param remoteAddress Address of the peer that sent the data
@ -177,10 +175,10 @@ public :
/// ///
/// \return Status code /// \return Status code
/// ///
/// \see Send /// \see send
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Status Receive(Packet& packet, IpAddress& remoteAddress, unsigned short& remotePort); Status receive(Packet& packet, IpAddress& remoteAddress, unsigned short& remotePort);
private: private:
@ -206,8 +204,8 @@ private:
/// ///
/// It is a datagram protocol: bounded blocks of data (datagrams) /// It is a datagram protocol: bounded blocks of data (datagrams)
/// are transfered over the network rather than a continuous /// are transfered over the network rather than a continuous
/// stream of data (TCP). Therefore, one call to Send will always /// stream of data (TCP). Therefore, one call to send will always
/// match one call to Receive (if the datagram is not lost), /// match one call to receive (if the datagram is not lost),
/// with the same data that was sent. /// with the same data that was sent.
/// ///
/// The UDP protocol is lightweight but unreliable. Unreliable /// The UDP protocol is lightweight but unreliable. Unreliable
@ -247,37 +245,37 @@ private:
/// ///
/// // Create a socket and bind it to the port 55001 /// // Create a socket and bind it to the port 55001
/// sf::UdpSocket socket; /// sf::UdpSocket socket;
/// socket.Bind(55001); /// socket.bind(55001);
/// ///
/// // Send a message to 192.168.1.50 on port 55002 /// // Send a message to 192.168.1.50 on port 55002
/// std::string message = "Hi, I am " + sf::IpAddress::GetLocalAddress().ToString(); /// std::string message = "Hi, I am " + sf::IpAddress::getLocalAddress().toString();
/// socket.Send(message.c_str(), message.size() + 1, "192.168.1.50", 55002); /// socket.send(message.c_str(), message.size() + 1, "192.168.1.50", 55002);
/// ///
/// // Receive an answer (most likely from 192.168.1.50, but could be anyone else) /// // Receive an answer (most likely from 192.168.1.50, but could be anyone else)
/// char buffer[1024]; /// char buffer[1024];
/// std::size_t received = 0; /// std::size_t received = 0;
/// sf::IpAddress sender; /// sf::IpAddress sender;
/// unsigned short port; /// unsigned short port;
/// socket.Receive(buffer, sizeof(buffer), received, sender, port); /// socket.receive(buffer, sizeof(buffer), received, sender, port);
/// std::cout << sender.ToString() << " said: " << buffer << std::endl; /// std::cout << sender.ToString() << " said: " << buffer << std::endl;
/// ///
/// // ----- The server ----- /// // ----- The server -----
/// ///
/// // Create a socket and bind it to the port 55002 /// // Create a socket and bind it to the port 55002
/// sf::UdpSocket socket; /// sf::UdpSocket socket;
/// socket.Bind(55002); /// socket.bind(55002);
/// ///
/// // Receive a message from anyone /// // Receive a message from anyone
/// char buffer[1024]; /// char buffer[1024];
/// std::size_t received = 0; /// std::size_t received = 0;
/// sf::IpAddress sender; /// sf::IpAddress sender;
/// unsigned short port; /// unsigned short port;
/// socket.Receive(buffer, sizeof(buffer), received, sender, port); /// socket.receive(buffer, sizeof(buffer), received, sender, port);
/// std::cout << sender.ToString() << " said: " << buffer << std::endl; /// std::cout << sender.ToString() << " said: " << buffer << std::endl;
/// ///
/// // Send an answer /// // Send an answer
/// std::string message = "Welcome " + sender.ToString(); /// std::string message = "Welcome " + sender.toString();
/// socket.Send(message.c_str(), message.size() + 1, sender, port); /// socket.send(message.c_str(), message.size() + 1, sender, port);
/// \endcode /// \endcode
/// ///
/// \see sf::Socket, sf::TcpSocket, sf::Packet /// \see sf::Socket, sf::TcpSocket, sf::Packet

10
include/SFML/System/Clock.hpp
View file

@ -54,13 +54,13 @@ public :
/// \brief Get the elapsed time /// \brief Get the elapsed time
/// ///
/// This function returns the time elapsed since the last call /// This function returns the time elapsed since the last call
/// to Restart() (or the construction of the instance if Restart() /// to restart() (or the construction of the instance if restart()
/// has not been called). /// has not been called).
/// ///
/// \return Time elapsed /// \return Time elapsed
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time GetElapsedTime() const; Time getElapsedTime() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Restart the clock /// \brief Restart the clock
@ -71,7 +71,7 @@ public :
/// \return Time elapsed /// \return Time elapsed
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time Restart(); Time restart();
private : private :
@ -103,9 +103,9 @@ private :
/// \code /// \code
/// sf::Clock clock; /// sf::Clock clock;
/// ... /// ...
/// Time time1 = clock.GetElapsedTime(); /// Time time1 = clock.getElapsedTime();
/// ... /// ...
/// Time time2 = clock.Restart(); /// Time time2 = clock.restart();
/// \endcode /// \endcode
/// ///
/// The sf::Time value returned by the clock can then be /// The sf::Time value returned by the clock can then be

12
include/SFML/System/Err.hpp
View file

@ -38,7 +38,7 @@ namespace sf
/// \brief Standard stream used by SFML to output warnings and errors /// \brief Standard stream used by SFML to output warnings and errors
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SFML_SYSTEM_API std::ostream& Err(); SFML_SYSTEM_API std::ostream& err();
} // namespace sf } // namespace sf
@ -50,7 +50,7 @@ SFML_SYSTEM_API std::ostream& Err();
/// \fn sf::Err /// \fn sf::Err
/// \ingroup system /// \ingroup system
/// ///
/// By default, sf::Err() outputs to the same location as std::cerr, /// By default, sf::err() outputs to the same location as std::cerr,
/// (-> the stderr descriptor) which is the console if there's /// (-> the stderr descriptor) which is the console if there's
/// one available. /// one available.
/// ///
@ -58,7 +58,7 @@ SFML_SYSTEM_API std::ostream& Err();
/// insertion operations defined by the STL /// insertion operations defined by the STL
/// (operator <<, manipulators, etc.). /// (operator <<, manipulators, etc.).
/// ///
/// sf::Err() can be redirected to write to another output, independantly /// sf::err() can be redirected to write to another output, independantly
/// of std::cerr, by using the rdbuf() function provided by the /// of std::cerr, by using the rdbuf() function provided by the
/// std::ostream class. /// std::ostream class.
/// ///
@ -66,13 +66,13 @@ SFML_SYSTEM_API std::ostream& Err();
/// \code /// \code
/// // Redirect to a file /// // Redirect to a file
/// std::ofstream file("sfml-log.txt"); /// std::ofstream file("sfml-log.txt");
/// std::streambuf* previous = sf::Err().rdbuf(file.rdbuf()); /// std::streambuf* previous = sf::err().rdbuf(file.rdbuf());
/// ///
/// // Redirect to nothing /// // Redirect to nothing
/// sf::Err().rdbuf(NULL); /// sf::err().rdbuf(NULL);
/// ///
/// // Restore the original output /// // Restore the original output
/// sf::Err().rdbuf(previous); /// sf::err().rdbuf(previous);
/// \endcode /// \endcode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

30
include/SFML/System/InputStream.hpp
View file

@ -56,7 +56,7 @@ public :
/// \return The number of bytes actually read /// \return The number of bytes actually read
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Int64 Read(char* data, Int64 size) = 0; virtual Int64 read(char* data, Int64 size) = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current reading position /// \brief Change the current reading position
@ -66,7 +66,7 @@ public :
/// \return The position actually sought to, or -1 on error /// \return The position actually sought to, or -1 on error
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Int64 Seek(Int64 position) = 0; virtual Int64 seek(Int64 position) = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current reading position in the stream /// \brief Get the current reading position in the stream
@ -74,7 +74,7 @@ public :
/// \return The current position, or -1 on error. /// \return The current position, or -1 on error.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Int64 Tell() = 0; virtual Int64 tell() = 0;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the size of the stream /// \brief Return the size of the stream
@ -82,7 +82,7 @@ public :
/// \return The total number of bytes available in the stream, or -1 on error /// \return The total number of bytes available in the stream, or -1 on error
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Int64 GetSize() = 0; virtual Int64 getSize() = 0;
}; };
} // namespace sf } // namespace sf
@ -99,12 +99,12 @@ public :
/// from which SFML can load resources. /// from which SFML can load resources.
/// ///
/// SFML resource classes like sf::Texture and /// SFML resource classes like sf::Texture and
/// sf::SoundBuffer provide LoadFromFile and LoadFromMemory functions, /// sf::SoundBuffer provide loadFromFile and loadFromMemory functions,
/// which read data from conventional sources. However, if you /// which read data from conventional sources. However, if you
/// have data coming from a different source (over a network, /// have data coming from a different source (over a network,
/// embedded, encrypted, compressed, etc) you can derive your /// embedded, encrypted, compressed, etc) you can derive your
/// own class from sf::InputStream and load SFML resources with /// own class from sf::InputStream and load SFML resources with
/// their LoadFromStream function. /// their loadFromStream function.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
@ -115,15 +115,15 @@ public :
/// ///
/// ZipStream(std::string archive); /// ZipStream(std::string archive);
/// ///
/// bool Open(std::string filename); /// bool open(std::string filename);
/// ///
/// Int64 Read(char* data, Int64 size); /// Int64 read(char* data, Int64 size);
/// ///
/// Int64 Seek(Int64 position); /// Int64 seek(Int64 position);
/// ///
/// Int64 Tell(); /// Int64 tell();
/// ///
/// Int64 GetSize(); /// Int64 getSize();
/// ///
/// private : /// private :
/// ///
@ -133,14 +133,14 @@ public :
/// // now you can load textures... /// // now you can load textures...
/// sf::Texture texture; /// sf::Texture texture;
/// ZipStream stream("resources.zip"); /// ZipStream stream("resources.zip");
/// stream.Open("images/img.png"); /// stream.open("images/img.png");
/// texture.LoadFromStream(stream); /// texture.loadFromStream(stream);
/// ///
/// // musics... /// // musics...
/// sf::Music music; /// sf::Music music;
/// ZipStream stream("resources.zip"); /// ZipStream stream("resources.zip");
/// stream.Open("musics/msc.ogg"); /// stream.open("musics/msc.ogg");
/// music.OpenFromStream(stream); /// music.openFromStream(stream);
/// ///
/// // etc. /// // etc.
/// \endcode /// \endcode

16
include/SFML/System/Mutex.hpp
View file

@ -70,7 +70,7 @@ public :
/// \see Unlock /// \see Unlock
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Lock(); void lock();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Unlock the mutex /// \brief Unlock the mutex
@ -78,7 +78,7 @@ public :
/// \see Lock /// \see Lock
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Unlock(); void unlock();
private : private :
@ -115,16 +115,16 @@ private :
/// ///
/// void thread1() /// void thread1()
/// { /// {
/// mutex.Lock(); // this call will block the thread if the mutex is already locked by thread2 /// mutex.lock(); // this call will block the thread if the mutex is already locked by thread2
/// database.write(...); /// database.write(...);
/// mutex.Unlock(); // if thread2 was waiting, it will now be unblocked /// mutex.unlock(); // if thread2 was waiting, it will now be unblocked
/// } /// }
/// ///
/// void thread2() /// void thread2()
/// { /// {
/// mutex.Lock(); // this call will block the thread if the mutex is already locked by thread1 /// mutex.lock(); // this call will block the thread if the mutex is already locked by thread1
/// database.write(...); /// database.write(...);
/// mutex.Unlock(); // if thread1 was waiting, it will now be unblocked /// mutex.unlock(); // if thread1 was waiting, it will now be unblocked
/// } /// }
/// \endcode /// \endcode
/// ///
@ -140,8 +140,8 @@ private :
/// a mutex multiple times in the same thread without creating /// a mutex multiple times in the same thread without creating
/// a deadlock. In this case, the first call to Lock() behaves /// a deadlock. In this case, the first call to Lock() behaves
/// as usual, and the following ones have no effect. /// as usual, and the following ones have no effect.
/// However, you must call Unlock() exactly as many times as you /// However, you must call unlock() exactly as many times as you
/// called Lock(). If you don't, the mutex won't be released. /// called lock(). If you don't, the mutex won't be released.
/// ///
/// \see sf::Lock /// \see sf::Lock
/// ///

4
include/SFML/System/Sleep.hpp
View file

@ -38,13 +38,13 @@ namespace sf
/// \ingroup system /// \ingroup system
/// \brief Make the current thread sleep for a given duration /// \brief Make the current thread sleep for a given duration
/// ///
/// sf::Sleep is the best way to block a program or one of its /// sf::sleep is the best way to block a program or one of its
/// threads, as it doesn't consume any CPU power. /// threads, as it doesn't consume any CPU power.
/// ///
/// \param duration Time to sleep /// \param duration Time to sleep
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SFML_SYSTEM_API Sleep(Time duration); void SFML_SYSTEM_API sleep(Time duration);
} // namespace sf } // namespace sf

56
include/SFML/System/String.hpp
View file

@ -159,15 +159,15 @@ public :
/// \brief Implicit cast operator to std::string (ANSI string) /// \brief Implicit cast operator to std::string (ANSI string)
/// ///
/// The current global locale is used for conversion. If you /// The current global locale is used for conversion. If you
/// want to explicitely specify a locale, see ToAnsiString. /// want to explicitely specify a locale, see toAnsiString.
/// Characters that do not fit in the target encoding are /// Characters that do not fit in the target encoding are
/// discarded from the returned string. /// discarded from the returned string.
/// This operator is defined for convenience, and is equivalent /// This operator is defined for convenience, and is equivalent
/// to calling ToAnsiString(). /// to calling toAnsiString().
/// ///
/// \return Converted ANSI string /// \return Converted ANSI string
/// ///
/// \see ToAnsiString, operator std::wstring /// \see toAnsiString, operator std::wstring
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
operator std::string() const; operator std::string() const;
@ -178,11 +178,11 @@ public :
/// Characters that do not fit in the target encoding are /// Characters that do not fit in the target encoding are
/// discarded from the returned string. /// discarded from the returned string.
/// This operator is defined for convenience, and is equivalent /// This operator is defined for convenience, and is equivalent
/// to calling ToWideString(). /// to calling toWideString().
/// ///
/// \return Converted wide string /// \return Converted wide string
/// ///
/// \see ToWideString, operator std::string /// \see toWideString, operator std::string
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
operator std::wstring() const; operator std::wstring() const;
@ -199,10 +199,10 @@ public :
/// ///
/// \return Converted ANSI string /// \return Converted ANSI string
/// ///
/// \see ToWideString, operator std::string /// \see toWideString, operator std::string
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::string ToAnsiString(const std::locale& locale = std::locale()) const; std::string toAnsiString(const std::locale& locale = std::locale()) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert the unicode string to a wide string /// \brief Convert the unicode string to a wide string
@ -212,10 +212,10 @@ public :
/// ///
/// \return Converted wide string /// \return Converted wide string
/// ///
/// \see ToAnsiString, operator std::wstring /// \see toAnsiString, operator std::wstring
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::wstring ToWideString() const; std::wstring toWideString() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Overload of assignment operator /// \brief Overload of assignment operator
@ -268,30 +268,30 @@ public :
/// ///
/// This function removes all the characters from the string. /// This function removes all the characters from the string.
/// ///
/// \see IsEmpty, Erase /// \see isEmpty, erase
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Clear(); void clear();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the size of the string /// \brief Get the size of the string
/// ///
/// \return Number of characters in the string /// \return Number of characters in the string
/// ///
/// \see IsEmpty /// \see isEmpty
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t GetSize() const; std::size_t getSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check whether the string is empty or not /// \brief Check whether the string is empty or not
/// ///
/// \return True if the string is empty (i.e. contains no character) /// \return True if the string is empty (i.e. contains no character)
/// ///
/// \see Clear, GetSize /// \see clear, getSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsEmpty() const; bool isEmpty() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Erase one or more characters from the string /// \brief Erase one or more characters from the string
@ -303,7 +303,7 @@ public :
/// \param count Number of characters to erase /// \param count Number of characters to erase
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Erase(std::size_t position, std::size_t count = 1); void erase(std::size_t position, std::size_t count = 1);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Insert one or more characters into the string /// \brief Insert one or more characters into the string
@ -315,7 +315,7 @@ public :
/// \param str Characters to insert /// \param str Characters to insert
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Insert(std::size_t position, const String& str); void insert(std::size_t position, const String& str);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Find a sequence of one or more characters in the string /// \brief Find a sequence of one or more characters in the string
@ -329,7 +329,7 @@ public :
/// \return Position of \a str in the string, or String::InvalidPos if not found /// \return Position of \a str in the string, or String::InvalidPos if not found
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t Find(const String& str, std::size_t start = 0) const; std::size_t find(const String& str, std::size_t start = 0) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a pointer to the C-style array of characters /// \brief Get a pointer to the C-style array of characters
@ -342,27 +342,27 @@ public :
/// \return Read-only pointer to the array of characters /// \return Read-only pointer to the array of characters
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Uint32* GetData() const; const Uint32* getData() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return an iterator to the beginning of the string /// \brief Return an iterator to the beginning of the string
/// ///
/// \return Read-write iterator to the beginning of the string characters /// \return Read-write iterator to the beginning of the string characters
/// ///
/// \see End /// \see end
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Iterator Begin(); Iterator begin();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return an iterator to the beginning of the string /// \brief Return an iterator to the beginning of the string
/// ///
/// \return Read-only iterator to the beginning of the string characters /// \return Read-only iterator to the beginning of the string characters
/// ///
/// \see End /// \see end
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
ConstIterator Begin() const; ConstIterator begin() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return an iterator to the beginning of the string /// \brief Return an iterator to the beginning of the string
@ -373,10 +373,10 @@ public :
/// ///
/// \return Read-write iterator to the end of the string characters /// \return Read-write iterator to the end of the string characters
/// ///
/// \see Begin /// \see begin
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Iterator End(); Iterator end();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return an iterator to the beginning of the string /// \brief Return an iterator to the beginning of the string
@ -387,10 +387,10 @@ public :
/// ///
/// \return Read-only iterator to the end of the string characters /// \return Read-only iterator to the end of the string characters
/// ///
/// \see Begin /// \see begin
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
ConstIterator End() const; ConstIterator end() const;
private : private :
@ -524,7 +524,7 @@ SFML_SYSTEM_API String operator +(const String& left, const String& right);
/// std::locale locale; /// std::locale locale;
/// sf::String s; /// sf::String s;
/// ... /// ...
/// std::string s1 = s.ToAnsiString(locale); /// std::string s1 = s.toAnsiString(locale);
/// s = sf::String("hello", locale); /// s = sf::String("hello", locale);
/// \endcode /// \endcode
/// ///

24
include/SFML/System/Thread.hpp
View file

@ -143,7 +143,7 @@ public :
/// running in parallel to the calling code. /// running in parallel to the calling code.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Launch(); void launch();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Wait until the thread finishes /// \brief Wait until the thread finishes
@ -156,7 +156,7 @@ public :
/// returns without doing anything. /// returns without doing anything.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Wait(); void wait();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Terminate the thread /// \brief Terminate the thread
@ -169,7 +169,7 @@ public :
/// the thread function terminate by itself. /// the thread function terminate by itself.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Terminate(); void terminate();
private : private :
@ -181,7 +181,7 @@ private :
/// This function is called by the thread implementation. /// This function is called by the thread implementation.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Run(); void run();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -224,19 +224,19 @@ private :
/// ///
/// The thread ends when its function is terminated. If the /// The thread ends when its function is terminated. If the
/// owner sf::Thread instance is destroyed before the /// owner sf::Thread instance is destroyed before the
/// thread is finished, the destructor will wait (see Wait()) /// thread is finished, the destructor will wait (see wait())
/// ///
/// Usage examples: /// Usage examples:
/// \code /// \code
/// // example 1: non member function with one argument /// // example 1: non member function with one argument
/// ///
/// void ThreadFunc(int argument) /// void threadFunc(int argument)
/// { /// {
/// ... /// ...
/// } /// }
/// ///
/// sf::Thread thread(&ThreadFunc, 5); /// sf::Thread thread(&threadFunc, 5);
/// thread.Launch(); // start the thread (internally calls ThreadFunc(5)) /// thread.launch(); // start the thread (internally calls threadFunc(5))
/// \endcode /// \endcode
/// ///
/// \code /// \code
@ -245,15 +245,15 @@ private :
/// class Task /// class Task
/// { /// {
/// public : /// public :
/// void Run() /// void run()
/// { /// {
/// ... /// ...
/// } /// }
/// }; /// };
/// ///
/// Task task; /// Task task;
/// sf::Thread thread(&Task::Run, &task); /// sf::Thread thread(&Task::run, &task);
/// thread.Launch(); // start the thread (internally calls task.run()) /// thread.launch(); // start the thread (internally calls task.run())
/// \endcode /// \endcode
/// ///
/// \code /// \code
@ -268,7 +268,7 @@ private :
/// }; /// };
/// ///
/// sf::Thread thread(Task()); /// sf::Thread thread(Task());
/// thread.Launch(); // start the thread (internally calls operator() on the Task instance) /// thread.launch(); // start the thread (internally calls operator() on the Task instance)
/// \endcode /// \endcode
/// ///
/// Creating parallel threads of execution can be dangerous: /// Creating parallel threads of execution can be dangerous:

8
include/SFML/System/Thread.inl
View file

@ -28,7 +28,7 @@ namespace priv
struct ThreadFunc struct ThreadFunc
{ {
virtual ~ThreadFunc() {} virtual ~ThreadFunc() {}
virtual void Run() = 0; virtual void run() = 0;
}; };
// Specialization using a functor (including free functions) with no argument // Specialization using a functor (including free functions) with no argument
@ -36,7 +36,7 @@ template <typename T>
struct ThreadFunctor : ThreadFunc struct ThreadFunctor : ThreadFunc
{ {
ThreadFunctor(T functor) : m_functor(functor) {} ThreadFunctor(T functor) : m_functor(functor) {}
virtual void Run() {m_functor();} virtual void run() {m_functor();}
T m_functor; T m_functor;
}; };
@ -45,7 +45,7 @@ template <typename F, typename A>
struct ThreadFunctorWithArg : ThreadFunc struct ThreadFunctorWithArg : ThreadFunc
{ {
ThreadFunctorWithArg(F function, A arg) : m_function(function), m_arg(arg) {} ThreadFunctorWithArg(F function, A arg) : m_function(function), m_arg(arg) {}
virtual void Run() {m_function(m_arg);} virtual void run() {m_function(m_arg);}
F m_function; F m_function;
A m_arg; A m_arg;
}; };
@ -55,7 +55,7 @@ template <typename C>
struct ThreadMemberFunc : ThreadFunc struct ThreadMemberFunc : ThreadFunc
{ {
ThreadMemberFunc(void(C::*function)(), C* object) : m_function(function), m_object(object) {} ThreadMemberFunc(void(C::*function)(), C* object) : m_function(function), m_object(object) {}
virtual void Run() {(m_object->*m_function)();} virtual void run() {(m_object->*m_function)();}
void(C::*m_function)(); void(C::*m_function)();
C* m_object; C* m_object;
}; };

4
include/SFML/System/ThreadLocal.hpp
View file

@ -68,7 +68,7 @@ public :
/// \param value Value of the variable for the current thread /// \param value Value of the variable for the current thread
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetValue(void* value); void setValue(void* value);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Retrieve the thread-specific value of the variable /// \brief Retrieve the thread-specific value of the variable
@ -76,7 +76,7 @@ public :
/// \return Value of the variable for the current thread /// \return Value of the variable for the current thread
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void* GetValue() const; void* getValue() const;
private : private :

16
include/SFML/System/ThreadLocalPtr.hpp
View file

@ -128,25 +128,25 @@ public :
/// MyClass object2; /// MyClass object2;
/// sf::ThreadLocalPtr<MyClass> objectPtr; /// sf::ThreadLocalPtr<MyClass> objectPtr;
/// ///
/// void Thread1() /// void thread1()
/// { /// {
/// objectPtr = &object1; // doesn't impact Thread2 /// objectPtr = &object1; // doesn't impact thread2
/// ... /// ...
/// } /// }
/// ///
/// void Thread2() /// void thread2()
/// { /// {
/// objectPtr = &object2; // doesn't impact Thread1 /// objectPtr = &object2; // doesn't impact thread1
/// ... /// ...
/// } /// }
/// ///
/// int main() /// int main()
/// { /// {
/// // Create and launch the two threads /// // Create and launch the two threads
/// sf::Thread thread1(&Thread1); /// sf::Thread t1(&thread1);
/// sf::Thread thread2(&Thread2); /// sf::Thread t2(&thread2);
/// thread1.Launch(); /// t1.launch();
/// thread2.Launch(); /// t2.launch();
/// ///
/// return 0; /// return 0;
/// } /// }

10
include/SFML/System/ThreadLocalPtr.inl
View file

@ -37,7 +37,7 @@ ThreadLocal(value)
template <typename T> template <typename T>
T& ThreadLocalPtr<T>::operator *() const T& ThreadLocalPtr<T>::operator *() const
{ {
return *static_cast<T*>(GetValue()); return *static_cast<T*>(getValue());
} }
@ -45,7 +45,7 @@ T& ThreadLocalPtr<T>::operator *() const
template <typename T> template <typename T>
T* ThreadLocalPtr<T>::operator ->() const T* ThreadLocalPtr<T>::operator ->() const
{ {
return static_cast<T*>(GetValue()); return static_cast<T*>(getValue());
} }
@ -53,7 +53,7 @@ T* ThreadLocalPtr<T>::operator ->() const
template <typename T> template <typename T>
ThreadLocalPtr<T>::operator T*() const ThreadLocalPtr<T>::operator T*() const
{ {
return static_cast<T*>(GetValue()); return static_cast<T*>(getValue());
} }
@ -61,7 +61,7 @@ ThreadLocalPtr<T>::operator T*() const
template <typename T> template <typename T>
ThreadLocalPtr<T>& ThreadLocalPtr<T>::operator =(T* value) ThreadLocalPtr<T>& ThreadLocalPtr<T>::operator =(T* value)
{ {
SetValue(value); setValue(value);
return *this; return *this;
} }
@ -70,7 +70,7 @@ ThreadLocalPtr<T>& ThreadLocalPtr<T>::operator =(T* value)
template <typename T> template <typename T>
ThreadLocalPtr<T>& ThreadLocalPtr<T>::operator =(const ThreadLocalPtr<T>& right) ThreadLocalPtr<T>& ThreadLocalPtr<T>::operator =(const ThreadLocalPtr<T>& right)
{ {
SetValue(right.GetValue()); setValue(right.getValue());
return *this; return *this;
} }

50
include/SFML/System/Time.hpp
View file

@ -54,30 +54,30 @@ public :
/// ///
/// \return Time in seconds /// \return Time in seconds
/// ///
/// \see AsMilliseconds, AsMicroseconds /// \see asMilliseconds, asMicroseconds
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float AsSeconds() const; float asSeconds() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the time value as a number of milliseconds /// \brief Return the time value as a number of milliseconds
/// ///
/// \return Time in milliseconds /// \return Time in milliseconds
/// ///
/// \see AsSeconds, AsMicroseconds /// \see asSeconds, asMicroseconds
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Int32 AsMilliseconds() const; Int32 asMilliseconds() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the time value as a number of microseconds /// \brief Return the time value as a number of microseconds
/// ///
/// \return Time in microseconds /// \return Time in microseconds
/// ///
/// \see AsSeconds, AsMilliseconds /// \see asSeconds, asMilliseconds
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Int64 AsMicroseconds() const; Int64 asMicroseconds() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Static member data // Static member data
@ -86,15 +86,15 @@ public :
private : private :
friend SFML_SYSTEM_API Time Seconds(float); friend SFML_SYSTEM_API Time seconds(float);
friend SFML_SYSTEM_API Time Milliseconds(Int32); friend SFML_SYSTEM_API Time milliseconds(Int32);
friend SFML_SYSTEM_API Time Microseconds(Int64); friend SFML_SYSTEM_API Time microseconds(Int64);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Construct from a number of microseconds /// \brief Construct from a number of microseconds
/// ///
/// This function is internal. To construct time values, /// This function is internal. To construct time values,
/// use sf::Seconds, sf::Milliseconds or sf::Microseconds instead. /// use sf::seconds, sf::milliseconds or sf::microseconds instead.
/// ///
/// \param microseconds Number of microseconds /// \param microseconds Number of microseconds
/// ///
@ -117,10 +117,10 @@ private :
/// ///
/// \return Time value constructed from the amount of seconds /// \return Time value constructed from the amount of seconds
/// ///
/// \see Milliseconds, Microseconds /// \see milliseconds, microseconds
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SFML_SYSTEM_API Time Seconds(float amount); SFML_SYSTEM_API Time seconds(float amount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Time /// \relates Time
@ -130,10 +130,10 @@ SFML_SYSTEM_API Time Seconds(float amount);
/// ///
/// \return Time value constructed from the amount of milliseconds /// \return Time value constructed from the amount of milliseconds
/// ///
/// \see Seconds, Microseconds /// \see seconds, microseconds
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SFML_SYSTEM_API Time Milliseconds(Int32 amount); SFML_SYSTEM_API Time milliseconds(Int32 amount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Time /// \relates Time
@ -143,10 +143,10 @@ SFML_SYSTEM_API Time Milliseconds(Int32 amount);
/// ///
/// \return Time value constructed from the amount of microseconds /// \return Time value constructed from the amount of microseconds
/// ///
/// \see Seconds, Milliseconds /// \see seconds, milliseconds
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SFML_SYSTEM_API Time Microseconds(Int64 amount); SFML_SYSTEM_API Time microseconds(Int64 amount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Time /// \relates Time
@ -428,23 +428,23 @@ SFML_SYSTEM_API Time& operator /=(Time& left, Int64 right);
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// sf::Time t1 = sf::Seconds(0.1f); /// sf::Time t1 = sf::seconds(0.1f);
/// Int32 milli = t1.AsMilliseconds(); // 100 /// Int32 milli = t1.asMilliseconds(); // 100
/// ///
/// sf::Time t2 = sf::Milliseconds(30); /// sf::Time t2 = sf::milliseconds(30);
/// Int64 micro = t2.AsMicroseconds(); // 30000 /// Int64 micro = t2.asMicroseconds(); // 30000
/// ///
/// sf::Time t3 = sf::Microseconds(-800000); /// sf::Time t3 = sf::microseconds(-800000);
/// float sec = t3.AsSeconds(); // -0.8 /// float sec = t3.asSeconds(); // -0.8
/// \endcode /// \endcode
/// ///
/// \code /// \code
/// void Update(sf::Time elapsed) /// void update(sf::Time elapsed)
/// { /// {
/// position += speed * elapsed.AsSeconds(); /// position += speed * elapsed.asSeconds();
/// } /// }
/// ///
/// Update(sf::Milliseconds(100)); /// Update(sf::milliseconds(100));
/// \endcode /// \endcode
/// ///
/// \see sf::Clock /// \see sf::Clock

86
include/SFML/System/Utf.hpp
View file

@ -64,7 +64,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static In Decode(In begin, In end, Uint32& output, Uint32 replacement = 0); static In decode(In begin, In end, Uint32& output, Uint32 replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Encode a single UTF-8 character /// \brief Encode a single UTF-8 character
@ -80,7 +80,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
static Out Encode(Uint32 input, Out output, Uint8 replacement = 0); static Out encode(Uint32 input, Out output, Uint8 replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Advance to the next UTF-8 character /// \brief Advance to the next UTF-8 character
@ -95,7 +95,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static In Next(In begin, In end); static In next(In begin, In end);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Count the number of characters of a UTF-8 sequence /// \brief Count the number of characters of a UTF-8 sequence
@ -111,7 +111,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static std::size_t Count(In begin, In end); static std::size_t count(In begin, In end);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an ANSI characters range to UTF-8 /// \brief Convert an ANSI characters range to UTF-8
@ -128,7 +128,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromAnsi(In begin, In end, Out output, const std::locale& locale = std::locale()); static Out fromAnsi(In begin, In end, Out output, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a wide characters range to UTF-8 /// \brief Convert a wide characters range to UTF-8
@ -141,7 +141,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromWide(In begin, In end, Out output); static Out fromWide(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-8 /// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-8
@ -154,7 +154,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromLatin1(In begin, In end, Out output); static Out fromLatin1(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-8 characters range to ANSI characters /// \brief Convert an UTF-8 characters range to ANSI characters
@ -172,7 +172,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToAnsi(In begin, In end, Out output, char replacement = 0, const std::locale& locale = std::locale()); static Out toAnsi(In begin, In end, Out output, char replacement = 0, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-8 characters range to wide characters /// \brief Convert an UTF-8 characters range to wide characters
@ -186,7 +186,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToWide(In begin, In end, Out output, wchar_t replacement = 0); static Out toWide(In begin, In end, Out output, wchar_t replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-8 characters range to latin-1 (ISO-5589-1) characters /// \brief Convert an UTF-8 characters range to latin-1 (ISO-5589-1) characters
@ -200,7 +200,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToLatin1(In begin, In end, Out output, char replacement = 0); static Out toLatin1(In begin, In end, Out output, char replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-8 characters range to UTF-8 /// \brief Convert a UTF-8 characters range to UTF-8
@ -218,7 +218,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf8(In begin, In end, Out output); static Out toUtf8(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-8 characters range to UTF-16 /// \brief Convert a UTF-8 characters range to UTF-16
@ -231,7 +231,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf16(In begin, In end, Out output); static Out toUtf16(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-8 characters range to UTF-32 /// \brief Convert a UTF-8 characters range to UTF-32
@ -244,7 +244,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf32(In begin, In end, Out output); static Out toUtf32(In begin, In end, Out output);
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -271,7 +271,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static In Decode(In begin, In end, Uint32& output, Uint32 replacement = 0); static In decode(In begin, In end, Uint32& output, Uint32 replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Encode a single UTF-16 character /// \brief Encode a single UTF-16 character
@ -287,7 +287,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
static Out Encode(Uint32 input, Out output, Uint16 replacement = 0); static Out encode(Uint32 input, Out output, Uint16 replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Advance to the next UTF-16 character /// \brief Advance to the next UTF-16 character
@ -302,7 +302,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static In Next(In begin, In end); static In next(In begin, In end);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Count the number of characters of a UTF-16 sequence /// \brief Count the number of characters of a UTF-16 sequence
@ -318,7 +318,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static std::size_t Count(In begin, In end); static std::size_t count(In begin, In end);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an ANSI characters range to UTF-16 /// \brief Convert an ANSI characters range to UTF-16
@ -335,7 +335,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromAnsi(In begin, In end, Out output, const std::locale& locale = std::locale()); static Out fromAnsi(In begin, In end, Out output, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a wide characters range to UTF-16 /// \brief Convert a wide characters range to UTF-16
@ -348,7 +348,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromWide(In begin, In end, Out output); static Out fromWide(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-16 /// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-16
@ -361,7 +361,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromLatin1(In begin, In end, Out output); static Out fromLatin1(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-16 characters range to ANSI characters /// \brief Convert an UTF-16 characters range to ANSI characters
@ -379,7 +379,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToAnsi(In begin, In end, Out output, char replacement = 0, const std::locale& locale = std::locale()); static Out toAnsi(In begin, In end, Out output, char replacement = 0, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-16 characters range to wide characters /// \brief Convert an UTF-16 characters range to wide characters
@ -393,7 +393,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToWide(In begin, In end, Out output, wchar_t replacement = 0); static Out toWide(In begin, In end, Out output, wchar_t replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters /// \brief Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters
@ -407,7 +407,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToLatin1(In begin, In end, Out output, char replacement = 0); static Out toLatin1(In begin, In end, Out output, char replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-16 characters range to UTF-8 /// \brief Convert a UTF-16 characters range to UTF-8
@ -420,7 +420,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf8(In begin, In end, Out output); static Out toUtf8(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-16 characters range to UTF-16 /// \brief Convert a UTF-16 characters range to UTF-16
@ -438,7 +438,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf16(In begin, In end, Out output); static Out toUtf16(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-16 characters range to UTF-32 /// \brief Convert a UTF-16 characters range to UTF-32
@ -451,7 +451,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf32(In begin, In end, Out output); static Out toUtf32(In begin, In end, Out output);
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -479,7 +479,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static In Decode(In begin, In end, Uint32& output, Uint32 replacement = 0); static In decode(In begin, In end, Uint32& output, Uint32 replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Encode a single UTF-32 character /// \brief Encode a single UTF-32 character
@ -496,7 +496,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
static Out Encode(Uint32 input, Out output, Uint32 replacement = 0); static Out encode(Uint32 input, Out output, Uint32 replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Advance to the next UTF-32 character /// \brief Advance to the next UTF-32 character
@ -511,7 +511,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static In Next(In begin, In end); static In next(In begin, In end);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Count the number of characters of a UTF-32 sequence /// \brief Count the number of characters of a UTF-32 sequence
@ -526,7 +526,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static std::size_t Count(In begin, In end); static std::size_t count(In begin, In end);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an ANSI characters range to UTF-32 /// \brief Convert an ANSI characters range to UTF-32
@ -543,7 +543,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromAnsi(In begin, In end, Out output, const std::locale& locale = std::locale()); static Out fromAnsi(In begin, In end, Out output, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a wide characters range to UTF-32 /// \brief Convert a wide characters range to UTF-32
@ -556,7 +556,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromWide(In begin, In end, Out output); static Out fromWide(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-32 /// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-32
@ -569,7 +569,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out FromLatin1(In begin, In end, Out output); static Out fromLatin1(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-32 characters range to ANSI characters /// \brief Convert an UTF-32 characters range to ANSI characters
@ -587,7 +587,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToAnsi(In begin, In end, Out output, char replacement = 0, const std::locale& locale = std::locale()); static Out toAnsi(In begin, In end, Out output, char replacement = 0, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-32 characters range to wide characters /// \brief Convert an UTF-32 characters range to wide characters
@ -601,7 +601,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToWide(In begin, In end, Out output, wchar_t replacement = 0); static Out toWide(In begin, In end, Out output, wchar_t replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters /// \brief Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters
@ -615,7 +615,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToLatin1(In begin, In end, Out output, char replacement = 0); static Out toLatin1(In begin, In end, Out output, char replacement = 0);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-32 characters range to UTF-8 /// \brief Convert a UTF-32 characters range to UTF-8
@ -628,7 +628,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf8(In begin, In end, Out output); static Out toUtf8(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-32 characters range to UTF-16 /// \brief Convert a UTF-32 characters range to UTF-16
@ -641,7 +641,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf16(In begin, In end, Out output); static Out toUtf16(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Convert a UTF-32 characters range to UTF-32 /// \brief Convert a UTF-32 characters range to UTF-32
@ -659,7 +659,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
static Out ToUtf32(In begin, In end, Out output); static Out toUtf32(In begin, In end, Out output);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Decode a single ANSI character to UTF-32 /// \brief Decode a single ANSI character to UTF-32
@ -675,7 +675,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static Uint32 DecodeAnsi(In input, const std::locale& locale = std::locale()); static Uint32 decodeAnsi(In input, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Decode a single wide character to UTF-32 /// \brief Decode a single wide character to UTF-32
@ -690,7 +690,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
static Uint32 DecodeWide(In input); static Uint32 decodeWide(In input);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Encode a single UTF-32 character to ANSI /// \brief Encode a single UTF-32 character to ANSI
@ -708,7 +708,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
static Out EncodeAnsi(Uint32 codepoint, Out output, char replacement = 0, const std::locale& locale = std::locale()); static Out encodeAnsi(Uint32 codepoint, Out output, char replacement = 0, const std::locale& locale = std::locale());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Encode a single UTF-32 character to wide /// \brief Encode a single UTF-32 character to wide
@ -725,7 +725,7 @@ public :
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
static Out EncodeWide(Uint32 codepoint, Out output, wchar_t replacement = 0); static Out encodeWide(Uint32 codepoint, Out output, wchar_t replacement = 0);
}; };
#include <SFML/System/Utf.inl> #include <SFML/System/Utf.inl>

174
include/SFML/System/Utf.inl
View file

@ -36,7 +36,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
In Utf<8>::Decode(In begin, In end, Uint32& output, Uint32 replacement) In Utf<8>::decode(In begin, In end, Uint32& output, Uint32 replacement)
{ {
// Some useful precomputed data // Some useful precomputed data
static const int trailing[256] = static const int trailing[256] =
@ -55,7 +55,7 @@ In Utf<8>::Decode(In begin, In end, Uint32& output, Uint32 replacement)
0x00000000, 0x00003080, 0x000E2080, 0x03C82080, 0xFA082080, 0x82082080 0x00000000, 0x00003080, 0x000E2080, 0x03C82080, 0xFA082080, 0x82082080
}; };
// Decode the character // decode the character
int trailingBytes = trailing[static_cast<Uint8>(*begin)]; int trailingBytes = trailing[static_cast<Uint8>(*begin)];
if (begin + trailingBytes < end) if (begin + trailingBytes < end)
{ {
@ -84,7 +84,7 @@ In Utf<8>::Decode(In begin, In end, Uint32& output, Uint32 replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
Out Utf<8>::Encode(Uint32 input, Out output, Uint8 replacement) Out Utf<8>::encode(Uint32 input, Out output, Uint8 replacement)
{ {
// Some useful precomputed data // Some useful precomputed data
static const Uint8 firstBytes[7] = static const Uint8 firstBytes[7] =
@ -92,7 +92,7 @@ Out Utf<8>::Encode(Uint32 input, Out output, Uint8 replacement)
0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC 0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC
}; };
// Encode the character // encode the character
if ((input > 0x0010FFFF) || ((input >= 0xD800) && (input <= 0xDBFF))) if ((input > 0x0010FFFF) || ((input >= 0xD800) && (input <= 0xDBFF)))
{ {
// Invalid character // Invalid character
@ -104,25 +104,25 @@ Out Utf<8>::Encode(Uint32 input, Out output, Uint8 replacement)
// Valid character // Valid character
// Get the number of bytes to write // Get the number of bytes to write
int bytesToWrite = 1; int bytestoWrite = 1;
if (input < 0x80) bytesToWrite = 1; if (input < 0x80) bytestoWrite = 1;
else if (input < 0x800) bytesToWrite = 2; else if (input < 0x800) bytestoWrite = 2;
else if (input < 0x10000) bytesToWrite = 3; else if (input < 0x10000) bytestoWrite = 3;
else if (input <= 0x0010FFFF) bytesToWrite = 4; else if (input <= 0x0010FFFF) bytestoWrite = 4;
// Extract the bytes to write // Extract the bytes to write
Uint8 bytes[4]; Uint8 bytes[4];
switch (bytesToWrite) switch (bytestoWrite)
{ {
case 4 : bytes[3] = static_cast<Uint8>((input | 0x80) & 0xBF); input >>= 6; case 4 : bytes[3] = static_cast<Uint8>((input | 0x80) & 0xBF); input >>= 6;
case 3 : bytes[2] = static_cast<Uint8>((input | 0x80) & 0xBF); input >>= 6; case 3 : bytes[2] = static_cast<Uint8>((input | 0x80) & 0xBF); input >>= 6;
case 2 : bytes[1] = static_cast<Uint8>((input | 0x80) & 0xBF); input >>= 6; case 2 : bytes[1] = static_cast<Uint8>((input | 0x80) & 0xBF); input >>= 6;
case 1 : bytes[0] = static_cast<Uint8> (input | firstBytes[bytesToWrite]); case 1 : bytes[0] = static_cast<Uint8> (input | firstBytes[bytestoWrite]);
} }
// Add them to the output // Add them to the output
const Uint8* currentByte = bytes; const Uint8* currentByte = bytes;
switch (bytesToWrite) switch (bytestoWrite)
{ {
case 4 : *output++ = *currentByte++; case 4 : *output++ = *currentByte++;
case 3 : *output++ = *currentByte++; case 3 : *output++ = *currentByte++;
@ -137,21 +137,21 @@ Out Utf<8>::Encode(Uint32 input, Out output, Uint8 replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
In Utf<8>::Next(In begin, In end) In Utf<8>::next(In begin, In end)
{ {
Uint32 codepoint; Uint32 codepoint;
return Decode(begin, end, codepoint); return decode(begin, end, codepoint);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
std::size_t Utf<8>::Count(In begin, In end) std::size_t Utf<8>::count(In begin, In end)
{ {
std::size_t length = 0; std::size_t length = 0;
while (begin < end) while (begin < end)
{ {
begin = Next(begin, end); begin = next(begin, end);
++length; ++length;
} }
@ -161,12 +161,12 @@ std::size_t Utf<8>::Count(In begin, In end)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::FromAnsi(In begin, In end, Out output, const std::locale& locale) Out Utf<8>::fromAnsi(In begin, In end, Out output, const std::locale& locale)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint = Utf<32>::DecodeAnsi(*begin++, locale); Uint32 codepoint = Utf<32>::decodeAnsi(*begin++, locale);
output = Encode(codepoint, output); output = encode(codepoint, output);
} }
return output; return output;
@ -175,12 +175,12 @@ Out Utf<8>::FromAnsi(In begin, In end, Out output, const std::locale& locale)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::FromWide(In begin, In end, Out output) Out Utf<8>::fromWide(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint = Utf<32>::DecodeWide(*begin++); Uint32 codepoint = Utf<32>::decodeWide(*begin++);
output = Encode(codepoint, output); output = encode(codepoint, output);
} }
return output; return output;
@ -189,12 +189,12 @@ Out Utf<8>::FromWide(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::FromLatin1(In begin, In end, Out output) Out Utf<8>::fromLatin1(In begin, In end, Out output)
{ {
// Latin-1 is directly compatible with Unicode encodings, // Latin-1 is directly compatible with Unicode encodings,
// and can thus be treated as (a sub-range of) UTF-32 // and can thus be treated as (a sub-range of) UTF-32
while (begin < end) while (begin < end)
output = Encode(*begin++, output); output = encode(*begin++, output);
return output; return output;
} }
@ -202,13 +202,13 @@ Out Utf<8>::FromLatin1(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::ToAnsi(In begin, In end, Out output, char replacement, const std::locale& locale) Out Utf<8>::toAnsi(In begin, In end, Out output, char replacement, const std::locale& locale)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
output = Utf<32>::EncodeAnsi(codepoint, output, replacement, locale); output = Utf<32>::encodeAnsi(codepoint, output, replacement, locale);
} }
return output; return output;
@ -217,13 +217,13 @@ Out Utf<8>::ToAnsi(In begin, In end, Out output, char replacement, const std::lo
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::ToWide(In begin, In end, Out output, wchar_t replacement) Out Utf<8>::toWide(In begin, In end, Out output, wchar_t replacement)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
output = Utf<32>::EncodeWide(codepoint, output, replacement); output = Utf<32>::encodeWide(codepoint, output, replacement);
} }
return output; return output;
@ -232,14 +232,14 @@ Out Utf<8>::ToWide(In begin, In end, Out output, wchar_t replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::ToLatin1(In begin, In end, Out output, char replacement) Out Utf<8>::toLatin1(In begin, In end, Out output, char replacement)
{ {
// Latin-1 is directly compatible with Unicode encodings, // Latin-1 is directly compatible with Unicode encodings,
// and can thus be treated as (a sub-range of) UTF-32 // and can thus be treated as (a sub-range of) UTF-32
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
*output++ = codepoint < 256 ? static_cast<char>(codepoint) : replacement; *output++ = codepoint < 256 ? static_cast<char>(codepoint) : replacement;
} }
@ -249,7 +249,7 @@ Out Utf<8>::ToLatin1(In begin, In end, Out output, char replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::ToUtf8(In begin, In end, Out output) Out Utf<8>::toUtf8(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
*output++ = *begin++; *output++ = *begin++;
@ -260,13 +260,13 @@ Out Utf<8>::ToUtf8(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::ToUtf16(In begin, In end, Out output) Out Utf<8>::toUtf16(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
output = Utf<16>::Encode(codepoint, output); output = Utf<16>::encode(codepoint, output);
} }
return output; return output;
@ -275,12 +275,12 @@ Out Utf<8>::ToUtf16(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<8>::ToUtf32(In begin, In end, Out output) Out Utf<8>::toUtf32(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
*output++ = codepoint; *output++ = codepoint;
} }
@ -290,7 +290,7 @@ Out Utf<8>::ToUtf32(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
In Utf<16>::Decode(In begin, In end, Uint32& output, Uint32 replacement) In Utf<16>::decode(In begin, In end, Uint32& output, Uint32 replacement)
{ {
Uint16 first = *begin++; Uint16 first = *begin++;
@ -330,7 +330,7 @@ In Utf<16>::Decode(In begin, In end, Uint32& output, Uint32 replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
Out Utf<16>::Encode(Uint32 input, Out output, Uint16 replacement) Out Utf<16>::encode(Uint32 input, Out output, Uint16 replacement)
{ {
if (input < 0xFFFF) if (input < 0xFFFF)
{ {
@ -367,21 +367,21 @@ Out Utf<16>::Encode(Uint32 input, Out output, Uint16 replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
In Utf<16>::Next(In begin, In end) In Utf<16>::next(In begin, In end)
{ {
Uint32 codepoint; Uint32 codepoint;
return Decode(begin, end, codepoint); return decode(begin, end, codepoint);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
std::size_t Utf<16>::Count(In begin, In end) std::size_t Utf<16>::count(In begin, In end)
{ {
std::size_t length = 0; std::size_t length = 0;
while (begin < end) while (begin < end)
{ {
begin = Next(begin, end); begin = next(begin, end);
++length; ++length;
} }
@ -391,12 +391,12 @@ std::size_t Utf<16>::Count(In begin, In end)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::FromAnsi(In begin, In end, Out output, const std::locale& locale) Out Utf<16>::fromAnsi(In begin, In end, Out output, const std::locale& locale)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint = Utf<32>::DecodeAnsi(*begin++, locale); Uint32 codepoint = Utf<32>::decodeAnsi(*begin++, locale);
output = Encode(codepoint, output); output = encode(codepoint, output);
} }
return output; return output;
@ -405,12 +405,12 @@ Out Utf<16>::FromAnsi(In begin, In end, Out output, const std::locale& locale)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::FromWide(In begin, In end, Out output) Out Utf<16>::fromWide(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint = Utf<32>::DecodeWide(*begin++); Uint32 codepoint = Utf<32>::decodeWide(*begin++);
output = Encode(codepoint, output); output = encode(codepoint, output);
} }
return output; return output;
@ -419,7 +419,7 @@ Out Utf<16>::FromWide(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::FromLatin1(In begin, In end, Out output) Out Utf<16>::fromLatin1(In begin, In end, Out output)
{ {
// Latin-1 is directly compatible with Unicode encodings, // Latin-1 is directly compatible with Unicode encodings,
// and can thus be treated as (a sub-range of) UTF-32 // and can thus be treated as (a sub-range of) UTF-32
@ -432,13 +432,13 @@ Out Utf<16>::FromLatin1(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::ToAnsi(In begin, In end, Out output, char replacement, const std::locale& locale) Out Utf<16>::toAnsi(In begin, In end, Out output, char replacement, const std::locale& locale)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
output = Utf<32>::EncodeAnsi(codepoint, output, replacement, locale); output = Utf<32>::encodeAnsi(codepoint, output, replacement, locale);
} }
return output; return output;
@ -447,13 +447,13 @@ Out Utf<16>::ToAnsi(In begin, In end, Out output, char replacement, const std::l
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::ToWide(In begin, In end, Out output, wchar_t replacement) Out Utf<16>::toWide(In begin, In end, Out output, wchar_t replacement)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
output = Utf<32>::EncodeWide(codepoint, output, replacement); output = Utf<32>::encodeWide(codepoint, output, replacement);
} }
return output; return output;
@ -462,7 +462,7 @@ Out Utf<16>::ToWide(In begin, In end, Out output, wchar_t replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::ToLatin1(In begin, In end, Out output, char replacement) Out Utf<16>::toLatin1(In begin, In end, Out output, char replacement)
{ {
// Latin-1 is directly compatible with Unicode encodings, // Latin-1 is directly compatible with Unicode encodings,
// and can thus be treated as (a sub-range of) UTF-32 // and can thus be treated as (a sub-range of) UTF-32
@ -478,13 +478,13 @@ Out Utf<16>::ToLatin1(In begin, In end, Out output, char replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::ToUtf8(In begin, In end, Out output) Out Utf<16>::toUtf8(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
output = Utf<8>::Encode(codepoint, output); output = Utf<8>::encode(codepoint, output);
} }
return output; return output;
@ -493,7 +493,7 @@ Out Utf<16>::ToUtf8(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::ToUtf16(In begin, In end, Out output) Out Utf<16>::toUtf16(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
*output++ = *begin++; *output++ = *begin++;
@ -504,12 +504,12 @@ Out Utf<16>::ToUtf16(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<16>::ToUtf32(In begin, In end, Out output) Out Utf<16>::toUtf32(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
{ {
Uint32 codepoint; Uint32 codepoint;
begin = Decode(begin, end, codepoint); begin = decode(begin, end, codepoint);
*output++ = codepoint; *output++ = codepoint;
} }
@ -519,7 +519,7 @@ Out Utf<16>::ToUtf32(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
In Utf<32>::Decode(In begin, In end, Uint32& output, Uint32) In Utf<32>::decode(In begin, In end, Uint32& output, Uint32)
{ {
output = *begin++; output = *begin++;
return begin; return begin;
@ -528,7 +528,7 @@ In Utf<32>::Decode(In begin, In end, Uint32& output, Uint32)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
Out Utf<32>::Encode(Uint32 input, Out output, Uint32 replacement) Out Utf<32>::encode(Uint32 input, Out output, Uint32 replacement)
{ {
*output++ = input; *output++ = input;
return output; return output;
@ -537,7 +537,7 @@ Out Utf<32>::Encode(Uint32 input, Out output, Uint32 replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
In Utf<32>::Next(In begin, In end) In Utf<32>::next(In begin, In end)
{ {
return ++begin; return ++begin;
} }
@ -545,7 +545,7 @@ In Utf<32>::Next(In begin, In end)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
std::size_t Utf<32>::Count(In begin, In end) std::size_t Utf<32>::count(In begin, In end)
{ {
return begin - end; return begin - end;
} }
@ -553,10 +553,10 @@ std::size_t Utf<32>::Count(In begin, In end)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::FromAnsi(In begin, In end, Out output, const std::locale& locale) Out Utf<32>::fromAnsi(In begin, In end, Out output, const std::locale& locale)
{ {
while (begin < end) while (begin < end)
*output++ = DecodeAnsi(*begin++, locale); *output++ = decodeAnsi(*begin++, locale);
return output; return output;
} }
@ -564,10 +564,10 @@ Out Utf<32>::FromAnsi(In begin, In end, Out output, const std::locale& locale)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::FromWide(In begin, In end, Out output) Out Utf<32>::fromWide(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
*output++ = DecodeWide(*begin++); *output++ = decodeWide(*begin++);
return output; return output;
} }
@ -575,7 +575,7 @@ Out Utf<32>::FromWide(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::FromLatin1(In begin, In end, Out output) Out Utf<32>::fromLatin1(In begin, In end, Out output)
{ {
// Latin-1 is directly compatible with Unicode encodings, // Latin-1 is directly compatible with Unicode encodings,
// and can thus be treated as (a sub-range of) UTF-32 // and can thus be treated as (a sub-range of) UTF-32
@ -588,10 +588,10 @@ Out Utf<32>::FromLatin1(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::ToAnsi(In begin, In end, Out output, char replacement, const std::locale& locale) Out Utf<32>::toAnsi(In begin, In end, Out output, char replacement, const std::locale& locale)
{ {
while (begin < end) while (begin < end)
output = EncodeAnsi(*begin++, output, replacement, locale); output = encodeAnsi(*begin++, output, replacement, locale);
return output; return output;
} }
@ -599,10 +599,10 @@ Out Utf<32>::ToAnsi(In begin, In end, Out output, char replacement, const std::l
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::ToWide(In begin, In end, Out output, wchar_t replacement) Out Utf<32>::toWide(In begin, In end, Out output, wchar_t replacement)
{ {
while (begin < end) while (begin < end)
output = EncodeWide(*begin++, output, replacement); output = encodeWide(*begin++, output, replacement);
return output; return output;
} }
@ -610,7 +610,7 @@ Out Utf<32>::ToWide(In begin, In end, Out output, wchar_t replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::ToLatin1(In begin, In end, Out output, char replacement) Out Utf<32>::toLatin1(In begin, In end, Out output, char replacement)
{ {
// Latin-1 is directly compatible with Unicode encodings, // Latin-1 is directly compatible with Unicode encodings,
// and can thus be treated as (a sub-range of) UTF-32 // and can thus be treated as (a sub-range of) UTF-32
@ -626,20 +626,20 @@ Out Utf<32>::ToLatin1(In begin, In end, Out output, char replacement)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::ToUtf8(In begin, In end, Out output) Out Utf<32>::toUtf8(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
output = Utf<8>::Encode(*begin++, output); output = Utf<8>::encode(*begin++, output);
return output; return output;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::ToUtf16(In begin, In end, Out output) Out Utf<32>::toUtf16(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
output = Utf<16>::Encode(*begin++, output); output = Utf<16>::encode(*begin++, output);
return output; return output;
} }
@ -647,7 +647,7 @@ Out Utf<32>::ToUtf16(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In, typename Out> template <typename In, typename Out>
Out Utf<32>::ToUtf32(In begin, In end, Out output) Out Utf<32>::toUtf32(In begin, In end, Out output)
{ {
while (begin < end) while (begin < end)
*output++ = *begin++; *output++ = *begin++;
@ -658,7 +658,7 @@ Out Utf<32>::ToUtf32(In begin, In end, Out output)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
Uint32 Utf<32>::DecodeAnsi(In input, const std::locale& locale) Uint32 Utf<32>::decodeAnsi(In input, const std::locale& locale)
{ {
// On Windows, gcc's standard library (glibc++) has almost // On Windows, gcc's standard library (glibc++) has almost
// no support for Unicode stuff. As a consequence, in this // no support for Unicode stuff. As a consequence, in this
@ -687,7 +687,7 @@ Uint32 Utf<32>::DecodeAnsi(In input, const std::locale& locale)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename In> template <typename In>
Uint32 Utf<32>::DecodeWide(In input) Uint32 Utf<32>::decodeWide(In input)
{ {
// The encoding of wide characters is not well defined and is left to the system; // The encoding of wide characters is not well defined and is left to the system;
// however we can safely assume that it is UCS-2 on Windows and // however we can safely assume that it is UCS-2 on Windows and
@ -701,7 +701,7 @@ Uint32 Utf<32>::DecodeWide(In input)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
Out Utf<32>::EncodeAnsi(Uint32 codepoint, Out output, char replacement, const std::locale& locale) Out Utf<32>::encodeAnsi(Uint32 codepoint, Out output, char replacement, const std::locale& locale)
{ {
// On Windows, gcc's standard library (glibc++) has almost // On Windows, gcc's standard library (glibc++) has almost
// no support for Unicode stuff. As a consequence, in this // no support for Unicode stuff. As a consequence, in this
@ -736,7 +736,7 @@ Out Utf<32>::EncodeAnsi(Uint32 codepoint, Out output, char replacement, const st
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
template <typename Out> template <typename Out>
Out Utf<32>::EncodeWide(Uint32 codepoint, Out output, wchar_t replacement) Out Utf<32>::encodeWide(Uint32 codepoint, Out output, wchar_t replacement)
{ {
// The encoding of wide characters is not well defined and is left to the system; // The encoding of wide characters is not well defined and is left to the system;
// however we can safely assume that it is UCS-2 on Windows and // however we can safely assume that it is UCS-2 on Windows and

4
include/SFML/Window/Context.hpp
View file

@ -73,7 +73,7 @@ public :
/// \return True on success, false on failure /// \return True on success, false on failure
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SetActive(bool active); bool setActive(bool active);
public : public :
@ -125,7 +125,7 @@ private :
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// void ThreadFunction(void*) /// void threadFunction(void*)
/// { /// {
/// sf::Context context; /// sf::Context context;
/// // from now on, you have a valid context /// // from now on, you have a valid context

28
include/SFML/Window/ContextSettings.hpp
View file

@ -46,22 +46,22 @@ struct ContextSettings
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
explicit ContextSettings(unsigned int depth = 0, unsigned int stencil = 0, unsigned int antialiasing = 0, unsigned int major = 2, unsigned int minor = 0) : explicit ContextSettings(unsigned int depth = 0, unsigned int stencil = 0, unsigned int antialiasing = 0, unsigned int major = 2, unsigned int minor = 0) :
DepthBits (depth), depthBits (depth),
StencilBits (stencil), stencilBits (stencil),
AntialiasingLevel(antialiasing), antialiasingLevel(antialiasing),
MajorVersion (major), majorVersion (major),
MinorVersion (minor) minorVersion (minor)
{ {
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int DepthBits; ///< Bits of the depth buffer unsigned int depthBits; ///< Bits of the depth buffer
unsigned int StencilBits; ///< Bits of the stencil buffer unsigned int stencilBits; ///< Bits of the stencil buffer
unsigned int AntialiasingLevel; ///< Level of antialiasing unsigned int antialiasingLevel; ///< Level of antialiasing
unsigned int MajorVersion; ///< Major number of the context version to create unsigned int majorVersion; ///< Major number of the context version to create
unsigned int MinorVersion; ///< Minor number of the context version to create unsigned int minorVersion; ///< Minor number of the context version to create
}; };
} // namespace sf } // namespace sf
@ -81,14 +81,14 @@ struct ContextSettings
/// you may need to use this structure only if you're using /// you may need to use this structure only if you're using
/// SFML as a windowing system for custom OpenGL rendering. /// SFML as a windowing system for custom OpenGL rendering.
/// ///
/// The DepthBits and StencilBits members define the number /// The depthBits and stencilBits members define the number
/// of bits per pixel requested for the (respectively) depth /// of bits per pixel requested for the (respectively) depth
/// and stencil buffers. /// and stencil buffers.
/// ///
/// AntialiasingLevel represents the requested number of /// antialiasingLevel represents the requested number of
/// multisampling levels for anti-aliasing. /// multisampling levels for anti-aliasing.
/// ///
/// MajorVersion and MinorVersion define the version of the /// majorVersion and minorVersion define the version of the
/// OpenGL context that you want. Only versions greater or /// OpenGL context that you want. Only versions greater or
/// equal to 3.0 are relevant; versions lesser than 3.0 are /// equal to 3.0 are relevant; versions lesser than 3.0 are
/// all handled the same way (i.e. you can use any version /// all handled the same way (i.e. you can use any version
@ -99,6 +99,6 @@ struct ContextSettings
/// are not supported by the system; instead, SFML will try to /// are not supported by the system; instead, SFML will try to
/// find the closest valid match. You can then retrieve the /// find the closest valid match. You can then retrieve the
/// settings that the window actually used to create its context, /// settings that the window actually used to create its context,
/// with Window::GetSettings(). /// with Window::getSettings().
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

84
include/SFML/Window/Event.hpp
View file

@ -50,8 +50,8 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct SizeEvent struct SizeEvent
{ {
unsigned int Width; ///< New width, in pixels unsigned int width; ///< New width, in pixels
unsigned int Height; ///< New height, in pixels unsigned int height; ///< New height, in pixels
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -60,11 +60,11 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct KeyEvent struct KeyEvent
{ {
Keyboard::Key Code; ///< Code of the key that has been pressed Keyboard::Key code; ///< Code of the key that has been pressed
bool Alt; ///< Is the Alt key pressed? bool alt; ///< Is the Alt key pressed?
bool Control; ///< Is the Control key pressed? bool control; ///< Is the Control key pressed?
bool Shift; ///< Is the Shift key pressed? bool shift; ///< Is the Shift key pressed?
bool System; ///< Is the System key pressed? bool system; ///< Is the System key pressed?
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -73,7 +73,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct TextEvent struct TextEvent
{ {
Uint32 Unicode; ///< UTF-32 unicode value of the character Uint32 unicode; ///< UTF-32 unicode value of the character
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -82,8 +82,8 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct MouseMoveEvent struct MouseMoveEvent
{ {
int X; ///< X position of the mouse pointer, relative to the left of the owner window int x; ///< X position of the mouse pointer, relative to the left of the owner window
int Y; ///< Y position of the mouse pointer, relative to the top of the owner window int y; ///< Y position of the mouse pointer, relative to the top of the owner window
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -93,9 +93,9 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct MouseButtonEvent struct MouseButtonEvent
{ {
Mouse::Button Button; ///< Code of the button that has been pressed Mouse::Button button; ///< Code of the button that has been pressed
int X; ///< X position of the mouse pointer, relative to the left of the owner window int x; ///< X position of the mouse pointer, relative to the left of the owner window
int Y; ///< Y position of the mouse pointer, relative to the top of the owner window int y; ///< Y position of the mouse pointer, relative to the top of the owner window
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -104,9 +104,9 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct MouseWheelEvent struct MouseWheelEvent
{ {
int Delta; ///< Number of ticks the wheel has moved (positive is up, negative is down) int delta; ///< Number of ticks the wheel has moved (positive is up, negative is down)
int X; ///< X position of the mouse pointer, relative to the left of the owner window int x; ///< X position of the mouse pointer, relative to the left of the owner window
int Y; ///< Y position of the mouse pointer, relative to the top of the owner window int y; ///< Y position of the mouse pointer, relative to the top of the owner window
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -116,7 +116,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct JoystickConnectEvent struct JoystickConnectEvent
{ {
unsigned int JoystickId; ///< Index of the joystick (in range [0 .. Joystick::Count - 1]) unsigned int joystickId; ///< Index of the joystick (in range [0 .. Joystick::Count - 1])
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -125,9 +125,9 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct JoystickMoveEvent struct JoystickMoveEvent
{ {
unsigned int JoystickId; ///< Index of the joystick (in range [0 .. Joystick::Count - 1]) unsigned int joystickId; ///< Index of the joystick (in range [0 .. Joystick::Count - 1])
Joystick::Axis Axis; ///< Axis on which the joystick moved Joystick::Axis axis; ///< Axis on which the joystick moved
float Position; ///< New position on the axis (in range [-100 .. 100]) float position; ///< New position on the axis (in range [-100 .. 100])
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -137,8 +137,8 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct JoystickButtonEvent struct JoystickButtonEvent
{ {
unsigned int JoystickId; ///< Index of the joystick (in range [0 .. Joystick::Count - 1]) unsigned int joystickId; ///< Index of the joystick (in range [0 .. Joystick::Count - 1])
unsigned int Button; ///< Index of the button that has been pressed (in range [0 .. Joystick::ButtonCount - 1]) unsigned int button; ///< Index of the button that has been pressed (in range [0 .. Joystick::ButtonCount - 1])
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -172,19 +172,19 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
EventType Type; ///< Type of the event EventType type; ///< Type of the event
union union
{ {
SizeEvent Size; ///< Size event parameters SizeEvent size; ///< Size event parameters
KeyEvent Key; ///< Key event parameters KeyEvent key; ///< Key event parameters
TextEvent Text; ///< Text event parameters TextEvent text; ///< Text event parameters
MouseMoveEvent MouseMove; ///< Mouse move event parameters MouseMoveEvent mouseMove; ///< Mouse move event parameters
MouseButtonEvent MouseButton; ///< Mouse button event parameters MouseButtonEvent mouseButton; ///< Mouse button event parameters
MouseWheelEvent MouseWheel; ///< Mouse wheel event parameters MouseWheelEvent mouseWheel; ///< Mouse wheel event parameters
JoystickMoveEvent JoystickMove; ///< Joystick move event parameters JoystickMoveEvent joystickMove; ///< Joystick move event parameters
JoystickButtonEvent JoystickButton; ///< Joystick button event parameters JoystickButtonEvent joystickButton; ///< Joystick button event parameters
JoystickConnectEvent JoystickConnect; ///< Joystick (dis)connect event parameters JoystickConnectEvent joystickConnect; ///< Joystick (dis)connect event parameters
}; };
}; };
@ -200,7 +200,7 @@ public :
/// ///
/// sf::Event holds all the informations about a system event /// sf::Event holds all the informations about a system event
/// that just happened. Events are retrieved using the /// that just happened. Events are retrieved using the
/// sf::Window::PollEvent and sf::Window::WaitEvent functions. /// sf::Window::pollEvent and sf::Window::waitEvent functions.
/// ///
/// A sf::Event instance contains the type of the event /// A sf::Event instance contains the type of the event
/// (mouse moved, key pressed, window closed, ...) as well /// (mouse moved, key pressed, window closed, ...) as well
@ -210,25 +210,25 @@ public :
/// filled; all other members will have undefined values and must not /// filled; all other members will have undefined values and must not
/// be read if the type of the event doesn't match. For example, /// be read if the type of the event doesn't match. For example,
/// if you received a KeyPressed event, then you must read the /// if you received a KeyPressed event, then you must read the
/// event.Key member, all other members such as event.MouseMove /// event.key member, all other members such as event.MouseMove
/// or event.Text will have undefined values. /// or event.text will have undefined values.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// sf::Event event; /// sf::Event event;
/// while (window.PollEvent(event)) /// while (window.pollEvent(event))
/// { /// {
/// // Request for closing the window /// // Request for closing the window
/// if (event.Type == sf::Event::Closed) /// if (event.type == sf::Event::Closed)
/// window.Close(); /// window.close();
/// ///
/// // The escape key was pressed /// // The escape key was pressed
/// if ((event.Type == sf::Event::KeyPressed) && (event.Key.Code == sf::Keyboard::Escape)) /// if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape))
/// window.Close(); /// window.close();
/// ///
/// // The window was resized /// // The window was resized
/// if (event.Type == sf::Event::Resized) /// if (event.type == sf::Event::Resized)
/// DoSomethingWithTheNewSize(event.Size.Width, event.Size.Height); /// doSomethingWithTheNewSize(event.size.width, event.size.height);
/// ///
/// // etc ... /// // etc ...
/// } /// }

6
include/SFML/Window/GlResource.hpp
View file

@ -53,7 +53,11 @@ protected :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
~GlResource(); ~GlResource();
static void EnsureGlContext(); ////////////////////////////////////////////////////////////
/// \brief Make sure that a valid OpenGL context exists in the current thread
///
////////////////////////////////////////////////////////////
static void ensureGlContext();
}; };
} // namespace sf } // namespace sf

26
include/SFML/Window/Joystick.hpp
View file

@ -76,7 +76,7 @@ public :
/// \return True if the joystick is connected, false otherwise /// \return True if the joystick is connected, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsConnected(unsigned int joystick); static bool isConnected(unsigned int joystick);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Return the number of buttons supported by a joystick /// \brief Return the number of buttons supported by a joystick
@ -88,7 +88,7 @@ public :
/// \return Number of buttons supported by the joystick /// \return Number of buttons supported by the joystick
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static unsigned int GetButtonCount(unsigned int joystick); static unsigned int getButtonCount(unsigned int joystick);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check if a joystick supports a given axis /// \brief Check if a joystick supports a given axis
@ -101,7 +101,7 @@ public :
/// \return True if the joystick supports the axis, false otherwise /// \return True if the joystick supports the axis, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool HasAxis(unsigned int joystick, Axis axis); static bool hasAxis(unsigned int joystick, Axis axis);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Check if a joystick button is pressed /// \brief Check if a joystick button is pressed
@ -114,7 +114,7 @@ public :
/// \return True if the button is pressed, false otherwise /// \return True if the button is pressed, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsButtonPressed(unsigned int joystick, unsigned int button); static bool isButtonPressed(unsigned int joystick, unsigned int button);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current position of a joystick axis /// \brief Get the current position of a joystick axis
@ -127,7 +127,7 @@ public :
/// \return Current position of the axis, in range [-100 .. 100] /// \return Current position of the axis, in range [-100 .. 100]
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static float GetAxisPosition(unsigned int joystick, Axis axis); static float getAxisPosition(unsigned int joystick, Axis axis);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Update the states of all joysticks /// \brief Update the states of all joysticks
@ -138,7 +138,7 @@ public :
/// in this case the joysticks states are not updated automatically. /// in this case the joysticks states are not updated automatically.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void Update(); static void update();
}; };
} // namespace sf } // namespace sf
@ -173,29 +173,29 @@ public :
/// \li 8 axes per joystick (sf::Joystick::AxisCount) /// \li 8 axes per joystick (sf::Joystick::AxisCount)
/// ///
/// Unlike the keyboard or mouse, the state of joysticks is sometimes /// Unlike the keyboard or mouse, the state of joysticks is sometimes
/// not directly available (depending on the OS), therefore an Update() /// not directly available (depending on the OS), therefore an update()
/// function must be called in order to update the current state of /// function must be called in order to update the current state of
/// joysticks. When you have a window with event handling, this is done /// joysticks. When you have a window with event handling, this is done
/// automatically, you don't need to call anything. But if you have no /// automatically, you don't need to call anything. But if you have no
/// window, or if you want to check joysticks state before creating one, /// window, or if you want to check joysticks state before creating one,
/// you must call sf::Joystick::Update explicitely. /// you must call sf::Joystick::update explicitely.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// // Is joystick #0 connected? /// // Is joystick #0 connected?
/// bool connected = sf::Joystick::IsConnected(0); /// bool connected = sf::Joystick::isConnected(0);
/// ///
/// // How many buttons does joystick #0 support? /// // How many buttons does joystick #0 support?
/// unsigned int buttons = sf::Joystick::GetButtonCount(0); /// unsigned int buttons = sf::Joystick::getButtonCount(0);
/// ///
/// // Does joystick #0 define a X axis? /// // Does joystick #0 define a X axis?
/// bool hasX = sf::Joystick::HasAxis(0, sf::Joystick::X); /// bool hasX = sf::Joystick::hasAxis(0, sf::Joystick::X);
/// ///
/// // Is button #2 pressed on joystick #0? /// // Is button #2 pressed on joystick #0?
/// bool pressed = sf::Joystick::IsButtonPressed(0, 2); /// bool pressed = sf::Joystick::isButtonPressed(0, 2);
/// ///
/// // What's the current position of the Y axis on joystick #0? /// // What's the current position of the Y axis on joystick #0?
/// float position = sf::Joystick::GetAxisPosition(0, sf::Joystick::Y); /// float position = sf::Joystick::getAxisPosition(0, sf::Joystick::Y);
/// \endcode /// \endcode
/// ///
/// \see sf::Keyboard, sf::Mouse /// \see sf::Keyboard, sf::Mouse

8
include/SFML/Window/Keyboard.hpp
View file

@ -160,7 +160,7 @@ public :
/// \return True if the key is pressed, false otherwise /// \return True if the key is pressed, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsKeyPressed(Key key); static bool isKeyPressed(Key key);
}; };
} // namespace sf } // namespace sf
@ -189,15 +189,15 @@ public :
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// if (sf::Keyboard::IsKeyPressed(sf::Keyboard::Left)) /// if (sf::Keyboard::isKeyPressed(sf::Keyboard::Left))
/// { /// {
/// // move left... /// // move left...
/// } /// }
/// else if (sf::Keyboard::IsKeyPressed(sf::Keyboard::Right)) /// else if (sf::Keyboard::isKeyPressed(sf::Keyboard::Right))
/// { /// {
/// // move right... /// // move right...
/// } /// }
/// else if (sf::Keyboard::IsKeyPressed(sf::Keyboard::Escape)) /// else if (sf::Keyboard::isKeyPressed(sf::Keyboard::Escape))
/// { /// {
/// // quit... /// // quit...
/// } /// }

16
include/SFML/Window/Mouse.hpp
View file

@ -67,7 +67,7 @@ public :
/// \return True if the button is pressed, false otherwise /// \return True if the button is pressed, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsButtonPressed(Button button); static bool isButtonPressed(Button button);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current position of the mouse in desktop coordinates /// \brief Get the current position of the mouse in desktop coordinates
@ -78,7 +78,7 @@ public :
/// \return Current position of the mouse /// \return Current position of the mouse
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static Vector2i GetPosition(); static Vector2i getPosition();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the current position of the mouse in window coordinates /// \brief Get the current position of the mouse in window coordinates
@ -91,7 +91,7 @@ public :
/// \return Current position of the mouse /// \return Current position of the mouse
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static Vector2i GetPosition(const Window& relativeTo); static Vector2i getPosition(const Window& relativeTo);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the current position of the mouse in desktop coordinates /// \brief Set the current position of the mouse in desktop coordinates
@ -102,7 +102,7 @@ public :
/// \param position New position of the mouse /// \param position New position of the mouse
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetPosition(const Vector2i& position); static void setPosition(const Vector2i& position);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Set the current position of the mouse in window coordinates /// \brief Set the current position of the mouse in window coordinates
@ -114,7 +114,7 @@ public :
/// \param relativeTo Reference window /// \param relativeTo Reference window
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static void SetPosition(const Vector2i& position, const Window& relativeTo); static void setPosition(const Vector2i& position, const Window& relativeTo);
}; };
} // namespace sf } // namespace sf
@ -150,16 +150,16 @@ public :
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// if (sf::Mouse::IsButtonPressed(sf::Mouse::Left)) /// if (sf::Mouse::isButtonPressed(sf::Mouse::Left))
/// { /// {
/// // left click... /// // left click...
/// } /// }
/// ///
/// // get global mouse position /// // get global mouse position
/// sf::Vector2i position = sf::Mouse::GetPosition(); /// sf::Vector2i position = sf::Mouse::getPosition();
/// ///
/// // set mouse position relative to a window /// // set mouse position relative to a window
/// sf::Mouse::SetPosition(sf::Vector2i(100, 200), window); /// sf::Mouse::setPosition(sf::Vector2i(100, 200), window);
/// \endcode /// \endcode
/// ///
/// \see sf::Joystick, sf::Keyboard /// \see sf::Joystick, sf::Keyboard

26
include/SFML/Window/VideoMode.hpp
View file

@ -66,7 +66,7 @@ public :
/// \return Current desktop video mode /// \return Current desktop video mode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static VideoMode GetDesktopMode(); static VideoMode getDesktopMode();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Retrieve all the video modes supported in fullscreen mode /// \brief Retrieve all the video modes supported in fullscreen mode
@ -82,7 +82,7 @@ public :
/// \return Array containing all the supported fullscreen modes /// \return Array containing all the supported fullscreen modes
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static const std::vector<VideoMode>& GetFullscreenModes(); static const std::vector<VideoMode>& getFullscreenModes();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether or not the video mode is valid /// \brief Tell whether or not the video mode is valid
@ -94,14 +94,14 @@ public :
/// \return True if the video mode is valid for fullscreen mode /// \return True if the video mode is valid for fullscreen mode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsValid() const; bool isValid() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int Width; ///< Video mode width, in pixels unsigned int width; ///< Video mode width, in pixels
unsigned int Height; ///< Video mode height, in pixels unsigned int height; ///< Video mode height, in pixels
unsigned int BitsPerPixel; ///< Video mode pixel depth, in bits per pixels unsigned int bitsPerPixel; ///< Video mode pixel depth, in bits per pixels
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -198,31 +198,31 @@ SFML_WINDOW_API bool operator >=(const VideoMode& left, const VideoMode& right);
/// ///
/// sf::VideoMode provides a static function for retrieving /// sf::VideoMode provides a static function for retrieving
/// the list of all the video modes supported by the system: /// the list of all the video modes supported by the system:
/// GetFullscreenModes(). /// getFullscreenModes().
/// ///
/// A custom video mode can also be checked directly for /// A custom video mode can also be checked directly for
/// fullscreen compatibility with its IsValid() function. /// fullscreen compatibility with its IsValid() function.
/// ///
/// Additionnally, sf::VideoMode provides a static function /// Additionnally, sf::VideoMode provides a static function
/// to get the mode currently used by the desktop: GetDesktopMode(). /// to get the mode currently used by the desktop: getDesktopMode().
/// This allows to build windows with the same size or pixel /// This allows to build windows with the same size or pixel
/// depth as the current resolution. /// depth as the current resolution.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// // Display the list of all the video modes available for fullscreen /// // Display the list of all the video modes available for fullscreen
/// std::vector<sf::VideoMode> modes = sf::VideoMode::GetFullscreenModes(); /// std::vector<sf::VideoMode> modes = sf::VideoMode::getFullscreenModes();
/// for (std::size_t i = 0; i < modes.size(); ++i) /// for (std::size_t i = 0; i < modes.size(); ++i)
/// { /// {
/// sf::VideoMode mode = modes[i]; /// sf::VideoMode mode = modes[i];
/// std::cout << "Mode #" << i << ": " /// std::cout << "Mode #" << i << ": "
/// << mode.Width << "x" << mode.Height << " - " /// << mode.width << "x" << mode.height << " - "
/// << mode.BitsPerPixel << " bpp" << std::endl; /// << mode.bitsPerPixel << " bpp" << std::endl;
/// } /// }
/// ///
/// // Create a window with the same pixel depth as the desktop /// // Create a window with the same pixel depth as the desktop
/// sf::VideoMode desktop = sf::VideoMode::GetDesktopMode(); /// sf::VideoMode desktop = sf::VideoMode::getDesktopMode();
/// window.Create(sf::VideoMode(1024, 768, desktop.BitsPerPixel), "SFML window"); /// window.create(sf::VideoMode(1024, 768, desktop.bitsPerPixel), "SFML window");
/// \endcode /// \endcode
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

110
include/SFML/Window/Window.hpp
View file

@ -62,7 +62,7 @@ public :
/// \brief Default constructor /// \brief Default constructor
/// ///
/// This constructor doesn't actually create the window, /// This constructor doesn't actually create the window,
/// use the other constructors or call Create to do so. /// use the other constructors or call create to do so.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Window(); Window();
@ -125,7 +125,7 @@ public :
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Create(VideoMode mode, const std::string& title, Uint32 style = Style::Default, const ContextSettings& settings = ContextSettings()); void create(VideoMode mode, const std::string& title, Uint32 style = Style::Default, const ContextSettings& settings = ContextSettings());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Create (or recreate) the window from an existing control /// \brief Create (or recreate) the window from an existing control
@ -138,44 +138,44 @@ public :
/// \param settings Additional settings for the underlying OpenGL context /// \param settings Additional settings for the underlying OpenGL context
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Create(WindowHandle handle, const ContextSettings& settings = ContextSettings()); void create(WindowHandle handle, const ContextSettings& settings = ContextSettings());
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Close the window and destroy all the attached resources /// \brief Close the window and destroy all the attached resources
/// ///
/// After calling this function, the sf::Window instance remains /// After calling this function, the sf::Window instance remains
/// valid and you can call Create() to recreate the window. /// valid and you can call create() to recreate the window.
/// All other functions such as PollEvent() or Display() will /// All other functions such as pollEvent() or display() will
/// still work (i.e. you don't have to test IsOpen() every time), /// still work (i.e. you don't have to test isOpen() every time),
/// and will have no effect on closed windows. /// and will have no effect on closed windows.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Close(); void close();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Tell whether or not the window is open /// \brief Tell whether or not the window is open
/// ///
/// This function returns whether or not the window exists. /// This function returns whether or not the window exists.
/// Note that a hidden window (SetVisible(false)) is open /// Note that a hidden window (setVisible(false)) is open
/// (therefore this function would return true). /// (therefore this function would return true).
/// ///
/// \return True if the window is open, false if it has been closed /// \return True if the window is open, false if it has been closed
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool IsOpen() const; bool isOpen() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the settings of the OpenGL context of the window /// \brief Get the settings of the OpenGL context of the window
/// ///
/// Note that these settings may be different from what was /// Note that these settings may be different from what was
/// passed to the constructor or the Create() function, /// passed to the constructor or the create() function,
/// if one or more settings were not supported. In this case, /// if one or more settings were not supported. In this case,
/// SFML chose the closest match. /// SFML chose the closest match.
/// ///
/// \return Structure containing the OpenGL context settings /// \return Structure containing the OpenGL context settings
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const ContextSettings& GetSettings() const; const ContextSettings& getSettings() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Pop the event on top of events stack, if any, and return it /// \brief Pop the event on top of events stack, if any, and return it
@ -187,7 +187,7 @@ public :
/// to make sure that you process every pending event. /// to make sure that you process every pending event.
/// \code /// \code
/// sf::Event event; /// sf::Event event;
/// while (window.PollEvent(event)) /// while (window.pollEvent(event))
/// { /// {
/// // process event... /// // process event...
/// } /// }
@ -197,10 +197,10 @@ public :
/// ///
/// \return True if an event was returned, or false if the events stack was empty /// \return True if an event was returned, or false if the events stack was empty
/// ///
/// \see WaitEvent /// \see waitEvent
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool PollEvent(Event& event); bool pollEvent(Event& event);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Wait for an event and return it /// \brief Wait for an event and return it
@ -214,7 +214,7 @@ public :
/// sleep as long as no new event is received. /// sleep as long as no new event is received.
/// \code /// \code
/// sf::Event event; /// sf::Event event;
/// if (window.WaitEvent(event)) /// if (window.waitEvent(event))
/// { /// {
/// // process event... /// // process event...
/// } /// }
@ -224,20 +224,20 @@ public :
/// ///
/// \return False if any error occured /// \return False if any error occured
/// ///
/// \see PollEvent /// \see pollEvent
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool WaitEvent(Event& event); bool waitEvent(Event& event);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the position of the window /// \brief Get the position of the window
/// ///
/// \return Position of the window, in pixels /// \return Position of the window, in pixels
/// ///
/// \see SetPosition /// \see setPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2i GetPosition() const; Vector2i getPosition() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the position of the window on screen /// \brief Change the position of the window on screen
@ -248,10 +248,10 @@ public :
/// ///
/// \param position New position, in pixels /// \param position New position, in pixels
/// ///
/// \see GetPosition /// \see getPosition
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetPosition(const Vector2i& position); void setPosition(const Vector2i& position);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the size of the rendering region of the window /// \brief Get the size of the rendering region of the window
@ -261,30 +261,30 @@ public :
/// ///
/// \return Size in pixels /// \return Size in pixels
/// ///
/// \see SetSize /// \see setSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2u GetSize() const; Vector2u getSize() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the size of the rendering region of the window /// \brief Change the size of the rendering region of the window
/// ///
/// \param size New size, in pixels /// \param size New size, in pixels
/// ///
/// \see GetSize /// \see getSize
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetSize(const Vector2u size); void setSize(const Vector2u size);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the title of the window /// \brief Change the title of the window
/// ///
/// \param title New title /// \param title New title
/// ///
/// \see SetIcon /// \see setIcon
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetTitle(const std::string& title); void setTitle(const std::string& title);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the window's icon /// \brief Change the window's icon
@ -298,10 +298,10 @@ public :
/// \param height Icon's height, in pixels /// \param height Icon's height, in pixels
/// \param pixels Pointer to the array of pixels in memory /// \param pixels Pointer to the array of pixels in memory
/// ///
/// \see SetTitle /// \see setTitle
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetIcon(unsigned int width, unsigned int height, const Uint8* pixels); void setIcon(unsigned int width, unsigned int height, const Uint8* pixels);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Show or hide the window /// \brief Show or hide the window
@ -311,7 +311,7 @@ public :
/// \param visible True to show the window, false to hide it /// \param visible True to show the window, false to hide it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetVisible(bool visible); void setVisible(bool visible);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Enable or disable vertical synchronization /// \brief Enable or disable vertical synchronization
@ -326,7 +326,7 @@ public :
/// \param enabled True to enable v-sync, false to deactivate it /// \param enabled True to enable v-sync, false to deactivate it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetVerticalSyncEnabled(bool enabled); void setVerticalSyncEnabled(bool enabled);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Show or hide the mouse cursor /// \brief Show or hide the mouse cursor
@ -336,7 +336,7 @@ public :
/// \param visible True to show the mouse cursor, false to hide it /// \param visible True to show the mouse cursor, false to hide it
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetMouseCursorVisible(bool visible); void setMouseCursorVisible(bool visible);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Enable or disable automatic key-repeat /// \brief Enable or disable automatic key-repeat
@ -350,16 +350,16 @@ public :
/// \param enabled True to enable, false to disable /// \param enabled True to enable, false to disable
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetKeyRepeatEnabled(bool enabled); void setKeyRepeatEnabled(bool enabled);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Limit the framerate to a maximum fixed frequency /// \brief Limit the framerate to a maximum fixed frequency
/// ///
/// If a limit is set, the window will use a small delay after /// If a limit is set, the window will use a small delay after
/// each call to Display() to ensure that the current frame /// each call to display() to ensure that the current frame
/// lasted long enough to match the framerate limit. /// lasted long enough to match the framerate limit.
/// SFML will try to match the given limit as much as it can, /// SFML will try to match the given limit as much as it can,
/// but since it internally uses sf::Sleep, whose precision /// but since it internally uses sf::sleep, whose precision
/// depends on the underlying OS, the results may be a little /// depends on the underlying OS, the results may be a little
/// unprecise as well (for example, you can get 65 FPS when /// unprecise as well (for example, you can get 65 FPS when
/// requesting 60). /// requesting 60).
@ -367,20 +367,20 @@ public :
/// \param limit Framerate limit, in frames per seconds (use 0 to disable limit) /// \param limit Framerate limit, in frames per seconds (use 0 to disable limit)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetFramerateLimit(unsigned int limit); void setFramerateLimit(unsigned int limit);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the joystick threshold /// \brief Change the joystick threshold
/// ///
/// The joystick threshold is the value below which /// The joystick threshold is the value below which
/// no JoyMoved event will be generated. /// no JoystickMoved event will be generated.
/// ///
/// The threshold value is 0.1 by default. /// The threshold value is 0.1 by default.
/// ///
/// \param threshold New threshold, in the range [0, 100] /// \param threshold New threshold, in the range [0, 100]
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SetJoystickThreshold(float threshold); void setJoystickThreshold(float threshold);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Activate or deactivate the window as the current target /// \brief Activate or deactivate the window as the current target
@ -397,7 +397,7 @@ public :
/// \return True if operation was successful, false otherwise /// \return True if operation was successful, false otherwise
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SetActive(bool active = true) const; bool setActive(bool active = true) const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Display on screen what has been rendered to the window so far /// \brief Display on screen what has been rendered to the window so far
@ -407,7 +407,7 @@ public :
/// it on screen. /// it on screen.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Display(); void display();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the OS-specific handle of the window /// \brief Get the OS-specific handle of the window
@ -421,7 +421,7 @@ public :
/// \return System handle of the window /// \return System handle of the window
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
WindowHandle GetSystemHandle() const; WindowHandle getSystemHandle() const;
private : private :
@ -433,7 +433,7 @@ private :
/// the window is created. /// the window is created.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnCreate(); virtual void onCreate();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Function called after the window has been resized /// \brief Function called after the window has been resized
@ -442,13 +442,13 @@ private :
/// perform custom actions when the size of the window changes. /// perform custom actions when the size of the window changes.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual void OnResize(); virtual void onResize();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Processes an event before it is sent to the user /// \brief Processes an event before it is sent to the user
/// ///
/// This function is called every time an event is received /// This function is called every time an event is received
/// from the internal window (through PollEvent or WaitEvent). /// from the internal window (through pollEvent or waitEvent).
/// It filters out unwanted events, and performs whatever internal /// It filters out unwanted events, and performs whatever internal
/// stuff the window needs before the event is returned to the /// stuff the window needs before the event is returned to the
/// user. /// user.
@ -456,13 +456,13 @@ private :
/// \param event Event to filter /// \param event Event to filter
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool FilterEvent(const Event& event); bool filterEvent(const Event& event);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Perform some common internal initializations /// \brief Perform some common internal initializations
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Initialize(); void initialize();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Member data // Member data
@ -487,7 +487,7 @@ private :
/// an OS window that is able to receive an OpenGL rendering. /// an OS window that is able to receive an OpenGL rendering.
/// ///
/// A sf::Window can create its own new window, or be embedded into /// A sf::Window can create its own new window, or be embedded into
/// an already existing control using the Create(handle) function. /// an already existing control using the create(handle) function.
/// This can be useful for embedding an OpenGL rendering area into /// This can be useful for embedding an OpenGL rendering area into
/// a view which is part of a bigger GUI with existing windows, /// a view which is part of a bigger GUI with existing windows,
/// controls, etc. It can also serve as embedding an OpenGL rendering /// controls, etc. It can also serve as embedding an OpenGL rendering
@ -496,7 +496,7 @@ private :
/// ///
/// The sf::Window class provides a simple interface for manipulating /// The sf::Window class provides a simple interface for manipulating
/// the window: move, resize, show/hide, control mouse cursor, etc. /// the window: move, resize, show/hide, control mouse cursor, etc.
/// It also provides event handling through its PollEvent() and WaitEvent() /// It also provides event handling through its pollEvent() and waitEvent()
/// functions. /// functions.
/// ///
/// Note that OpenGL experts can pass their own parameters (antialiasing /// Note that OpenGL experts can pass their own parameters (antialiasing
@ -511,27 +511,27 @@ private :
/// sf::Window window(sf::VideoMode(800, 600), "SFML window"); /// sf::Window window(sf::VideoMode(800, 600), "SFML window");
/// ///
/// // Limit the framerate to 60 frames per second (this step is optional) /// // Limit the framerate to 60 frames per second (this step is optional)
/// window.SetFramerateLimit(60); /// window.setFramerateLimit(60);
/// ///
/// // The main loop - ends as soon as the window is closed /// // The main loop - ends as soon as the window is closed
/// while (window.IsOpen()) /// while (window.isOpen())
/// { /// {
/// // Event processing /// // Event processing
/// sf::Event event; /// sf::Event event;
/// while (window.PollEvent(event)) /// while (window.pollEvent(event))
/// { /// {
/// // Request for closing the window /// // Request for closing the window
/// if (event.Type == sf::Event::Closed) /// if (event.type == sf::Event::Closed)
/// window.Close(); /// window.close();
/// } /// }
/// ///
/// // Activate the window for OpenGL rendering /// // Activate the window for OpenGL rendering
/// window.SetActive(); /// window.setActive();
/// ///
/// // OpenGL drawing commands go here... /// // OpenGL drawing commands go here...
/// ///
/// // End the current frame and display its contents on screen /// // End the current frame and display its contents on screen
/// window.Display(); /// window.display();
/// } /// }
/// \endcode /// \endcode
/// ///

8
src/SFML/Audio/ALCheck.cpp
View file

@ -25,7 +25,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Headers // Headers
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
#include <SFML/Audio/AudioDevice.hpp> #include <SFML/Audio/AudioDevice.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
@ -35,7 +35,7 @@ namespace sf
namespace priv namespace priv
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ALCheckError(const std::string& file, unsigned int line) void alCheckError(const std::string& file, unsigned int line)
{ {
// Get the last error // Get the last error
ALenum errorCode = alGetError(); ALenum errorCode = alGetError();
@ -84,7 +84,7 @@ void ALCheckError(const std::string& file, unsigned int line)
} }
// Log the error // Log the error
Err() << "An internal OpenAL call failed in " err() << "An internal OpenAL call failed in "
<< file.substr(file.find_last_of("\\/") + 1) << " (" << line << ") : " << file.substr(file.find_last_of("\\/") + 1) << " (" << line << ") : "
<< error << ", " << description << error << ", " << description
<< std::endl; << std::endl;
@ -95,7 +95,7 @@ void ALCheckError(const std::string& file, unsigned int line)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// Make sure that OpenAL is initialized /// Make sure that OpenAL is initialized
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void EnsureALInit() void ensureALInit()
{ {
// The audio device is instanciated on demand rather than at global startup, // The audio device is instanciated on demand rather than at global startup,
// which solves a lot of weird crashes and errors. // which solves a lot of weird crashes and errors.

11
src/SFML/Audio/ALCheck.hpp
View file

@ -40,18 +40,17 @@ namespace sf
namespace priv namespace priv
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// Let's define a macro to quickly check every OpenAL /// Let's define a macro to quickly check every OpenAL API calls
/// API calls
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#ifdef SFML_DEBUG #ifdef SFML_DEBUG
// If in debug mode, perform a test on every call // If in debug mode, perform a test on every call
#define ALCheck(Func) ((Func), priv::ALCheckError(__FILE__, __LINE__)) #define alCheck(Func) ((Func), priv::alCheckError(__FILE__, __LINE__))
#else #else
// Else, we don't add any overhead // Else, we don't add any overhead
#define ALCheck(Func) (Func) #define alCheck(Func) (Func)
#endif #endif
@ -63,13 +62,13 @@ namespace priv
/// \param line Line number of the source file where the call is located /// \param line Line number of the source file where the call is located
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ALCheckError(const std::string& file, unsigned int line); void alCheckError(const std::string& file, unsigned int line);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// Make sure that OpenAL is initialized /// Make sure that OpenAL is initialized
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void EnsureALInit(); void ensureALInit();
} // namespace priv } // namespace priv

14
src/SFML/Audio/AudioDevice.cpp
View file

@ -26,7 +26,7 @@
// Headers // Headers
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/AudioDevice.hpp> #include <SFML/Audio/AudioDevice.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
#include <SFML/Audio/Listener.hpp> #include <SFML/Audio/Listener.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
@ -59,12 +59,12 @@ AudioDevice::AudioDevice()
} }
else else
{ {
Err() << "Failed to create the audio context" << std::endl; err() << "Failed to create the audio context" << std::endl;
} }
} }
else else
{ {
Err() << "Failed to open the audio device" << std::endl; err() << "Failed to open the audio device" << std::endl;
} }
} }
@ -84,9 +84,9 @@ AudioDevice::~AudioDevice()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool AudioDevice::IsExtensionSupported(const std::string& extension) bool AudioDevice::isExtensionSupported(const std::string& extension)
{ {
EnsureALInit(); ensureALInit();
if ((extension.length() > 2) && (extension.substr(0, 3) == "ALC")) if ((extension.length() > 2) && (extension.substr(0, 3) == "ALC"))
return alcIsExtensionPresent(audioDevice, extension.c_str()) != AL_FALSE; return alcIsExtensionPresent(audioDevice, extension.c_str()) != AL_FALSE;
@ -96,9 +96,9 @@ bool AudioDevice::IsExtensionSupported(const std::string& extension)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int AudioDevice::GetFormatFromChannelCount(unsigned int channelCount) int AudioDevice::getFormatFromChannelCount(unsigned int channelCount)
{ {
EnsureALInit(); ensureALInit();
// Find the good format according to the number of channels // Find the good format according to the number of channels
switch (channelCount) switch (channelCount)

4
src/SFML/Audio/AudioDevice.hpp
View file

@ -70,7 +70,7 @@ public :
/// \return True if the extension is supported, false if not /// \return True if the extension is supported, false if not
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static bool IsExtensionSupported(const std::string& extension); static bool isExtensionSupported(const std::string& extension);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the OpenAL format that matches the given number of channels /// \brief Get the OpenAL format that matches the given number of channels
@ -80,7 +80,7 @@ public :
/// \return Corresponding format /// \return Corresponding format
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static int GetFormatFromChannelCount(unsigned int channelCount); static int getFormatFromChannelCount(unsigned int channelCount);
}; };
} // namespace priv } // namespace priv

46
src/SFML/Audio/Listener.cpp
View file

@ -26,84 +26,84 @@
// Headers // Headers
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/Listener.hpp> #include <SFML/Audio/Listener.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
namespace sf namespace sf
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Listener::SetGlobalVolume(float volume) void Listener::setGlobalVolume(float volume)
{ {
priv::EnsureALInit(); priv::ensureALInit();
ALCheck(alListenerf(AL_GAIN, volume * 0.01f)); alCheck(alListenerf(AL_GAIN, volume * 0.01f));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float Listener::GetGlobalVolume() float Listener::getGlobalVolume()
{ {
priv::EnsureALInit(); priv::ensureALInit();
float volume = 0.f; float volume = 0.f;
ALCheck(alGetListenerf(AL_GAIN, &volume)); alCheck(alGetListenerf(AL_GAIN, &volume));
return volume * 100; return volume * 100;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Listener::SetPosition(float x, float y, float z) void Listener::setPosition(float x, float y, float z)
{ {
priv::EnsureALInit(); priv::ensureALInit();
ALCheck(alListener3f(AL_POSITION, x, y, z)); alCheck(alListener3f(AL_POSITION, x, y, z));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Listener::SetPosition(const Vector3f& position) void Listener::setPosition(const Vector3f& position)
{ {
SetPosition(position.x, position.y, position.z); setPosition(position.x, position.y, position.z);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector3f Listener::GetPosition() Vector3f Listener::getPosition()
{ {
priv::EnsureALInit(); priv::ensureALInit();
Vector3f position; Vector3f position;
ALCheck(alGetListener3f(AL_POSITION, &position.x, &position.y, &position.z)); alCheck(alGetListener3f(AL_POSITION, &position.x, &position.y, &position.z));
return position; return position;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Listener::SetDirection(float x, float y, float z) void Listener::setDirection(float x, float y, float z)
{ {
priv::EnsureALInit(); priv::ensureALInit();
float orientation[] = {x, y, z, 0.f, 1.f, 0.f}; float orientation[] = {x, y, z, 0.f, 1.f, 0.f};
ALCheck(alListenerfv(AL_ORIENTATION, orientation)); alCheck(alListenerfv(AL_ORIENTATION, orientation));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Listener::SetDirection(const Vector3f& direction) void Listener::setDirection(const Vector3f& direction)
{ {
SetDirection(direction.x, direction.y, direction.z); setDirection(direction.x, direction.y, direction.z);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector3f Listener::GetDirection() Vector3f Listener::getDirection()
{ {
priv::EnsureALInit(); priv::ensureALInit();
float orientation[6]; float orientation[6];
ALCheck(alGetListenerfv(AL_ORIENTATION, orientation)); alCheck(alGetListenerfv(AL_ORIENTATION, orientation));
return Vector3f(orientation[0], orientation[1], orientation[2]); return Vector3f(orientation[0], orientation[1], orientation[2]);
} }

50
src/SFML/Audio/Music.cpp
View file

@ -26,7 +26,7 @@
// Headers // Headers
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/Music.hpp> #include <SFML/Audio/Music.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
#include <SFML/Audio/SoundFile.hpp> #include <SFML/Audio/SoundFile.hpp>
#include <SFML/System/Lock.hpp> #include <SFML/System/Lock.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
@ -48,104 +48,104 @@ m_duration()
Music::~Music() Music::~Music()
{ {
// We must stop before destroying the file :) // We must stop before destroying the file :)
Stop(); stop();
delete m_file; delete m_file;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Music::OpenFromFile(const std::string& filename) bool Music::openFromFile(const std::string& filename)
{ {
// First stop the music if it was already running // First stop the music if it was already running
Stop(); stop();
// Open the underlying sound file // Open the underlying sound file
if (!m_file->OpenRead(filename)) if (!m_file->openRead(filename))
return false; return false;
// Perform common initializations // Perform common initializations
Initialize(); initialize();
return true; return true;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Music::OpenFromMemory(const void* data, std::size_t sizeInBytes) bool Music::openFromMemory(const void* data, std::size_t sizeInBytes)
{ {
// First stop the music if it was already running // First stop the music if it was already running
Stop(); stop();
// Open the underlying sound file // Open the underlying sound file
if (!m_file->OpenRead(data, sizeInBytes)) if (!m_file->openRead(data, sizeInBytes))
return false; return false;
// Perform common initializations // Perform common initializations
Initialize(); initialize();
return true; return true;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Music::OpenFromStream(InputStream& stream) bool Music::openFromStream(InputStream& stream)
{ {
// First stop the music if it was already running // First stop the music if it was already running
Stop(); stop();
// Open the underlying sound file // Open the underlying sound file
if (!m_file->OpenRead(stream)) if (!m_file->openRead(stream))
return false; return false;
// Perform common initializations // Perform common initializations
Initialize(); initialize();
return true; return true;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time Music::GetDuration() const Time Music::getDuration() const
{ {
return m_duration; return m_duration;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Music::OnGetData(SoundStream::Chunk& data) bool Music::onGetData(SoundStream::Chunk& data)
{ {
Lock lock(m_mutex); Lock lock(m_mutex);
// Fill the chunk parameters // Fill the chunk parameters
data.Samples = &m_samples[0]; data.samples = &m_samples[0];
data.SampleCount = m_file->Read(&m_samples[0], m_samples.size()); data.sampleCount = m_file->read(&m_samples[0], m_samples.size());
// Check if we have reached the end of the audio file // Check if we have reached the end of the audio file
return data.SampleCount == m_samples.size(); return data.sampleCount == m_samples.size();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Music::OnSeek(Time timeOffset) void Music::onSeek(Time timeOffset)
{ {
Lock lock(m_mutex); Lock lock(m_mutex);
m_file->Seek(timeOffset); m_file->seek(timeOffset);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Music::Initialize() void Music::initialize()
{ {
// Compute the music duration // Compute the music duration
m_duration = Seconds(static_cast<float>(m_file->GetSampleCount()) / m_file->GetSampleRate() / m_file->GetChannelCount()); m_duration = seconds(static_cast<float>(m_file->getSampleCount()) / m_file->getSampleRate() / m_file->getChannelCount());
// Resize the internal buffer so that it can contain 1 second of audio samples // Resize the internal buffer so that it can contain 1 second of audio samples
m_samples.resize(m_file->GetSampleRate() * m_file->GetChannelCount()); m_samples.resize(m_file->getSampleRate() * m_file->getChannelCount());
// Initialize the stream // Initialize the stream
SoundStream::Initialize(m_file->GetChannelCount(), m_file->GetSampleRate()); SoundStream::initialize(m_file->getChannelCount(), m_file->getSampleRate());
} }
} // namespace sf } // namespace sf

86
src/SFML/Audio/Sound.cpp
View file

@ -27,7 +27,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/Sound.hpp> #include <SFML/Audio/Sound.hpp>
#include <SFML/Audio/SoundBuffer.hpp> #include <SFML/Audio/SoundBuffer.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
namespace sf namespace sf
@ -43,7 +43,7 @@ m_buffer(NULL)
Sound::Sound(const SoundBuffer& buffer) : Sound::Sound(const SoundBuffer& buffer) :
m_buffer(NULL) m_buffer(NULL)
{ {
SetBuffer(buffer); setBuffer(buffer);
} }
@ -53,103 +53,103 @@ SoundSource(copy),
m_buffer (NULL) m_buffer (NULL)
{ {
if (copy.m_buffer) if (copy.m_buffer)
SetBuffer(*copy.m_buffer); setBuffer(*copy.m_buffer);
SetLoop(copy.GetLoop()); setLoop(copy.getLoop());
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Sound::~Sound() Sound::~Sound()
{ {
Stop(); stop();
if (m_buffer) if (m_buffer)
m_buffer->DetachSound(this); m_buffer->detachSound(this);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::Play() void Sound::play()
{ {
ALCheck(alSourcePlay(m_source)); alCheck(alSourcePlay(m_source));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::Pause() void Sound::pause()
{ {
ALCheck(alSourcePause(m_source)); alCheck(alSourcePause(m_source));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::Stop() void Sound::stop()
{ {
ALCheck(alSourceStop(m_source)); alCheck(alSourceStop(m_source));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::SetBuffer(const SoundBuffer& buffer) void Sound::setBuffer(const SoundBuffer& buffer)
{ {
// First detach from the previous buffer // First detach from the previous buffer
if (m_buffer) if (m_buffer)
{ {
Stop(); stop();
m_buffer->DetachSound(this); m_buffer->detachSound(this);
} }
// Assign and use the new buffer // Assign and use the new buffer
m_buffer = &buffer; m_buffer = &buffer;
m_buffer->AttachSound(this); m_buffer->attachSound(this);
ALCheck(alSourcei(m_source, AL_BUFFER, m_buffer->m_buffer)); alCheck(alSourcei(m_source, AL_BUFFER, m_buffer->m_buffer));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::SetLoop(bool Loop) void Sound::setLoop(bool Loop)
{ {
ALCheck(alSourcei(m_source, AL_LOOPING, Loop)); alCheck(alSourcei(m_source, AL_LOOPING, Loop));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::SetPlayingOffset(Time timeOffset) void Sound::setPlayingOffset(Time timeOffset)
{ {
ALCheck(alSourcef(m_source, AL_SEC_OFFSET, timeOffset.AsSeconds())); alCheck(alSourcef(m_source, AL_SEC_OFFSET, timeOffset.asSeconds()));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const SoundBuffer* Sound::GetBuffer() const const SoundBuffer* Sound::getBuffer() const
{ {
return m_buffer; return m_buffer;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Sound::GetLoop() const bool Sound::getLoop() const
{ {
ALint loop; ALint loop;
ALCheck(alGetSourcei(m_source, AL_LOOPING, &loop)); alCheck(alGetSourcei(m_source, AL_LOOPING, &loop));
return loop != 0; return loop != 0;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time Sound::GetPlayingOffset() const Time Sound::getPlayingOffset() const
{ {
ALfloat seconds = 0.f; ALfloat secs = 0.f;
ALCheck(alGetSourcef(m_source, AL_SEC_OFFSET, &seconds)); alCheck(alGetSourcef(m_source, AL_SEC_OFFSET, &secs));
return Seconds(seconds); return seconds(secs);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Sound::Status Sound::GetStatus() const Sound::Status Sound::getStatus() const
{ {
return SoundSource::GetStatus(); return SoundSource::getStatus();
} }
@ -162,34 +162,34 @@ Sound& Sound::operator =(const Sound& right)
// Detach the sound instance from the previous buffer (if any) // Detach the sound instance from the previous buffer (if any)
if (m_buffer) if (m_buffer)
{ {
Stop(); stop();
m_buffer->DetachSound(this); m_buffer->detachSound(this);
m_buffer = NULL; m_buffer = NULL;
} }
// Copy the sound attributes // Copy the sound attributes
if (right.m_buffer) if (right.m_buffer)
SetBuffer(*right.m_buffer); setBuffer(*right.m_buffer);
SetLoop(right.GetLoop()); setLoop(right.getLoop());
SetPitch(right.GetPitch()); setPitch(right.getPitch());
SetVolume(right.GetVolume()); setVolume(right.getVolume());
SetPosition(right.GetPosition()); setPosition(right.getPosition());
SetRelativeToListener(right.IsRelativeToListener()); setRelativeToListener(right.isRelativeToListener());
SetMinDistance(right.GetMinDistance()); setMinDistance(right.getMinDistance());
SetAttenuation(right.GetAttenuation()); setAttenuation(right.getAttenuation());
return *this; return *this;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Sound::ResetBuffer() void Sound::resetBuffer()
{ {
// First stop the sound in case it is playing // First stop the sound in case it is playing
Stop(); stop();
// Detach the buffer // Detach the buffer
ALCheck(alSourcei(m_source, AL_BUFFER, 0)); alCheck(alSourcei(m_source, AL_BUFFER, 0));
m_buffer = NULL; m_buffer = NULL;
} }

84
src/SFML/Audio/SoundBuffer.cpp
View file

@ -29,7 +29,7 @@
#include <SFML/Audio/SoundFile.hpp> #include <SFML/Audio/SoundFile.hpp>
#include <SFML/Audio/Sound.hpp> #include <SFML/Audio/Sound.hpp>
#include <SFML/Audio/AudioDevice.hpp> #include <SFML/Audio/AudioDevice.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
#include <memory> #include <memory>
@ -41,10 +41,10 @@ SoundBuffer::SoundBuffer() :
m_buffer (0), m_buffer (0),
m_duration() m_duration()
{ {
priv::EnsureALInit(); priv::ensureALInit();
// Create the buffer // Create the buffer
ALCheck(alGenBuffers(1, &m_buffer)); alCheck(alGenBuffers(1, &m_buffer));
} }
@ -56,10 +56,10 @@ m_duration(copy.m_duration),
m_sounds () // don't copy the attached sounds m_sounds () // don't copy the attached sounds
{ {
// Create the buffer // Create the buffer
ALCheck(alGenBuffers(1, &m_buffer)); alCheck(alGenBuffers(1, &m_buffer));
// Update the internal buffer with the new samples // Update the internal buffer with the new samples
Update(copy.GetChannelCount(), copy.GetSampleRate()); update(copy.getChannelCount(), copy.getSampleRate());
} }
@ -68,49 +68,49 @@ SoundBuffer::~SoundBuffer()
{ {
// First detach the buffer from the sounds that use it (to avoid OpenAL errors) // First detach the buffer from the sounds that use it (to avoid OpenAL errors)
for (SoundList::const_iterator it = m_sounds.begin(); it != m_sounds.end(); ++it) for (SoundList::const_iterator it = m_sounds.begin(); it != m_sounds.end(); ++it)
(*it)->ResetBuffer(); (*it)->resetBuffer();
// Destroy the buffer // Destroy the buffer
if (m_buffer) if (m_buffer)
ALCheck(alDeleteBuffers(1, &m_buffer)); alCheck(alDeleteBuffers(1, &m_buffer));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::LoadFromFile(const std::string& filename) bool SoundBuffer::loadFromFile(const std::string& filename)
{ {
priv::SoundFile file; priv::SoundFile file;
if (file.OpenRead(filename)) if (file.openRead(filename))
return Initialize(file); return initialize(file);
else else
return false; return false;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::LoadFromMemory(const void* data, std::size_t sizeInBytes) bool SoundBuffer::loadFromMemory(const void* data, std::size_t sizeInBytes)
{ {
priv::SoundFile file; priv::SoundFile file;
if (file.OpenRead(data, sizeInBytes)) if (file.openRead(data, sizeInBytes))
return Initialize(file); return initialize(file);
else else
return false; return false;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::LoadFromStream(InputStream& stream) bool SoundBuffer::loadFromStream(InputStream& stream)
{ {
priv::SoundFile file; priv::SoundFile file;
if (file.OpenRead(stream)) if (file.openRead(stream))
return Initialize(file); return initialize(file);
else else
return false; return false;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::LoadFromSamples(const Int16* samples, std::size_t sampleCount, unsigned int channelCount, unsigned int sampleRate) bool SoundBuffer::loadFromSamples(const Int16* samples, std::size_t sampleCount, unsigned int channelCount, unsigned int sampleRate)
{ {
if (samples && sampleCount && channelCount && sampleRate) if (samples && sampleCount && channelCount && sampleRate)
{ {
@ -118,12 +118,12 @@ bool SoundBuffer::LoadFromSamples(const Int16* samples, std::size_t sampleCount,
m_samples.assign(samples, samples + sampleCount); m_samples.assign(samples, samples + sampleCount);
// Update the internal buffer with the new samples // Update the internal buffer with the new samples
return Update(channelCount, sampleRate); return update(channelCount, sampleRate);
} }
else else
{ {
// Error... // Error...
Err() << "Failed to load sound buffer from samples (" err() << "Failed to load sound buffer from samples ("
<< "array: " << samples << ", " << "array: " << samples << ", "
<< "count: " << sampleCount << ", " << "count: " << sampleCount << ", "
<< "channels: " << channelCount << ", " << "channels: " << channelCount << ", "
@ -136,14 +136,14 @@ bool SoundBuffer::LoadFromSamples(const Int16* samples, std::size_t sampleCount,
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::SaveToFile(const std::string& filename) const bool SoundBuffer::saveToFile(const std::string& filename) const
{ {
// Create the sound file in write mode // Create the sound file in write mode
priv::SoundFile file; priv::SoundFile file;
if (file.OpenWrite(filename, GetChannelCount(), GetSampleRate())) if (file.openWrite(filename, getChannelCount(), getSampleRate()))
{ {
// Write the samples to the opened file // Write the samples to the opened file
file.Write(&m_samples[0], m_samples.size()); file.write(&m_samples[0], m_samples.size());
return true; return true;
} }
@ -155,41 +155,41 @@ bool SoundBuffer::SaveToFile(const std::string& filename) const
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Int16* SoundBuffer::GetSamples() const const Int16* SoundBuffer::getSamples() const
{ {
return m_samples.empty() ? NULL : &m_samples[0]; return m_samples.empty() ? NULL : &m_samples[0];
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t SoundBuffer::GetSampleCount() const std::size_t SoundBuffer::getSampleCount() const
{ {
return m_samples.size(); return m_samples.size();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundBuffer::GetSampleRate() const unsigned int SoundBuffer::getSampleRate() const
{ {
ALint sampleRate; ALint sampleRate;
ALCheck(alGetBufferi(m_buffer, AL_FREQUENCY, &sampleRate)); alCheck(alGetBufferi(m_buffer, AL_FREQUENCY, &sampleRate));
return sampleRate; return sampleRate;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundBuffer::GetChannelCount() const unsigned int SoundBuffer::getChannelCount() const
{ {
ALint channelCount; ALint channelCount;
ALCheck(alGetBufferi(m_buffer, AL_CHANNELS, &channelCount)); alCheck(alGetBufferi(m_buffer, AL_CHANNELS, &channelCount));
return channelCount; return channelCount;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time SoundBuffer::GetDuration() const Time SoundBuffer::getDuration() const
{ {
return m_duration; return m_duration;
} }
@ -210,19 +210,19 @@ SoundBuffer& SoundBuffer::operator =(const SoundBuffer& right)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::Initialize(priv::SoundFile& file) bool SoundBuffer::initialize(priv::SoundFile& file)
{ {
// Retrieve the sound parameters // Retrieve the sound parameters
std::size_t sampleCount = file.GetSampleCount(); std::size_t sampleCount = file.getSampleCount();
unsigned int channelCount = file.GetChannelCount(); unsigned int channelCount = file.getChannelCount();
unsigned int sampleRate = file.GetSampleRate(); unsigned int sampleRate = file.getSampleRate();
// Read the samples from the provided file // Read the samples from the provided file
m_samples.resize(sampleCount); m_samples.resize(sampleCount);
if (file.Read(&m_samples[0], sampleCount) == sampleCount) if (file.read(&m_samples[0], sampleCount) == sampleCount)
{ {
// Update the internal buffer with the new samples // Update the internal buffer with the new samples
return Update(channelCount, sampleRate); return update(channelCount, sampleRate);
} }
else else
{ {
@ -232,42 +232,42 @@ bool SoundBuffer::Initialize(priv::SoundFile& file)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBuffer::Update(unsigned int channelCount, unsigned int sampleRate) bool SoundBuffer::update(unsigned int channelCount, unsigned int sampleRate)
{ {
// Check parameters // Check parameters
if (!channelCount || !sampleRate || m_samples.empty()) if (!channelCount || !sampleRate || m_samples.empty())
return false; return false;
// Find the good format according to the number of channels // Find the good format according to the number of channels
ALenum format = priv::AudioDevice::GetFormatFromChannelCount(channelCount); ALenum format = priv::AudioDevice::getFormatFromChannelCount(channelCount);
// Check if the format is valid // Check if the format is valid
if (format == 0) if (format == 0)
{ {
Err() << "Failed to load sound buffer (unsupported number of channels: " << channelCount << ")" << std::endl; err() << "Failed to load sound buffer (unsupported number of channels: " << channelCount << ")" << std::endl;
return false; return false;
} }
// Fill the buffer // Fill the buffer
ALsizei size = static_cast<ALsizei>(m_samples.size()) * sizeof(Int16); ALsizei size = static_cast<ALsizei>(m_samples.size()) * sizeof(Int16);
ALCheck(alBufferData(m_buffer, format, &m_samples[0], size, sampleRate)); alCheck(alBufferData(m_buffer, format, &m_samples[0], size, sampleRate));
// Compute the duration // Compute the duration
m_duration = Milliseconds(1000 * m_samples.size() / sampleRate / channelCount); m_duration = milliseconds(1000 * m_samples.size() / sampleRate / channelCount);
return true; return true;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundBuffer::AttachSound(Sound* sound) const void SoundBuffer::attachSound(Sound* sound) const
{ {
m_sounds.insert(sound); m_sounds.insert(sound);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundBuffer::DetachSound(Sound* sound) const void SoundBuffer::detachSound(Sound* sound) const
{ {
m_sounds.erase(sound); m_sounds.erase(sound);
} }

10
src/SFML/Audio/SoundBufferRecorder.cpp
View file

@ -33,7 +33,7 @@
namespace sf namespace sf
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBufferRecorder::OnStart() bool SoundBufferRecorder::onStart()
{ {
m_samples.clear(); m_samples.clear();
m_buffer = SoundBuffer(); m_buffer = SoundBuffer();
@ -43,7 +43,7 @@ bool SoundBufferRecorder::OnStart()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundBufferRecorder::OnProcessSamples(const Int16* samples, std::size_t sampleCount) bool SoundBufferRecorder::onProcessSamples(const Int16* samples, std::size_t sampleCount)
{ {
std::copy(samples, samples + sampleCount, std::back_inserter(m_samples)); std::copy(samples, samples + sampleCount, std::back_inserter(m_samples));
@ -52,15 +52,15 @@ bool SoundBufferRecorder::OnProcessSamples(const Int16* samples, std::size_t sam
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundBufferRecorder::OnStop() void SoundBufferRecorder::onStop()
{ {
if (!m_samples.empty()) if (!m_samples.empty())
m_buffer.LoadFromSamples(&m_samples[0], m_samples.size(), 1, GetSampleRate()); m_buffer.loadFromSamples(&m_samples[0], m_samples.size(), 1, getSampleRate());
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const SoundBuffer& SoundBufferRecorder::GetBuffer() const const SoundBuffer& SoundBufferRecorder::getBuffer() const
{ {
return m_buffer; return m_buffer;
} }

134
src/SFML/Audio/SoundFile.cpp
View file

@ -35,7 +35,7 @@
namespace namespace
{ {
// Convert a string to lower case // Convert a string to lower case
std::string ToLower(std::string str) std::string toLower(std::string str)
{ {
for (std::string::iterator i = str.begin(); i != str.end(); ++i) for (std::string::iterator i = str.begin(); i != str.end(); ++i)
*i = static_cast<char>(std::tolower(*i)); *i = static_cast<char>(std::tolower(*i));
@ -68,28 +68,28 @@ SoundFile::~SoundFile()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t SoundFile::GetSampleCount() const std::size_t SoundFile::getSampleCount() const
{ {
return m_sampleCount; return m_sampleCount;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundFile::GetChannelCount() const unsigned int SoundFile::getChannelCount() const
{ {
return m_channelCount; return m_channelCount;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundFile::GetSampleRate() const unsigned int SoundFile::getSampleRate() const
{ {
return m_sampleRate; return m_sampleRate;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundFile::OpenRead(const std::string& filename) bool SoundFile::openRead(const std::string& filename)
{ {
// If the file is already opened, first close it // If the file is already opened, first close it
if (m_file) if (m_file)
@ -100,7 +100,7 @@ bool SoundFile::OpenRead(const std::string& filename)
m_file = sf_open(filename.c_str(), SFM_READ, &fileInfos); m_file = sf_open(filename.c_str(), SFM_READ, &fileInfos);
if (!m_file) if (!m_file)
{ {
Err() << "Failed to open sound file \"" << filename << "\" (" << sf_strerror(m_file) << ")" << std::endl; err() << "Failed to open sound file \"" << filename << "\" (" << sf_strerror(m_file) << ")" << std::endl;
return false; return false;
} }
@ -114,7 +114,7 @@ bool SoundFile::OpenRead(const std::string& filename)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundFile::OpenRead(const void* data, std::size_t sizeInBytes) bool SoundFile::openRead(const void* data, std::size_t sizeInBytes)
{ {
// If the file is already opened, first close it // If the file is already opened, first close it
if (m_file) if (m_file)
@ -122,10 +122,10 @@ bool SoundFile::OpenRead(const void* data, std::size_t sizeInBytes)
// Prepare the memory I/O structure // Prepare the memory I/O structure
SF_VIRTUAL_IO io; SF_VIRTUAL_IO io;
io.get_filelen = &Memory::GetLength; io.get_filelen = &Memory::getLength;
io.read = &Memory::Read; io.read = &Memory::read;
io.seek = &Memory::Seek; io.seek = &Memory::seek;
io.tell = &Memory::Tell; io.tell = &Memory::tell;
// Initialize the memory data // Initialize the memory data
m_memory.DataStart = static_cast<const char*>(data); m_memory.DataStart = static_cast<const char*>(data);
@ -137,7 +137,7 @@ bool SoundFile::OpenRead(const void* data, std::size_t sizeInBytes)
m_file = sf_open_virtual(&io, SFM_READ, &fileInfos, &m_memory); m_file = sf_open_virtual(&io, SFM_READ, &fileInfos, &m_memory);
if (!m_file) if (!m_file)
{ {
Err() << "Failed to open sound file from memory (" << sf_strerror(m_file) << ")" << std::endl; err() << "Failed to open sound file from memory (" << sf_strerror(m_file) << ")" << std::endl;
return false; return false;
} }
@ -151,7 +151,7 @@ bool SoundFile::OpenRead(const void* data, std::size_t sizeInBytes)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundFile::OpenRead(InputStream& stream) bool SoundFile::openRead(InputStream& stream)
{ {
// If the file is already opened, first close it // If the file is already opened, first close it
if (m_file) if (m_file)
@ -159,17 +159,17 @@ bool SoundFile::OpenRead(InputStream& stream)
// Prepare the memory I/O structure // Prepare the memory I/O structure
SF_VIRTUAL_IO io; SF_VIRTUAL_IO io;
io.get_filelen = &Stream::GetLength; io.get_filelen = &Stream::getLength;
io.read = &Stream::Read; io.read = &Stream::read;
io.seek = &Stream::Seek; io.seek = &Stream::seek;
io.tell = &Stream::Tell; io.tell = &Stream::tell;
// Open the sound file // Open the sound file
SF_INFO fileInfos; SF_INFO fileInfos;
m_file = sf_open_virtual(&io, SFM_READ, &fileInfos, &stream); m_file = sf_open_virtual(&io, SFM_READ, &fileInfos, &stream);
if (!m_file) if (!m_file)
{ {
Err() << "Failed to open sound file from stream (" << sf_strerror(m_file) << ")" << std::endl; err() << "Failed to open sound file from stream (" << sf_strerror(m_file) << ")" << std::endl;
return false; return false;
} }
@ -183,18 +183,18 @@ bool SoundFile::OpenRead(InputStream& stream)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundFile::OpenWrite(const std::string& filename, unsigned int channelCount, unsigned int sampleRate) bool SoundFile::openWrite(const std::string& filename, unsigned int channelCount, unsigned int sampleRate)
{ {
// If the file is already opened, first close it // If the file is already opened, first close it
if (m_file) if (m_file)
sf_close(m_file); sf_close(m_file);
// Find the right format according to the file extension // Find the right format according to the file extension
int format = GetFormatFromFilename(filename); int format = getFormatFromFilename(filename);
if (format == -1) if (format == -1)
{ {
// Error : unrecognized extension // Error : unrecognized extension
Err() << "Failed to create sound file \"" << filename << "\" (unknown format)" << std::endl; err() << "Failed to create sound file \"" << filename << "\" (unknown format)" << std::endl;
return false; return false;
} }
@ -208,7 +208,7 @@ bool SoundFile::OpenWrite(const std::string& filename, unsigned int channelCount
m_file = sf_open(filename.c_str(), SFM_WRITE, &fileInfos); m_file = sf_open(filename.c_str(), SFM_WRITE, &fileInfos);
if (!m_file) if (!m_file)
{ {
Err() << "Failed to create sound file \"" << filename << "\" (" << sf_strerror(m_file) << ")" << std::endl; err() << "Failed to create sound file \"" << filename << "\" (" << sf_strerror(m_file) << ")" << std::endl;
return false; return false;
} }
@ -222,7 +222,7 @@ bool SoundFile::OpenWrite(const std::string& filename, unsigned int channelCount
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t SoundFile::Read(Int16* data, std::size_t sampleCount) std::size_t SoundFile::read(Int16* data, std::size_t sampleCount)
{ {
if (m_file && data && sampleCount) if (m_file && data && sampleCount)
return static_cast<std::size_t>(sf_read_short(m_file, data, sampleCount)); return static_cast<std::size_t>(sf_read_short(m_file, data, sampleCount));
@ -232,7 +232,7 @@ std::size_t SoundFile::Read(Int16* data, std::size_t sampleCount)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundFile::Write(const Int16* data, std::size_t sampleCount) void SoundFile::write(const Int16* data, std::size_t sampleCount)
{ {
if (m_file && data && sampleCount) if (m_file && data && sampleCount)
{ {
@ -250,18 +250,18 @@ void SoundFile::Write(const Int16* data, std::size_t sampleCount)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundFile::Seek(Time timeOffset) void SoundFile::seek(Time timeOffset)
{ {
if (m_file) if (m_file)
{ {
sf_count_t frameOffset = static_cast<sf_count_t>(timeOffset.AsSeconds() * m_sampleRate); sf_count_t frameOffset = static_cast<sf_count_t>(timeOffset.asSeconds() * m_sampleRate);
sf_seek(m_file, frameOffset, SEEK_SET); sf_seek(m_file, frameOffset, SEEK_SET);
} }
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int SoundFile::GetFormatFromFilename(const std::string& filename) int SoundFile::getFormatFromFilename(const std::string& filename)
{ {
// Extract the extension // Extract the extension
std::string ext = "wav"; std::string ext = "wav";
@ -270,38 +270,38 @@ int SoundFile::GetFormatFromFilename(const std::string& filename)
ext = filename.substr(pos + 1); ext = filename.substr(pos + 1);
// Match every supported extension with its format constant // Match every supported extension with its format constant
if (ToLower(ext) == "wav" ) return SF_FORMAT_WAV; if (toLower(ext) == "wav" ) return SF_FORMAT_WAV;
if (ToLower(ext) == "aif" ) return SF_FORMAT_AIFF; if (toLower(ext) == "aif" ) return SF_FORMAT_AIFF;
if (ToLower(ext) == "aiff" ) return SF_FORMAT_AIFF; if (toLower(ext) == "aiff" ) return SF_FORMAT_AIFF;
if (ToLower(ext) == "au" ) return SF_FORMAT_AU; if (toLower(ext) == "au" ) return SF_FORMAT_AU;
if (ToLower(ext) == "raw" ) return SF_FORMAT_RAW; if (toLower(ext) == "raw" ) return SF_FORMAT_RAW;
if (ToLower(ext) == "paf" ) return SF_FORMAT_PAF; if (toLower(ext) == "paf" ) return SF_FORMAT_PAF;
if (ToLower(ext) == "svx" ) return SF_FORMAT_SVX; if (toLower(ext) == "svx" ) return SF_FORMAT_SVX;
if (ToLower(ext) == "nist" ) return SF_FORMAT_NIST; if (toLower(ext) == "nist" ) return SF_FORMAT_NIST;
if (ToLower(ext) == "voc" ) return SF_FORMAT_VOC; if (toLower(ext) == "voc" ) return SF_FORMAT_VOC;
if (ToLower(ext) == "sf" ) return SF_FORMAT_IRCAM; if (toLower(ext) == "sf" ) return SF_FORMAT_IRCAM;
if (ToLower(ext) == "w64" ) return SF_FORMAT_W64; if (toLower(ext) == "w64" ) return SF_FORMAT_W64;
if (ToLower(ext) == "mat4" ) return SF_FORMAT_MAT4; if (toLower(ext) == "mat4" ) return SF_FORMAT_MAT4;
if (ToLower(ext) == "mat5" ) return SF_FORMAT_MAT5; if (toLower(ext) == "mat5" ) return SF_FORMAT_MAT5;
if (ToLower(ext) == "pvf" ) return SF_FORMAT_PVF; if (toLower(ext) == "pvf" ) return SF_FORMAT_PVF;
if (ToLower(ext) == "xi" ) return SF_FORMAT_XI; if (toLower(ext) == "xi" ) return SF_FORMAT_XI;
if (ToLower(ext) == "htk" ) return SF_FORMAT_HTK; if (toLower(ext) == "htk" ) return SF_FORMAT_HTK;
if (ToLower(ext) == "sds" ) return SF_FORMAT_SDS; if (toLower(ext) == "sds" ) return SF_FORMAT_SDS;
if (ToLower(ext) == "avr" ) return SF_FORMAT_AVR; if (toLower(ext) == "avr" ) return SF_FORMAT_AVR;
if (ToLower(ext) == "sd2" ) return SF_FORMAT_SD2; if (toLower(ext) == "sd2" ) return SF_FORMAT_SD2;
if (ToLower(ext) == "flac" ) return SF_FORMAT_FLAC; if (toLower(ext) == "flac" ) return SF_FORMAT_FLAC;
if (ToLower(ext) == "caf" ) return SF_FORMAT_CAF; if (toLower(ext) == "caf" ) return SF_FORMAT_CAF;
if (ToLower(ext) == "wve" ) return SF_FORMAT_WVE; if (toLower(ext) == "wve" ) return SF_FORMAT_WVE;
if (ToLower(ext) == "ogg" ) return SF_FORMAT_OGG; if (toLower(ext) == "ogg" ) return SF_FORMAT_OGG;
if (ToLower(ext) == "mpc2k") return SF_FORMAT_MPC2K; if (toLower(ext) == "mpc2k") return SF_FORMAT_MPC2K;
if (ToLower(ext) == "rf64" ) return SF_FORMAT_RF64; if (toLower(ext) == "rf64" ) return SF_FORMAT_RF64;
return -1; return -1;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Memory::GetLength(void* user) sf_count_t SoundFile::Memory::getLength(void* user)
{ {
Memory* memory = static_cast<Memory*>(user); Memory* memory = static_cast<Memory*>(user);
return memory->TotalSize; return memory->TotalSize;
@ -309,7 +309,7 @@ sf_count_t SoundFile::Memory::GetLength(void* user)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Memory::Read(void* ptr, sf_count_t count, void* user) sf_count_t SoundFile::Memory::read(void* ptr, sf_count_t count, void* user)
{ {
Memory* memory = static_cast<Memory*>(user); Memory* memory = static_cast<Memory*>(user);
@ -324,7 +324,7 @@ sf_count_t SoundFile::Memory::Read(void* ptr, sf_count_t count, void* user)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Memory::Seek(sf_count_t offset, int whence, void* user) sf_count_t SoundFile::Memory::seek(sf_count_t offset, int whence, void* user)
{ {
Memory* memory = static_cast<Memory*>(user); Memory* memory = static_cast<Memory*>(user);
sf_count_t position = 0; sf_count_t position = 0;
@ -347,7 +347,7 @@ sf_count_t SoundFile::Memory::Seek(sf_count_t offset, int whence, void* user)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Memory::Tell(void* user) sf_count_t SoundFile::Memory::tell(void* user)
{ {
Memory* memory = static_cast<Memory*>(user); Memory* memory = static_cast<Memory*>(user);
return memory->DataPtr - memory->DataStart; return memory->DataPtr - memory->DataStart;
@ -355,40 +355,40 @@ sf_count_t SoundFile::Memory::Tell(void* user)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Stream::GetLength(void* userData) sf_count_t SoundFile::Stream::getLength(void* userData)
{ {
sf::InputStream* stream = static_cast<sf::InputStream*>(userData); sf::InputStream* stream = static_cast<sf::InputStream*>(userData);
return stream->GetSize(); return stream->getSize();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Stream::Read(void* ptr, sf_count_t count, void* userData) sf_count_t SoundFile::Stream::read(void* ptr, sf_count_t count, void* userData)
{ {
sf::InputStream* stream = static_cast<sf::InputStream*>(userData); sf::InputStream* stream = static_cast<sf::InputStream*>(userData);
return stream->Read(reinterpret_cast<char*>(ptr), count); return stream->read(reinterpret_cast<char*>(ptr), count);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Stream::Seek(sf_count_t offset, int whence, void* userData) sf_count_t SoundFile::Stream::seek(sf_count_t offset, int whence, void* userData)
{ {
sf::InputStream* stream = static_cast<sf::InputStream*>(userData); sf::InputStream* stream = static_cast<sf::InputStream*>(userData);
switch (whence) switch (whence)
{ {
case SEEK_SET : return stream->Seek(offset); case SEEK_SET : return stream->seek(offset);
case SEEK_CUR : return stream->Seek(stream->Tell() + offset); case SEEK_CUR : return stream->seek(stream->tell() + offset);
case SEEK_END : return stream->Seek(stream->GetSize() - offset); case SEEK_END : return stream->seek(stream->getSize() - offset);
default : return stream->Seek(0); default : return stream->seek(0);
} }
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
sf_count_t SoundFile::Stream::Tell(void* userData) sf_count_t SoundFile::Stream::tell(void* userData)
{ {
sf::InputStream* stream = static_cast<sf::InputStream*>(userData); sf::InputStream* stream = static_cast<sf::InputStream*>(userData);
return stream->Tell(); return stream->tell();
} }
} // namespace priv } // namespace priv

38
src/SFML/Audio/SoundFile.hpp
View file

@ -66,7 +66,7 @@ public :
/// \return Number of samples /// \return Number of samples
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t GetSampleCount() const; std::size_t getSampleCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of channels used by the sound /// \brief Get the number of channels used by the sound
@ -74,7 +74,7 @@ public :
/// \return Number of channels (1 = mono, 2 = stereo) /// \return Number of channels (1 = mono, 2 = stereo)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetChannelCount() const; unsigned int getChannelCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the sample rate of the sound /// \brief Get the sample rate of the sound
@ -82,7 +82,7 @@ public :
/// \return Sample rate, in samples per second /// \return Sample rate, in samples per second
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int GetSampleRate() const; unsigned int getSampleRate() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Open a sound file for reading /// \brief Open a sound file for reading
@ -92,7 +92,7 @@ public :
/// \return True if the file was successfully opened /// \return True if the file was successfully opened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenRead(const std::string& filename); bool openRead(const std::string& filename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Open a sound file in memory for reading /// \brief Open a sound file in memory for reading
@ -103,7 +103,7 @@ public :
/// \return True if the file was successfully opened /// \return True if the file was successfully opened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenRead(const void* data, std::size_t sizeInBytes); bool openRead(const void* data, std::size_t sizeInBytes);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Open a sound file from a custom stream for reading /// \brief Open a sound file from a custom stream for reading
@ -113,7 +113,7 @@ public :
/// \return True if the file was successfully opened /// \return True if the file was successfully opened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenRead(InputStream& stream); bool openRead(InputStream& stream);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief a the sound file for writing /// \brief a the sound file for writing
@ -125,7 +125,7 @@ public :
/// \return True if the file was successfully opened /// \return True if the file was successfully opened
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool OpenWrite(const std::string& filename, unsigned int channelCount, unsigned int sampleRate); bool openWrite(const std::string& filename, unsigned int channelCount, unsigned int sampleRate);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Read audio samples from the loaded sound /// \brief Read audio samples from the loaded sound
@ -136,7 +136,7 @@ public :
/// \return Number of samples actually read (may be less than \a sampleCount) /// \return Number of samples actually read (may be less than \a sampleCount)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
std::size_t Read(Int16* data, std::size_t sampleCount); std::size_t read(Int16* data, std::size_t sampleCount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Write audio samples to the file /// \brief Write audio samples to the file
@ -145,7 +145,7 @@ public :
/// \param sampleCount Number of samples to write /// \param sampleCount Number of samples to write
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Write(const Int16* data, std::size_t sampleCount); void write(const Int16* data, std::size_t sampleCount);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Change the current read position in the file /// \brief Change the current read position in the file
@ -153,7 +153,7 @@ public :
/// \param timeOffset New playing position, from the beginning of the file /// \param timeOffset New playing position, from the beginning of the file
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Seek(Time timeOffset); void seek(Time timeOffset);
private : private :
@ -166,7 +166,7 @@ private :
/// \return Internal format matching the filename (-1 if no match) /// \return Internal format matching the filename (-1 if no match)
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
static int GetFormatFromFilename(const std::string& filename); static int getFormatFromFilename(const std::string& filename);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Data and callbacks for opening from memory /// \brief Data and callbacks for opening from memory
@ -178,10 +178,10 @@ private :
const char* DataPtr; const char* DataPtr;
sf_count_t TotalSize; sf_count_t TotalSize;
static sf_count_t GetLength(void* user); static sf_count_t getLength(void* user);
static sf_count_t Read(void* ptr, sf_count_t count, void* user); static sf_count_t read(void* ptr, sf_count_t count, void* user);
static sf_count_t Seek(sf_count_t offset, int whence, void* user); static sf_count_t seek(sf_count_t offset, int whence, void* user);
static sf_count_t Tell(void* user); static sf_count_t tell(void* user);
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -190,10 +190,10 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct Stream struct Stream
{ {
static sf_count_t GetLength(void* user); static sf_count_t getLength(void* user);
static sf_count_t Read(void* ptr, sf_count_t count, void* user); static sf_count_t read(void* ptr, sf_count_t count, void* user);
static sf_count_t Seek(sf_count_t offset, int whence, void* user); static sf_count_t seek(sf_count_t offset, int whence, void* user);
static sf_count_t Tell(void* user); static sf_count_t tell(void* user);
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

54
src/SFML/Audio/SoundRecorder.cpp
View file

@ -27,7 +27,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/SoundRecorder.hpp> #include <SFML/Audio/SoundRecorder.hpp>
#include <SFML/Audio/AudioDevice.hpp> #include <SFML/Audio/AudioDevice.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
#include <SFML/System/Sleep.hpp> #include <SFML/System/Sleep.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
@ -45,11 +45,11 @@ namespace sf
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundRecorder::SoundRecorder() : SoundRecorder::SoundRecorder() :
m_thread (&SoundRecorder::Record, this), m_thread (&SoundRecorder::record, this),
m_sampleRate (0), m_sampleRate (0),
m_isCapturing(false) m_isCapturing(false)
{ {
priv::EnsureALInit(); priv::ensureALInit();
} }
@ -61,19 +61,19 @@ SoundRecorder::~SoundRecorder()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundRecorder::Start(unsigned int sampleRate) void SoundRecorder::start(unsigned int sampleRate)
{ {
// Check if the device can do audio capture // Check if the device can do audio capture
if (!IsAvailable()) if (!isAvailable())
{ {
Err() << "Failed to start capture : your system cannot capture audio data (call SoundRecorder::IsAvailable to check it)" << std::endl; err() << "Failed to start capture : your system cannot capture audio data (call SoundRecorder::IsAvailable to check it)" << std::endl;
return; return;
} }
// Check that another capture is not already running // Check that another capture is not already running
if (captureDevice) if (captureDevice)
{ {
Err() << "Trying to start audio capture, but another capture is already running" << std::endl; err() << "Trying to start audio capture, but another capture is already running" << std::endl;
return; return;
} }
@ -81,7 +81,7 @@ void SoundRecorder::Start(unsigned int sampleRate)
captureDevice = alcCaptureOpenDevice(NULL, sampleRate, AL_FORMAT_MONO16, sampleRate); captureDevice = alcCaptureOpenDevice(NULL, sampleRate, AL_FORMAT_MONO16, sampleRate);
if (!captureDevice) if (!captureDevice)
{ {
Err() << "Failed to open the audio capture device" << std::endl; err() << "Failed to open the audio capture device" << std::endl;
return; return;
} }
@ -92,44 +92,44 @@ void SoundRecorder::Start(unsigned int sampleRate)
m_sampleRate = sampleRate; m_sampleRate = sampleRate;
// Notify derived class // Notify derived class
if (OnStart()) if (onStart())
{ {
// Start the capture // Start the capture
alcCaptureStart(captureDevice); alcCaptureStart(captureDevice);
// Start the capture in a new thread, to avoid blocking the main thread // Start the capture in a new thread, to avoid blocking the main thread
m_isCapturing = true; m_isCapturing = true;
m_thread.Launch(); m_thread.launch();
} }
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundRecorder::Stop() void SoundRecorder::stop()
{ {
// Stop the capturing thread // Stop the capturing thread
m_isCapturing = false; m_isCapturing = false;
m_thread.Wait(); m_thread.wait();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundRecorder::GetSampleRate() const unsigned int SoundRecorder::getSampleRate() const
{ {
return m_sampleRate; return m_sampleRate;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundRecorder::IsAvailable() bool SoundRecorder::isAvailable()
{ {
return (priv::AudioDevice::IsExtensionSupported("ALC_EXT_CAPTURE") != AL_FALSE) || return (priv::AudioDevice::isExtensionSupported("ALC_EXT_CAPTURE") != AL_FALSE) ||
(priv::AudioDevice::IsExtensionSupported("ALC_EXT_capture") != AL_FALSE); // "bug" in Mac OS X 10.5 and 10.6 (priv::AudioDevice::isExtensionSupported("ALC_EXT_capture") != AL_FALSE); // "bug" in Mac OS X 10.5 and 10.6
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundRecorder::OnStart() bool SoundRecorder::onStart()
{ {
// Nothing to do // Nothing to do
return true; return true;
@ -137,34 +137,34 @@ bool SoundRecorder::OnStart()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundRecorder::OnStop() void SoundRecorder::onStop()
{ {
// Nothing to do // Nothing to do
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundRecorder::Record() void SoundRecorder::record()
{ {
while (m_isCapturing) while (m_isCapturing)
{ {
// Process available samples // Process available samples
ProcessCapturedSamples(); processCapturedSamples();
// Don't bother the CPU while waiting for more captured data // Don't bother the CPU while waiting for more captured data
Sleep(Milliseconds(100)); sleep(milliseconds(100));
} }
// Capture is finished : clean up everything // Capture is finished : clean up everything
CleanUp(); cleanup();
// Notify derived class // Notify derived class
OnStop(); onStop();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundRecorder::ProcessCapturedSamples() void SoundRecorder::processCapturedSamples()
{ {
// Get the number of samples available // Get the number of samples available
ALCint samplesAvailable; ALCint samplesAvailable;
@ -177,7 +177,7 @@ void SoundRecorder::ProcessCapturedSamples()
alcCaptureSamples(captureDevice, &m_samples[0], samplesAvailable); alcCaptureSamples(captureDevice, &m_samples[0], samplesAvailable);
// Forward them to the derived class // Forward them to the derived class
if (!OnProcessSamples(&m_samples[0], m_samples.size())) if (!onProcessSamples(&m_samples[0], m_samples.size()))
{ {
// The user wants to stop the capture // The user wants to stop the capture
m_isCapturing = false; m_isCapturing = false;
@ -187,13 +187,13 @@ void SoundRecorder::ProcessCapturedSamples()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundRecorder::CleanUp() void SoundRecorder::cleanup()
{ {
// Stop the capture // Stop the capture
alcCaptureStop(captureDevice); alcCaptureStop(captureDevice);
// Get the samples left in the buffer // Get the samples left in the buffer
ProcessCapturedSamples(); processCapturedSamples();
// Close the device // Close the device
alcCaptureCloseDevice(captureDevice); alcCaptureCloseDevice(captureDevice);

86
src/SFML/Audio/SoundSource.cpp
View file

@ -26,7 +26,7 @@
// Headers // Headers
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/SoundSource.hpp> #include <SFML/Audio/SoundSource.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
namespace sf namespace sf
@ -34,151 +34,151 @@ namespace sf
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundSource::SoundSource() SoundSource::SoundSource()
{ {
priv::EnsureALInit(); priv::ensureALInit();
ALCheck(alGenSources(1, &m_source)); alCheck(alGenSources(1, &m_source));
ALCheck(alSourcei(m_source, AL_BUFFER, 0)); alCheck(alSourcei(m_source, AL_BUFFER, 0));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundSource::SoundSource(const SoundSource& copy) SoundSource::SoundSource(const SoundSource& copy)
{ {
priv::EnsureALInit(); priv::ensureALInit();
ALCheck(alGenSources(1, &m_source)); alCheck(alGenSources(1, &m_source));
ALCheck(alSourcei(m_source, AL_BUFFER, 0)); alCheck(alSourcei(m_source, AL_BUFFER, 0));
SetPitch(copy.GetPitch()); setPitch(copy.getPitch());
SetVolume(copy.GetVolume()); setVolume(copy.getVolume());
SetPosition(copy.GetPosition()); setPosition(copy.getPosition());
SetRelativeToListener(copy.IsRelativeToListener()); setRelativeToListener(copy.isRelativeToListener());
SetMinDistance(copy.GetMinDistance()); setMinDistance(copy.getMinDistance());
SetAttenuation(copy.GetAttenuation()); setAttenuation(copy.getAttenuation());
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundSource::~SoundSource() SoundSource::~SoundSource()
{ {
ALCheck(alSourcei(m_source, AL_BUFFER, 0)); alCheck(alSourcei(m_source, AL_BUFFER, 0));
ALCheck(alDeleteSources(1, &m_source)); alCheck(alDeleteSources(1, &m_source));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetPitch(float pitch) void SoundSource::setPitch(float pitch)
{ {
ALCheck(alSourcef(m_source, AL_PITCH, pitch)); alCheck(alSourcef(m_source, AL_PITCH, pitch));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetVolume(float volume) void SoundSource::setVolume(float volume)
{ {
ALCheck(alSourcef(m_source, AL_GAIN, volume * 0.01f)); alCheck(alSourcef(m_source, AL_GAIN, volume * 0.01f));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetPosition(float x, float y, float z) void SoundSource::setPosition(float x, float y, float z)
{ {
ALCheck(alSource3f(m_source, AL_POSITION, x, y, z)); alCheck(alSource3f(m_source, AL_POSITION, x, y, z));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetPosition(const Vector3f& position) void SoundSource::setPosition(const Vector3f& position)
{ {
SetPosition(position.x, position.y, position.z); setPosition(position.x, position.y, position.z);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetRelativeToListener(bool relative) void SoundSource::setRelativeToListener(bool relative)
{ {
ALCheck(alSourcei(m_source, AL_SOURCE_RELATIVE, relative)); alCheck(alSourcei(m_source, AL_SOURCE_RELATIVE, relative));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetMinDistance(float distance) void SoundSource::setMinDistance(float distance)
{ {
ALCheck(alSourcef(m_source, AL_REFERENCE_DISTANCE, distance)); alCheck(alSourcef(m_source, AL_REFERENCE_DISTANCE, distance));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundSource::SetAttenuation(float attenuation) void SoundSource::setAttenuation(float attenuation)
{ {
ALCheck(alSourcef(m_source, AL_ROLLOFF_FACTOR, attenuation)); alCheck(alSourcef(m_source, AL_ROLLOFF_FACTOR, attenuation));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float SoundSource::GetPitch() const float SoundSource::getPitch() const
{ {
ALfloat pitch; ALfloat pitch;
ALCheck(alGetSourcef(m_source, AL_PITCH, &pitch)); alCheck(alGetSourcef(m_source, AL_PITCH, &pitch));
return pitch; return pitch;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float SoundSource::GetVolume() const float SoundSource::getVolume() const
{ {
ALfloat gain; ALfloat gain;
ALCheck(alGetSourcef(m_source, AL_GAIN, &gain)); alCheck(alGetSourcef(m_source, AL_GAIN, &gain));
return gain * 100.f; return gain * 100.f;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector3f SoundSource::GetPosition() const Vector3f SoundSource::getPosition() const
{ {
Vector3f position; Vector3f position;
ALCheck(alGetSource3f(m_source, AL_POSITION, &position.x, &position.y, &position.z)); alCheck(alGetSource3f(m_source, AL_POSITION, &position.x, &position.y, &position.z));
return position; return position;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundSource::IsRelativeToListener() const bool SoundSource::isRelativeToListener() const
{ {
ALint relative; ALint relative;
ALCheck(alGetSourcei(m_source, AL_SOURCE_RELATIVE, &relative)); alCheck(alGetSourcei(m_source, AL_SOURCE_RELATIVE, &relative));
return relative != 0; return relative != 0;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float SoundSource::GetMinDistance() const float SoundSource::getMinDistance() const
{ {
ALfloat distance; ALfloat distance;
ALCheck(alGetSourcef(m_source, AL_REFERENCE_DISTANCE, &distance)); alCheck(alGetSourcef(m_source, AL_REFERENCE_DISTANCE, &distance));
return distance; return distance;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float SoundSource::GetAttenuation() const float SoundSource::getAttenuation() const
{ {
ALfloat attenuation; ALfloat attenuation;
ALCheck(alGetSourcef(m_source, AL_ROLLOFF_FACTOR, &attenuation)); alCheck(alGetSourcef(m_source, AL_ROLLOFF_FACTOR, &attenuation));
return attenuation; return attenuation;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundSource::Status SoundSource::GetStatus() const SoundSource::Status SoundSource::getStatus() const
{ {
ALint status; ALint status;
ALCheck(alGetSourcei(m_source, AL_SOURCE_STATE, &status)); alCheck(alGetSourcei(m_source, AL_SOURCE_STATE, &status));
switch (status) switch (status)
{ {

124
src/SFML/Audio/SoundStream.cpp
View file

@ -27,7 +27,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Audio/SoundStream.hpp> #include <SFML/Audio/SoundStream.hpp>
#include <SFML/Audio/AudioDevice.hpp> #include <SFML/Audio/AudioDevice.hpp>
#include <SFML/Audio/ALCheck.hpp> #include <SFML/Audio/alCheck.hpp>
#include <SFML/System/Sleep.hpp> #include <SFML/System/Sleep.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
@ -40,7 +40,7 @@ namespace sf
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundStream::SoundStream() : SoundStream::SoundStream() :
m_thread (&SoundStream::Stream, this), m_thread (&SoundStream::stream, this),
m_isStreaming (false), m_isStreaming (false),
m_channelCount (0), m_channelCount (0),
m_sampleRate (0), m_sampleRate (0),
@ -56,92 +56,92 @@ m_samplesProcessed(0)
SoundStream::~SoundStream() SoundStream::~SoundStream()
{ {
// Stop the sound if it was playing // Stop the sound if it was playing
Stop(); stop();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::Initialize(unsigned int channelCount, unsigned int sampleRate) void SoundStream::initialize(unsigned int channelCount, unsigned int sampleRate)
{ {
m_channelCount = channelCount; m_channelCount = channelCount;
m_sampleRate = sampleRate; m_sampleRate = sampleRate;
// Deduce the format from the number of channels // Deduce the format from the number of channels
m_format = priv::AudioDevice::GetFormatFromChannelCount(channelCount); m_format = priv::AudioDevice::getFormatFromChannelCount(channelCount);
// Check if the format is valid // Check if the format is valid
if (m_format == 0) if (m_format == 0)
{ {
m_channelCount = 0; m_channelCount = 0;
m_sampleRate = 0; m_sampleRate = 0;
Err() << "Unsupported number of channels (" << m_channelCount << ")" << std::endl; err() << "Unsupported number of channels (" << m_channelCount << ")" << std::endl;
} }
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::Play() void SoundStream::play()
{ {
// Check if the sound parameters have been set // Check if the sound parameters have been set
if (m_format == 0) if (m_format == 0)
{ {
Err() << "Failed to play audio stream: sound parameters have not been initialized (call Initialize first)" << std::endl; err() << "Failed to play audio stream: sound parameters have not been initialized (call Initialize first)" << std::endl;
return; return;
} }
// If the sound is already playing (probably paused), just resume it // If the sound is already playing (probably paused), just resume it
if (m_isStreaming) if (m_isStreaming)
{ {
ALCheck(alSourcePlay(m_source)); alCheck(alSourcePlay(m_source));
return; return;
} }
// Move to the beginning // Move to the beginning
OnSeek(Time::Zero); onSeek(Time::Zero);
// Start updating the stream in a separate thread to avoid blocking the application // Start updating the stream in a separate thread to avoid blocking the application
m_samplesProcessed = 0; m_samplesProcessed = 0;
m_isStreaming = true; m_isStreaming = true;
m_thread.Launch(); m_thread.launch();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::Pause() void SoundStream::pause()
{ {
ALCheck(alSourcePause(m_source)); alCheck(alSourcePause(m_source));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::Stop() void SoundStream::stop()
{ {
// Wait for the thread to terminate // Wait for the thread to terminate
m_isStreaming = false; m_isStreaming = false;
m_thread.Wait(); m_thread.wait();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundStream::GetChannelCount() const unsigned int SoundStream::getChannelCount() const
{ {
return m_channelCount; return m_channelCount;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int SoundStream::GetSampleRate() const unsigned int SoundStream::getSampleRate() const
{ {
return m_sampleRate; return m_sampleRate;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
SoundStream::Status SoundStream::GetStatus() const SoundStream::Status SoundStream::getStatus() const
{ {
Status status = SoundSource::GetStatus(); Status status = SoundSource::getStatus();
// To compensate for the lag between Play() and alSourcePlay() // To compensate for the lag between play() and alSourceplay()
if ((status == Stopped) && m_isStreaming) if ((status == Stopped) && m_isStreaming)
status = Playing; status = Playing;
@ -150,68 +150,68 @@ SoundStream::Status SoundStream::GetStatus() const
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::SetPlayingOffset(Time timeOffset) void SoundStream::setPlayingOffset(Time timeOffset)
{ {
// Stop the stream // Stop the stream
Stop(); stop();
// Let the derived class update the current position // Let the derived class update the current position
OnSeek(timeOffset); onSeek(timeOffset);
// Restart streaming // Restart streaming
m_samplesProcessed = static_cast<Uint64>(timeOffset.AsSeconds() * m_sampleRate * m_channelCount); m_samplesProcessed = static_cast<Uint64>(timeOffset.asSeconds() * m_sampleRate * m_channelCount);
m_isStreaming = true; m_isStreaming = true;
m_thread.Launch(); m_thread.launch();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Time SoundStream::GetPlayingOffset() const Time SoundStream::getPlayingOffset() const
{ {
ALfloat seconds = 0.f; ALfloat secs = 0.f;
ALCheck(alGetSourcef(m_source, AL_SEC_OFFSET, &seconds)); alCheck(alGetSourcef(m_source, AL_SEC_OFFSET, &secs));
return Seconds(seconds + static_cast<float>(m_samplesProcessed) / m_sampleRate / m_channelCount); return seconds(secs + static_cast<float>(m_samplesProcessed) / m_sampleRate / m_channelCount);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::SetLoop(bool loop) void SoundStream::setLoop(bool loop)
{ {
m_loop = loop; m_loop = loop;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundStream::GetLoop() const bool SoundStream::getLoop() const
{ {
return m_loop; return m_loop;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::Stream() void SoundStream::stream()
{ {
// Create the buffers // Create the buffers
ALCheck(alGenBuffers(BufferCount, m_buffers)); alCheck(alGenBuffers(BufferCount, m_buffers));
for (int i = 0; i < BufferCount; ++i) for (int i = 0; i < BufferCount; ++i)
m_endBuffers[i] = false; m_endBuffers[i] = false;
// Fill the queue // Fill the queue
bool requestStop = FillQueue(); bool requestStop = fillQueue();
// Play the sound // Play the sound
ALCheck(alSourcePlay(m_source)); alCheck(alSourcePlay(m_source));
while (m_isStreaming) while (m_isStreaming)
{ {
// The stream has been interrupted! // The stream has been interrupted!
if (SoundSource::GetStatus() == Stopped) if (SoundSource::getStatus() == Stopped)
{ {
if (!requestStop) if (!requestStop)
{ {
// Just continue // Just continue
ALCheck(alSourcePlay(m_source)); alCheck(alSourcePlay(m_source));
} }
else else
{ {
@ -222,13 +222,13 @@ void SoundStream::Stream()
// Get the number of buffers that have been processed (ie. ready for reuse) // Get the number of buffers that have been processed (ie. ready for reuse)
ALint nbProcessed = 0; ALint nbProcessed = 0;
ALCheck(alGetSourcei(m_source, AL_BUFFERS_PROCESSED, &nbProcessed)); alCheck(alGetSourcei(m_source, AL_BUFFERS_PROCESSED, &nbProcessed));
while (nbProcessed--) while (nbProcessed--)
{ {
// Pop the first unused buffer from the queue // Pop the first unused buffer from the queue
ALuint buffer; ALuint buffer;
ALCheck(alSourceUnqueueBuffers(m_source, 1, &buffer)); alCheck(alSourceUnqueueBuffers(m_source, 1, &buffer));
// Find its number // Find its number
unsigned int bufferNum = 0; unsigned int bufferNum = 0;
@ -249,44 +249,44 @@ void SoundStream::Stream()
else else
{ {
ALint size, bits; ALint size, bits;
ALCheck(alGetBufferi(buffer, AL_SIZE, &size)); alCheck(alGetBufferi(buffer, AL_SIZE, &size));
ALCheck(alGetBufferi(buffer, AL_BITS, &bits)); alCheck(alGetBufferi(buffer, AL_BITS, &bits));
m_samplesProcessed += size / (bits / 8); m_samplesProcessed += size / (bits / 8);
} }
// Fill it and push it back into the playing queue // Fill it and push it back into the playing queue
if (!requestStop) if (!requestStop)
{ {
if (FillAndPushBuffer(bufferNum)) if (fillAndPushBuffer(bufferNum))
requestStop = true; requestStop = true;
} }
} }
// Leave some time for the other threads if the stream is still playing // Leave some time for the other threads if the stream is still playing
if (SoundSource::GetStatus() != Stopped) if (SoundSource::getStatus() != Stopped)
Sleep(Milliseconds(10)); sleep(milliseconds(10));
} }
// Stop the playback // Stop the playback
ALCheck(alSourceStop(m_source)); alCheck(alSourceStop(m_source));
// Unqueue any buffer left in the queue // Unqueue any buffer left in the queue
ClearQueue(); clearQueue();
// Delete the buffers // Delete the buffers
ALCheck(alSourcei(m_source, AL_BUFFER, 0)); alCheck(alSourcei(m_source, AL_BUFFER, 0));
ALCheck(alDeleteBuffers(BufferCount, m_buffers)); alCheck(alDeleteBuffers(BufferCount, m_buffers));
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundStream::FillAndPushBuffer(unsigned int bufferNum) bool SoundStream::fillAndPushBuffer(unsigned int bufferNum)
{ {
bool requestStop = false; bool requestStop = false;
// Acquire audio data // Acquire audio data
Chunk data = {NULL, 0}; Chunk data = {NULL, 0};
if (!OnGetData(data)) if (!onGetData(data))
{ {
// Mark the buffer as the last one (so that we know when to reset the playing position) // Mark the buffer as the last one (so that we know when to reset the playing position)
m_endBuffers[bufferNum] = true; m_endBuffers[bufferNum] = true;
@ -295,12 +295,12 @@ bool SoundStream::FillAndPushBuffer(unsigned int bufferNum)
if (m_loop) if (m_loop)
{ {
// Return to the beginning of the stream source // Return to the beginning of the stream source
OnSeek(Time::Zero); onSeek(Time::Zero);
// If we previously had no data, try to fill the buffer once again // If we previously had no data, try to fill the buffer once again
if (!data.Samples || (data.SampleCount == 0)) if (!data.samples || (data.sampleCount == 0))
{ {
return FillAndPushBuffer(bufferNum); return fillAndPushBuffer(bufferNum);
} }
} }
else else
@ -311,16 +311,16 @@ bool SoundStream::FillAndPushBuffer(unsigned int bufferNum)
} }
// Fill the buffer if some data was returned // Fill the buffer if some data was returned
if (data.Samples && data.SampleCount) if (data.samples && data.sampleCount)
{ {
unsigned int buffer = m_buffers[bufferNum]; unsigned int buffer = m_buffers[bufferNum];
// Fill the buffer // Fill the buffer
ALsizei size = static_cast<ALsizei>(data.SampleCount) * sizeof(Int16); ALsizei size = static_cast<ALsizei>(data.sampleCount) * sizeof(Int16);
ALCheck(alBufferData(buffer, m_format, data.Samples, size, m_sampleRate)); alCheck(alBufferData(buffer, m_format, data.samples, size, m_sampleRate));
// Push it into the sound queue // Push it into the sound queue
ALCheck(alSourceQueueBuffers(m_source, 1, &buffer)); alCheck(alSourceQueueBuffers(m_source, 1, &buffer));
} }
return requestStop; return requestStop;
@ -328,13 +328,13 @@ bool SoundStream::FillAndPushBuffer(unsigned int bufferNum)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool SoundStream::FillQueue() bool SoundStream::fillQueue()
{ {
// Fill and enqueue all the available buffers // Fill and enqueue all the available buffers
bool requestStop = false; bool requestStop = false;
for (int i = 0; (i < BufferCount) && !requestStop; ++i) for (int i = 0; (i < BufferCount) && !requestStop; ++i)
{ {
if (FillAndPushBuffer(i)) if (fillAndPushBuffer(i))
requestStop = true; requestStop = true;
} }
@ -343,16 +343,16 @@ bool SoundStream::FillQueue()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void SoundStream::ClearQueue() void SoundStream::clearQueue()
{ {
// Get the number of buffers still in the queue // Get the number of buffers still in the queue
ALint nbQueued; ALint nbQueued;
ALCheck(alGetSourcei(m_source, AL_BUFFERS_QUEUED, &nbQueued)); alCheck(alGetSourcei(m_source, AL_BUFFERS_QUEUED, &nbQueued));
// Unqueue them all // Unqueue them all
ALuint buffer; ALuint buffer;
for (ALint i = 0; i < nbQueued; ++i) for (ALint i = 0; i < nbQueued; ++i)
ALCheck(alSourceUnqueueBuffers(m_source, 1, &buffer)); alCheck(alSourceUnqueueBuffers(m_source, 1, &buffer));
} }
} // namespace sf } // namespace sf

16
src/SFML/Graphics/CircleShape.cpp
View file

@ -36,41 +36,41 @@ CircleShape::CircleShape(float radius, unsigned int pointCount) :
m_radius (radius), m_radius (radius),
m_pointCount(pointCount) m_pointCount(pointCount)
{ {
Update(); update();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void CircleShape::SetRadius(float radius) void CircleShape::setRadius(float radius)
{ {
m_radius = radius; m_radius = radius;
Update(); update();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
float CircleShape::GetRadius() const float CircleShape::getRadius() const
{ {
return m_radius; return m_radius;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void CircleShape::SetPointCount(unsigned int count) void CircleShape::setPointCount(unsigned int count)
{ {
m_pointCount = count; m_pointCount = count;
Update(); update();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int CircleShape::GetPointCount() const unsigned int CircleShape::getPointCount() const
{ {
return m_pointCount; return m_pointCount;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f CircleShape::GetPoint(unsigned int index) const Vector2f CircleShape::getPoint(unsigned int index) const
{ {
static const float pi = 3.141592654f; static const float pi = 3.141592654f;

14
src/SFML/Graphics/ConvexShape.cpp
View file

@ -33,35 +33,35 @@ namespace sf
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
ConvexShape::ConvexShape(unsigned int pointCount) ConvexShape::ConvexShape(unsigned int pointCount)
{ {
SetPointCount(pointCount); setPointCount(pointCount);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ConvexShape::SetPointCount(unsigned int count) void ConvexShape::setPointCount(unsigned int count)
{ {
m_points.resize(count); m_points.resize(count);
Update(); update();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int ConvexShape::GetPointCount() const unsigned int ConvexShape::getPointCount() const
{ {
return static_cast<unsigned int>(m_points.size()); return static_cast<unsigned int>(m_points.size());
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void ConvexShape::SetPoint(unsigned int index, const Vector2f& point) void ConvexShape::setPoint(unsigned int index, const Vector2f& point)
{ {
m_points[index] = point; m_points[index] = point;
Update(); update();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Vector2f ConvexShape::GetPoint(unsigned int index) const Vector2f ConvexShape::getPoint(unsigned int index) const
{ {
return m_points[index]; return m_points[index];
} }

144
src/SFML/Graphics/Font.cpp
View file

@ -40,20 +40,20 @@
namespace namespace
{ {
// FreeType callbacks that operate on a sf::InputStream // FreeType callbacks that operate on a sf::InputStream
unsigned long Read(FT_Stream rec, unsigned long offset, unsigned char* buffer, unsigned long count) unsigned long read(FT_Stream rec, unsigned long offset, unsigned char* buffer, unsigned long count)
{ {
sf::InputStream* stream = static_cast<sf::InputStream*>(rec->descriptor.pointer); sf::InputStream* stream = static_cast<sf::InputStream*>(rec->descriptor.pointer);
if (static_cast<unsigned long>(stream->Seek(offset)) == offset) if (static_cast<unsigned long>(stream->seek(offset)) == offset)
{ {
if (count > 0) if (count > 0)
return static_cast<unsigned long>(stream->Read(reinterpret_cast<char*>(buffer), count)); return static_cast<unsigned long>(stream->read(reinterpret_cast<char*>(buffer), count));
else else
return 0; return 0;
} }
else else
return count > 0 ? 0 : 1; // error code is 0 if we're reading, or nonzero if we're seeking return count > 0 ? 0 : 1; // error code is 0 if we're reading, or nonzero if we're seeking
} }
void Close(FT_Stream) void close(FT_Stream)
{ {
} }
} }
@ -92,15 +92,15 @@ m_pixelBuffer(copy.m_pixelBuffer)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Font::~Font() Font::~Font()
{ {
Cleanup(); cleanup();
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Font::LoadFromFile(const std::string& filename) bool Font::loadFromFile(const std::string& filename)
{ {
// Cleanup the previous resources // Cleanup the previous resources
Cleanup(); cleanup();
m_refCount = new int(1); m_refCount = new int(1);
// Initialize FreeType // Initialize FreeType
@ -109,7 +109,7 @@ bool Font::LoadFromFile(const std::string& filename)
FT_Library library; FT_Library library;
if (FT_Init_FreeType(&library) != 0) if (FT_Init_FreeType(&library) != 0)
{ {
Err() << "Failed to load font \"" << filename << "\" (failed to initialize FreeType)" << std::endl; err() << "Failed to load font \"" << filename << "\" (failed to initialize FreeType)" << std::endl;
return false; return false;
} }
m_library = library; m_library = library;
@ -118,14 +118,14 @@ bool Font::LoadFromFile(const std::string& filename)
FT_Face face; FT_Face face;
if (FT_New_Face(static_cast<FT_Library>(m_library), filename.c_str(), 0, &face) != 0) if (FT_New_Face(static_cast<FT_Library>(m_library), filename.c_str(), 0, &face) != 0)
{ {
Err() << "Failed to load font \"" << filename << "\" (failed to create the font face)" << std::endl; err() << "Failed to load font \"" << filename << "\" (failed to create the font face)" << std::endl;
return false; return false;
} }
// Select the unicode character map // Select the unicode character map
if (FT_Select_Charmap(face, FT_ENCODING_UNICODE) != 0) if (FT_Select_Charmap(face, FT_ENCODING_UNICODE) != 0)
{ {
Err() << "Failed to load font \"" << filename << "\" (failed to set the Unicode character set)" << std::endl; err() << "Failed to load font \"" << filename << "\" (failed to set the Unicode character set)" << std::endl;
return false; return false;
} }
@ -137,10 +137,10 @@ bool Font::LoadFromFile(const std::string& filename)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Font::LoadFromMemory(const void* data, std::size_t sizeInBytes) bool Font::loadFromMemory(const void* data, std::size_t sizeInBytes)
{ {
// Cleanup the previous resources // Cleanup the previous resources
Cleanup(); cleanup();
m_refCount = new int(1); m_refCount = new int(1);
// Initialize FreeType // Initialize FreeType
@ -149,7 +149,7 @@ bool Font::LoadFromMemory(const void* data, std::size_t sizeInBytes)
FT_Library library; FT_Library library;
if (FT_Init_FreeType(&library) != 0) if (FT_Init_FreeType(&library) != 0)
{ {
Err() << "Failed to load font from memory (failed to initialize FreeType)" << std::endl; err() << "Failed to load font from memory (failed to initialize FreeType)" << std::endl;
return false; return false;
} }
m_library = library; m_library = library;
@ -158,14 +158,14 @@ bool Font::LoadFromMemory(const void* data, std::size_t sizeInBytes)
FT_Face face; FT_Face face;
if (FT_New_Memory_Face(static_cast<FT_Library>(m_library), reinterpret_cast<const FT_Byte*>(data), static_cast<FT_Long>(sizeInBytes), 0, &face) != 0) if (FT_New_Memory_Face(static_cast<FT_Library>(m_library), reinterpret_cast<const FT_Byte*>(data), static_cast<FT_Long>(sizeInBytes), 0, &face) != 0)
{ {
Err() << "Failed to load font from memory (failed to create the font face)" << std::endl; err() << "Failed to load font from memory (failed to create the font face)" << std::endl;
return false; return false;
} }
// Select the unicode character map // Select the unicode character map
if (FT_Select_Charmap(face, FT_ENCODING_UNICODE) != 0) if (FT_Select_Charmap(face, FT_ENCODING_UNICODE) != 0)
{ {
Err() << "Failed to load font from memory (failed to set the Unicode character set)" << std::endl; err() << "Failed to load font from memory (failed to set the Unicode character set)" << std::endl;
return false; return false;
} }
@ -177,10 +177,10 @@ bool Font::LoadFromMemory(const void* data, std::size_t sizeInBytes)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Font::LoadFromStream(InputStream& stream) bool Font::loadFromStream(InputStream& stream)
{ {
// Cleanup the previous resources // Cleanup the previous resources
Cleanup(); cleanup();
m_refCount = new int(1); m_refCount = new int(1);
// Initialize FreeType // Initialize FreeType
@ -189,7 +189,7 @@ bool Font::LoadFromStream(InputStream& stream)
FT_Library library; FT_Library library;
if (FT_Init_FreeType(&library) != 0) if (FT_Init_FreeType(&library) != 0)
{ {
Err() << "Failed to load font from stream (failed to initialize FreeType)" << std::endl; err() << "Failed to load font from stream (failed to initialize FreeType)" << std::endl;
return false; return false;
} }
m_library = library; m_library = library;
@ -198,11 +198,11 @@ bool Font::LoadFromStream(InputStream& stream)
FT_StreamRec* rec = new FT_StreamRec; FT_StreamRec* rec = new FT_StreamRec;
std::memset(rec, 0, sizeof(*rec)); std::memset(rec, 0, sizeof(*rec));
rec->base = NULL; rec->base = NULL;
rec->size = static_cast<unsigned long>(stream.GetSize()); rec->size = static_cast<unsigned long>(stream.getSize());
rec->pos = 0; rec->pos = 0;
rec->descriptor.pointer = &stream; rec->descriptor.pointer = &stream;
rec->read = &Read; rec->read = &read;
rec->close = &Close; rec->close = &close;
// Setup the FreeType callbacks that will read our stream // Setup the FreeType callbacks that will read our stream
FT_Open_Args args; FT_Open_Args args;
@ -214,14 +214,14 @@ bool Font::LoadFromStream(InputStream& stream)
FT_Face face; FT_Face face;
if (FT_Open_Face(static_cast<FT_Library>(m_library), &args, 0, &face) != 0) if (FT_Open_Face(static_cast<FT_Library>(m_library), &args, 0, &face) != 0)
{ {
Err() << "Failed to load font from stream (failed to create the font face)" << std::endl; err() << "Failed to load font from stream (failed to create the font face)" << std::endl;
return false; return false;
} }
// Select the unicode character map // Select the unicode character map
if (FT_Select_Charmap(face, FT_ENCODING_UNICODE) != 0) if (FT_Select_Charmap(face, FT_ENCODING_UNICODE) != 0)
{ {
Err() << "Failed to load font from stream (failed to set the Unicode character set)" << std::endl; err() << "Failed to load font from stream (failed to set the Unicode character set)" << std::endl;
return false; return false;
} }
@ -234,10 +234,10 @@ bool Font::LoadFromStream(InputStream& stream)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Glyph& Font::GetGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const const Glyph& Font::getGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const
{ {
// Get the page corresponding to the character size // Get the page corresponding to the character size
GlyphTable& glyphs = m_pages[characterSize].Glyphs; GlyphTable& glyphs = m_pages[characterSize].glyphs;
// Build the key by combining the code point and the bold flag // Build the key by combining the code point and the bold flag
Uint32 key = ((bold ? 1 : 0) << 31) | codePoint; Uint32 key = ((bold ? 1 : 0) << 31) | codePoint;
@ -252,14 +252,14 @@ const Glyph& Font::GetGlyph(Uint32 codePoint, unsigned int characterSize, bool b
else else
{ {
// Not found: we have to load it // Not found: we have to load it
Glyph glyph = LoadGlyph(codePoint, characterSize, bold); Glyph glyph = loadGlyph(codePoint, characterSize, bold);
return glyphs.insert(std::make_pair(key, glyph)).first->second; return glyphs.insert(std::make_pair(key, glyph)).first->second;
} }
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int Font::GetKerning(Uint32 first, Uint32 second, unsigned int characterSize) const int Font::getKerning(Uint32 first, Uint32 second, unsigned int characterSize) const
{ {
// Special case where first or second is 0 (null character) // Special case where first or second is 0 (null character)
if (first == 0 || second == 0) if (first == 0 || second == 0)
@ -267,7 +267,7 @@ int Font::GetKerning(Uint32 first, Uint32 second, unsigned int characterSize) co
FT_Face face = static_cast<FT_Face>(m_face); FT_Face face = static_cast<FT_Face>(m_face);
if (face && FT_HAS_KERNING(face) && SetCurrentSize(characterSize)) if (face && FT_HAS_KERNING(face) && setCurrentSize(characterSize))
{ {
// Convert the characters to indices // Convert the characters to indices
FT_UInt index1 = FT_Get_Char_Index(face, first); FT_UInt index1 = FT_Get_Char_Index(face, first);
@ -289,11 +289,11 @@ int Font::GetKerning(Uint32 first, Uint32 second, unsigned int characterSize) co
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
int Font::GetLineSpacing(unsigned int characterSize) const int Font::getLineSpacing(unsigned int characterSize) const
{ {
FT_Face face = static_cast<FT_Face>(m_face); FT_Face face = static_cast<FT_Face>(m_face);
if (face && SetCurrentSize(characterSize)) if (face && setCurrentSize(characterSize))
{ {
return (face->size->metrics.height >> 6); return (face->size->metrics.height >> 6);
} }
@ -305,9 +305,9 @@ int Font::GetLineSpacing(unsigned int characterSize) const
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Texture& Font::GetTexture(unsigned int characterSize) const const Texture& Font::getTexture(unsigned int characterSize) const
{ {
return m_pages[characterSize].Texture; return m_pages[characterSize].texture;
} }
@ -327,7 +327,7 @@ Font& Font::operator =(const Font& right)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Font& Font::GetDefaultFont() const Font& Font::getDefaultFont()
{ {
static Font font; static Font font;
static bool loaded = false; static bool loaded = false;
@ -340,7 +340,7 @@ const Font& Font::GetDefaultFont()
#include <SFML/Graphics/Arial.hpp> #include <SFML/Graphics/Arial.hpp>
}; };
font.LoadFromMemory(data, sizeof(data)); font.loadFromMemory(data, sizeof(data));
loaded = true; loaded = true;
} }
@ -349,7 +349,7 @@ const Font& Font::GetDefaultFont()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Font::Cleanup() void Font::cleanup()
{ {
// Check if we must destroy the FreeType pointers // Check if we must destroy the FreeType pointers
if (m_refCount) if (m_refCount)
@ -388,7 +388,7 @@ void Font::Cleanup()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Glyph Font::LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const Glyph Font::loadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) const
{ {
// The glyph to return // The glyph to return
Glyph glyph; Glyph glyph;
@ -399,7 +399,7 @@ Glyph Font::LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) c
return glyph; return glyph;
// Set the character size // Set the character size
if (!SetCurrentSize(characterSize)) if (!setCurrentSize(characterSize))
return glyph; return glyph;
// Load the glyph corresponding to the code point // Load the glyph corresponding to the code point
@ -432,9 +432,9 @@ Glyph Font::LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) c
} }
// Compute the glyph's advance offset // Compute the glyph's advance offset
glyph.Advance = glyphDesc->advance.x >> 16; glyph.advance = glyphDesc->advance.x >> 16;
if (bold) if (bold)
glyph.Advance += weight >> 6; glyph.advance += weight >> 6;
int width = bitmap.width; int width = bitmap.width;
int height = bitmap.rows; int height = bitmap.rows;
@ -448,13 +448,13 @@ Glyph Font::LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) c
Page& page = m_pages[characterSize]; Page& page = m_pages[characterSize];
// Find a good position for the new glyph into the texture // Find a good position for the new glyph into the texture
glyph.TextureRect = FindGlyphRect(page, width + 2 * padding, height + 2 * padding); glyph.textureRect = findGlyphRect(page, width + 2 * padding, height + 2 * padding);
// Compute the glyph's bounding box // Compute the glyph's bounding box
glyph.Bounds.Left = bitmapGlyph->left - padding; glyph.bounds.left = bitmapGlyph->left - padding;
glyph.Bounds.Top = -bitmapGlyph->top - padding; glyph.bounds.top = -bitmapGlyph->top - padding;
glyph.Bounds.Width = width + 2 * padding; glyph.bounds.width = width + 2 * padding;
glyph.Bounds.Height = height + 2 * padding; glyph.bounds.height = height + 2 * padding;
// Extract the glyph's pixels from the bitmap // Extract the glyph's pixels from the bitmap
m_pixelBuffer.resize(width * height * 4, 255); m_pixelBuffer.resize(width * height * 4, 255);
@ -489,11 +489,11 @@ Glyph Font::LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) c
} }
// Write the pixels to the texture // Write the pixels to the texture
unsigned int x = glyph.TextureRect.Left + padding; unsigned int x = glyph.textureRect.left + padding;
unsigned int y = glyph.TextureRect.Top + padding; unsigned int y = glyph.textureRect.top + padding;
unsigned int width = glyph.TextureRect.Width - 2 * padding; unsigned int width = glyph.textureRect.width - 2 * padding;
unsigned int height = glyph.TextureRect.Height - 2 * padding; unsigned int height = glyph.textureRect.height - 2 * padding;
page.Texture.Update(&m_pixelBuffer[0], width, height, x, y); page.texture.update(&m_pixelBuffer[0], width, height, x, y);
} }
// Delete the FT glyph // Delete the FT glyph
@ -505,21 +505,21 @@ Glyph Font::LoadGlyph(Uint32 codePoint, unsigned int characterSize, bool bold) c
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
IntRect Font::FindGlyphRect(Page& page, unsigned int width, unsigned int height) const IntRect Font::findGlyphRect(Page& page, unsigned int width, unsigned int height) const
{ {
// Find the line that fits well the glyph // Find the line that fits well the glyph
Row* row = NULL; Row* row = NULL;
float bestRatio = 0; float bestRatio = 0;
for (std::vector<Row>::iterator it = page.Rows.begin(); it != page.Rows.end() && !row; ++it) for (std::vector<Row>::iterator it = page.rows.begin(); it != page.rows.end() && !row; ++it)
{ {
float ratio = static_cast<float>(height) / it->Height; float ratio = static_cast<float>(height) / it->height;
// Ignore rows that are either too small or too high // Ignore rows that are either too small or too high
if ((ratio < 0.7f) || (ratio > 1.f)) if ((ratio < 0.7f) || (ratio > 1.f))
continue; continue;
// Check if there's enough horizontal space left in the row // Check if there's enough horizontal space left in the row
if (width > page.Texture.GetWidth() - it->Width) if (width > page.texture.getWidth() - it->width)
continue; continue;
// Make sure that this new row is the best found so far // Make sure that this new row is the best found so far
@ -535,44 +535,44 @@ IntRect Font::FindGlyphRect(Page& page, unsigned int width, unsigned int height)
if (!row) if (!row)
{ {
int rowHeight = height + height / 10; int rowHeight = height + height / 10;
if (page.NextRow + rowHeight >= page.Texture.GetHeight()) if (page.nextRow + rowHeight >= page.texture.getHeight())
{ {
// Not enough space: resize the texture if possible // Not enough space: resize the texture if possible
unsigned int textureWidth = page.Texture.GetWidth(); unsigned int textureWidth = page.texture.getWidth();
unsigned int textureHeight = page.Texture.GetHeight(); unsigned int textureHeight = page.texture.getHeight();
if ((textureWidth * 2 <= Texture::GetMaximumSize()) && (textureHeight * 2 <= Texture::GetMaximumSize())) if ((textureWidth * 2 <= Texture::getMaximumSize()) && (textureHeight * 2 <= Texture::getMaximumSize()))
{ {
// Make the texture 2 times bigger // Make the texture 2 times bigger
sf::Image pixels = page.Texture.CopyToImage(); sf::Image pixels = page.texture.copyToImage();
page.Texture.Create(textureWidth * 2, textureHeight * 2); page.texture.create(textureWidth * 2, textureHeight * 2);
page.Texture.Update(pixels); page.texture.update(pixels);
} }
else else
{ {
// Oops, we've reached the maximum texture size... // Oops, we've reached the maximum texture size...
Err() << "Failed to add a new character to the font: the maximum texture size has been reached" << std::endl; err() << "Failed to add a new character to the font: the maximum texture size has been reached" << std::endl;
return IntRect(0, 0, 2, 2); return IntRect(0, 0, 2, 2);
} }
} }
// We can now create the new row // We can now create the new row
page.Rows.push_back(Row(page.NextRow, rowHeight)); page.rows.push_back(Row(page.nextRow, rowHeight));
page.NextRow += rowHeight; page.nextRow += rowHeight;
row = &page.Rows.back(); row = &page.rows.back();
} }
// Find the glyph's rectangle on the selected row // Find the glyph's rectangle on the selected row
IntRect rect(row->Width, row->Top, width, height); IntRect rect(row->width, row->top, width, height);
// Update the row informations // Update the row informations
row->Width += width; row->width += width;
return rect; return rect;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Font::SetCurrentSize(unsigned int characterSize) const bool Font::setCurrentSize(unsigned int characterSize) const
{ {
// FT_Set_Pixel_Sizes is an expensive function, so we must call it // FT_Set_Pixel_Sizes is an expensive function, so we must call it
// only when necessary to avoid killing performances // only when necessary to avoid killing performances
@ -593,20 +593,20 @@ bool Font::SetCurrentSize(unsigned int characterSize) const
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Font::Page::Page() : Font::Page::Page() :
NextRow(2) nextRow(2)
{ {
// Make sure that the texture is initialized by default // Make sure that the texture is initialized by default
sf::Image image; sf::Image image;
image.Create(128, 128, Color(255, 255, 255, 0)); image.create(128, 128, Color(255, 255, 255, 0));
// Reserve a 2x2 white square for texturing underlines // Reserve a 2x2 white square for texturing underlines
for (int x = 0; x < 2; ++x) for (int x = 0; x < 2; ++x)
for (int y = 0; y < 2; ++y) for (int y = 0; y < 2; ++y)
image.SetPixel(x, y, Color(255, 255, 255, 255)); image.setPixel(x, y, Color(255, 255, 255, 255));
// Create the texture // Create the texture
Texture.LoadFromImage(image); texture.loadFromImage(image);
Texture.SetSmooth(true); texture.setSmooth(true);
} }
} // namespace sf } // namespace sf

10
src/SFML/Graphics/GLCheck.cpp
View file

@ -25,7 +25,7 @@
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
// Headers // Headers
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#include <SFML/Graphics/GLCheck.hpp> #include <SFML/Graphics/glCheck.hpp>
#include <SFML/System/Err.hpp> #include <SFML/System/Err.hpp>
@ -34,7 +34,7 @@ namespace sf
namespace priv namespace priv
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void GLCheckError(const std::string& file, unsigned int line) void glCheckError(const std::string& file, unsigned int line)
{ {
// Get the last error // Get the last error
GLenum errorCode = glGetError(); GLenum errorCode = glGetError();
@ -98,7 +98,7 @@ void GLCheckError(const std::string& file, unsigned int line)
} }
// Log the error // Log the error
Err() << "An internal OpenGL call failed in " err() << "An internal OpenGL call failed in "
<< file.substr(file.find_last_of("\\/") + 1) << " (" << line << ") : " << file.substr(file.find_last_of("\\/") + 1) << " (" << line << ") : "
<< error << ", " << description << error << ", " << description
<< std::endl; << std::endl;
@ -107,7 +107,7 @@ void GLCheckError(const std::string& file, unsigned int line)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void EnsureGlewInit() void ensureGlewInit()
{ {
static bool initialized = false; static bool initialized = false;
if (!initialized) if (!initialized)
@ -119,7 +119,7 @@ void EnsureGlewInit()
} }
else else
{ {
Err() << "Failed to initialize GLEW, " << glewGetErrorString(status) << std::endl; err() << "Failed to initialize GLEW, " << glewGetErrorString(status) << std::endl;
} }
} }
} }

11
src/SFML/Graphics/GLCheck.hpp
View file

@ -38,18 +38,17 @@ namespace sf
namespace priv namespace priv
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// Let's define a macro to quickly check every OpenGL /// Let's define a macro to quickly check every OpenGL API calls
/// API calls
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
#ifdef SFML_DEBUG #ifdef SFML_DEBUG
// In debug mode, perform a test on every OpenGL call // In debug mode, perform a test on every OpenGL call
#define GLCheck(call) ((call), sf::priv::GLCheckError(__FILE__, __LINE__)) #define glCheck(call) ((call), sf::priv::glCheckError(__FILE__, __LINE__))
#else #else
// Else, we don't add any overhead // Else, we don't add any overhead
#define GLCheck(call) (call) #define glCheck(call) (call)
#endif #endif
@ -60,13 +59,13 @@ namespace priv
/// \param line Line number of the source file where the call is located /// \param line Line number of the source file where the call is located
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void GLCheckError(const std::string& file, unsigned int line); void glCheckError(const std::string& file, unsigned int line);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Make sure that GLEW is initialized /// \brief Make sure that GLEW is initialized
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void EnsureGlewInit(); void ensureGlewInit();
} // namespace priv } // namespace priv

64
src/SFML/Graphics/Image.cpp
View file

@ -44,7 +44,7 @@ m_height(0)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::Create(unsigned int width, unsigned int height, const Color& color) void Image::create(unsigned int width, unsigned int height, const Color& color)
{ {
// Assign the new size // Assign the new size
m_width = width; m_width = width;
@ -67,7 +67,7 @@ void Image::Create(unsigned int width, unsigned int height, const Color& color)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::Create(unsigned int width, unsigned int height, const Uint8* pixels) void Image::create(unsigned int width, unsigned int height, const Uint8* pixels)
{ {
if (pixels) if (pixels)
{ {
@ -91,49 +91,49 @@ void Image::Create(unsigned int width, unsigned int height, const Uint8* pixels)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Image::LoadFromFile(const std::string& filename) bool Image::loadFromFile(const std::string& filename)
{ {
return priv::ImageLoader::GetInstance().LoadImageFromFile(filename, m_pixels, m_width, m_height); return priv::ImageLoader::getInstance().loadImageFromFile(filename, m_pixels, m_width, m_height);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Image::LoadFromMemory(const void* data, std::size_t size) bool Image::loadFromMemory(const void* data, std::size_t size)
{ {
return priv::ImageLoader::GetInstance().LoadImageFromMemory(data, size, m_pixels, m_width, m_height); return priv::ImageLoader::getInstance().loadImageFromMemory(data, size, m_pixels, m_width, m_height);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Image::LoadFromStream(InputStream& stream) bool Image::loadFromStream(InputStream& stream)
{ {
return priv::ImageLoader::GetInstance().LoadImageFromStream(stream, m_pixels, m_width, m_height); return priv::ImageLoader::getInstance().loadImageFromStream(stream, m_pixels, m_width, m_height);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool Image::SaveToFile(const std::string& filename) const bool Image::saveToFile(const std::string& filename) const
{ {
return priv::ImageLoader::GetInstance().SaveImageToFile(filename, m_pixels, m_width, m_height); return priv::ImageLoader::getInstance().saveImageToFile(filename, m_pixels, m_width, m_height);
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int Image::GetWidth() const unsigned int Image::getWidth() const
{ {
return m_width; return m_width;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
unsigned int Image::GetHeight() const unsigned int Image::getHeight() const
{ {
return m_height; return m_height;
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::CreateMaskFromColor(const Color& color, Uint8 alpha) void Image::createMaskFromColor(const Color& color, Uint8 alpha)
{ {
// Make sure that the image is not empty // Make sure that the image is not empty
if (!m_pixels.empty()) if (!m_pixels.empty())
@ -152,7 +152,7 @@ void Image::CreateMaskFromColor(const Color& color, Uint8 alpha)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::Copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect, bool applyAlpha) void Image::copy(const Image& source, unsigned int destX, unsigned int destY, const IntRect& sourceRect, bool applyAlpha)
{ {
// Make sure that both images are valid // Make sure that both images are valid
if ((source.m_width == 0) || (source.m_height == 0) || (m_width == 0) || (m_height == 0)) if ((source.m_width == 0) || (source.m_height == 0) || (m_width == 0) || (m_height == 0))
@ -160,24 +160,24 @@ void Image::Copy(const Image& source, unsigned int destX, unsigned int destY, co
// Adjust the source rectangle // Adjust the source rectangle
IntRect srcRect = sourceRect; IntRect srcRect = sourceRect;
if (srcRect.Width == 0 || (srcRect.Height == 0)) if (srcRect.width == 0 || (srcRect.height == 0))
{ {
srcRect.Left = 0; srcRect.left = 0;
srcRect.Top = 0; srcRect.top = 0;
srcRect.Width = source.m_width; srcRect.width = source.m_width;
srcRect.Height = source.m_height; srcRect.height = source.m_height;
} }
else else
{ {
if (srcRect.Left < 0) srcRect.Left = 0; if (srcRect.left < 0) srcRect.left = 0;
if (srcRect.Top < 0) srcRect.Top = 0; if (srcRect.top < 0) srcRect.top = 0;
if (srcRect.Width > static_cast<int>(source.m_width)) srcRect.Width = source.m_width; if (srcRect.width > static_cast<int>(source.m_width)) srcRect.width = source.m_width;
if (srcRect.Height > static_cast<int>(source.m_height)) srcRect.Height = source.m_height; if (srcRect.height > static_cast<int>(source.m_height)) srcRect.height = source.m_height;
} }
// Then find the valid bounds of the destination rectangle // Then find the valid bounds of the destination rectangle
int width = srcRect.Width; int width = srcRect.width;
int height = srcRect.Height; int height = srcRect.height;
if (destX + width > m_width) width = m_width - destX; if (destX + width > m_width) width = m_width - destX;
if (destY + height > m_height) height = m_height - destY; if (destY + height > m_height) height = m_height - destY;
@ -190,7 +190,7 @@ void Image::Copy(const Image& source, unsigned int destX, unsigned int destY, co
int rows = height; int rows = height;
int srcStride = source.m_width * 4; int srcStride = source.m_width * 4;
int dstStride = m_width * 4; int dstStride = m_width * 4;
const Uint8* srcPixels = &source.m_pixels[0] + (srcRect.Left + srcRect.Top * source.m_width) * 4; const Uint8* srcPixels = &source.m_pixels[0] + (srcRect.left + srcRect.top * source.m_width) * 4;
Uint8* dstPixels = &m_pixels[0] + (destX + destY * m_width) * 4; Uint8* dstPixels = &m_pixels[0] + (destX + destY * m_width) * 4;
// Copy the pixels // Copy the pixels
@ -231,7 +231,7 @@ void Image::Copy(const Image& source, unsigned int destX, unsigned int destY, co
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::SetPixel(unsigned int x, unsigned int y, const Color& color) void Image::setPixel(unsigned int x, unsigned int y, const Color& color)
{ {
Uint8* pixel = &m_pixels[(x + y * m_width) * 4]; Uint8* pixel = &m_pixels[(x + y * m_width) * 4];
*pixel++ = color.r; *pixel++ = color.r;
@ -242,7 +242,7 @@ void Image::SetPixel(unsigned int x, unsigned int y, const Color& color)
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
Color Image::GetPixel(unsigned int x, unsigned int y) const Color Image::getPixel(unsigned int x, unsigned int y) const
{ {
const Uint8* pixel = &m_pixels[(x + y * m_width) * 4]; const Uint8* pixel = &m_pixels[(x + y * m_width) * 4];
return Color(pixel[0], pixel[1], pixel[2], pixel[3]); return Color(pixel[0], pixel[1], pixel[2], pixel[3]);
@ -250,7 +250,7 @@ Color Image::GetPixel(unsigned int x, unsigned int y) const
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
const Uint8* Image::GetPixelsPtr() const const Uint8* Image::getPixelsPtr() const
{ {
if (!m_pixels.empty()) if (!m_pixels.empty())
{ {
@ -258,14 +258,14 @@ const Uint8* Image::GetPixelsPtr() const
} }
else else
{ {
Err() << "Trying to access the pixels of an empty image" << std::endl; err() << "Trying to access the pixels of an empty image" << std::endl;
return NULL; return NULL;
} }
} }
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::FlipHorizontally() void Image::flipHorizontally()
{ {
if (!m_pixels.empty()) if (!m_pixels.empty())
{ {
@ -290,7 +290,7 @@ void Image::FlipHorizontally()
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
void Image::FlipVertically() void Image::flipVertically()
{ {
if (!m_pixels.empty()) if (!m_pixels.empty())
{ {

Some files were not shown because too many files have changed in this diff Show more