SFML - Simple and Fast Multimedia Library

SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

Lock.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_LOCK_HPP
26#define SFML_LOCK_HPP
27
29// Headers
31#include <SFML/System/Export.hpp>
32#include <SFML/System/NonCopyable.hpp>
33
34
35namespace sf
36{
37class Mutex;
38
43 class SFML_SYSTEM_API Lock : NonCopyable
44{
45public:
46
55 explicit Lock(Mutex& mutex);
56
63 ~Lock();
64
65private:
66
68 // Member data
70 Mutex& m_mutex;
71};
72
73} // namespace sf
74
75
76#endif // SFML_LOCK_HPP
77
78
sf::Lock
Automatic wrapper for locking and unlocking mutexes.
Definition: Lock.hpp:44
sf::Lock::Lock
Lock(Mutex &mutex)
Construct the lock with a target mutex.
sf::Lock::~Lock
~Lock()
Destructor.
sf::Mutex
Blocks concurrent access to shared resources from multiple threads.
Definition: Mutex.hpp:48
sf::NonCopyable
Utility class that makes any derived class non-copyable.
Definition: NonCopyable.hpp:42