summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/sol2/docs/source/api/user.rst
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/sol2/docs/source/api/user.rst')
-rw-r--r--3rdparty/sol2/docs/source/api/user.rst19
1 files changed, 0 insertions, 19 deletions
diff --git a/3rdparty/sol2/docs/source/api/user.rst b/3rdparty/sol2/docs/source/api/user.rst
deleted file mode 100644
index 9a0905d76bd..00000000000
--- a/3rdparty/sol2/docs/source/api/user.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-light<T>/user<T>
-================
-Utility class for the cheapest form of (light) userdata
--------------------------------------------------------
-
-.. code-block:: cpp
-
- template <typename T>
- struct user;
-
- template <typename T>
- struct light;
-
-
-``sol::user<T>`` and ``sol::light<T>`` are two utility classes that do not participate in the full :doc:`sol::usertype\<T><usertype>` system. The goal of these classes is to provide the most minimal memory footprint and overhead for putting a single item and getting a single item out of Lua. ``sol::user<T>``, when pushed into Lua, will create a thin, unnamed metatable for that instance specifically which will be for calling its destructor. ``sol::light<T>`` specifically pushes a reference / pointer into Lua as a ``sol::type::lightuserdata``.
-
-If you feel that you do not need to have something participate in the full :doc:`usertype\<T><usertype>` system, use the utility functions ``sol::make_user( ... )`` and ``sol::make_light( ... )`` to create these types and store them into Lua. You can get them off the Lua stack / out of the Lua system by using the same retrieval techniques on ``get`` and ``operator[]`` on tables and with stack operations.
-
-Both have implicit conversion operators to ``T*`` and ``T&``, so you can set them immediately to their respective pointer and reference types if you need them. \ No newline at end of file