mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-01-30 21:33:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documented that mutexes are implemented recursively

Browse Source
This commit is contained in:
Marcus Brummer 2021-03-03 18:27:09 +01:00
parent 864caf5711
commit 46bbeb2b60
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/Mutex.xml
View File

@ -15,6 +15,7 @@
</return> </return>
<description> <description>
Locks this [Mutex], blocks until it is unlocked by the current owner. Locks this [Mutex], blocks until it is unlocked by the current owner.
[b]Note:[/b] This function returns without blocking if the thread already has ownership of the mutex.
</description> </description>
</method> </method>
<method name="try_lock"> <method name="try_lock">
@ -22,6 +23,7 @@
</return> </return>
<description> <description>
Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
[b]Note:[/b] This function returns [constant OK] if the thread already has ownership of the mutex.
</description> </description>
</method> </method>
<method name="unlock"> <method name="unlock">
@ -29,6 +31,7 @@
</return> </return>
<description> <description>
Unlocks this [Mutex], leaving it to other threads. Unlocks this [Mutex], leaving it to other threads.
[b]Note:[/b] If a thread called [method lock] or [method try_lock] multiple times while already having ownership of the mutex, it must also call [method unlock] the same number of times in order to unlock it correctly.
</description> </description>
</method> </method>
</methods> </methods>