godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11489 from Ivorforce/trivially-relocatable

Browse Source 
Add some information about relocation safety.
This commit is contained in:
Max Hilbrunner
2025-11-24 15:33:47 +01:00
committed by GitHub
parent 0380fe550c d03fcc844f
commit 0e4add404c
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
engine_details/architecture/core_types.rst
View File

@@ -150,6 +150,21 @@ scripting API.
.. |typed_dictionary| replace:: `TypedDictionary <https://github.com/godotengine/godot/blob/master/core/variant/typed_dictionary.h>`__
.. |pair| replace:: `Pair <https://github.com/godotengine/godot/blob/master/core/templates/pair.h>`__
Relocation safety
^^^^^^^^^^^^^^^^^
Godot's containers assume their elements are `trivially relocatable <https://open-std.org/JTC1/SC22/WG21/docs/papers/2020/p1144r5.html>`__.
This means that, if you store data types in it that have pointers to themselves, or are otherwise
`not trivially relocatable <https://open-std.org/JTC1/SC22/WG21/docs/papers/2020/p1144r5.html#non-trivial-samples>`__,
Godot might crash. Note that storing **pointers to** objects that are not trivially relocatable, such as some Object
subclasses, is unproblematic and supported.
The reason to assume trivial relocatability is that it allows us to make use of important optimization techniques, such
as relocation by ``memcpy`` or ``realloc``.
`GH-100509 <https://github.com/godotengine/godot/issues/100509>`__ tracks this decision.
.. _doc_core_concurrency_types:
Multithreading / Concurrency