From dc2493e7525bb7633f697ef10f72b72b46222249 Mon Sep 17 00:00:00 2001 From: Andy Belle-Isle Date: Fri, 30 Aug 2019 00:45:36 -0400 Subject: Forget what I said, I just need to change git attributes to mark for vendor --- deps/sol2/docs/source/api/user.rst | 19 ------------------- 1 file changed, 19 deletions(-) delete mode 100644 deps/sol2/docs/source/api/user.rst (limited to 'deps/sol2/docs/source/api/user.rst') diff --git a/deps/sol2/docs/source/api/user.rst b/deps/sol2/docs/source/api/user.rst deleted file mode 100644 index 712f2d3..0000000 --- a/deps/sol2/docs/source/api/user.rst +++ /dev/null @@ -1,19 +0,0 @@ -light/user -================ -*utility class for the cheapest form of (light) userdata* - - -.. code-block:: cpp - - template - struct user; - - template - struct light; - - -``sol::user`` and ``sol::light`` are two utility classes that do not participate in the full :doc:`sol::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``, when pushed into Lua, will create a thin, unnamed metatable for that instance specifically which will be for calling its destructor. ``sol::light`` 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\` 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 -- cgit v1.2.3