From 377472a6dd2c9bdff4d5667f5789c49aee2abb4c Mon Sep 17 00:00:00 2001 From: Miodrag Milanovic Date: Fri, 7 Oct 2016 14:43:09 +0200 Subject: Added sol2 header only library as future replacement for luabridge (nw) --- 3rdparty/sol2/docs/source/api/stack_reference.rst | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 3rdparty/sol2/docs/source/api/stack_reference.rst (limited to '3rdparty/sol2/docs/source/api/stack_reference.rst') diff --git a/3rdparty/sol2/docs/source/api/stack_reference.rst b/3rdparty/sol2/docs/source/api/stack_reference.rst new file mode 100644 index 00000000000..db5359d11aa --- /dev/null +++ b/3rdparty/sol2/docs/source/api/stack_reference.rst @@ -0,0 +1,8 @@ +stack_reference +=============== +zero-overhead object on the stack +--------------------------------- + +When you work with a :doc:`sol::reference`, the object gotten from the stack has a reference to it made in the registry, keeping it alive. If you want to work with the Lua stack directly without having any additional references made, ``sol::stack_reference`` is for you. Its API is identical to ``sol::reference`` in every way, except it contains a ``int stack_index()`` member function that allows you to retrieve the stack index. + +All of the base types have ``stack`` versions of themselves, and the APIs are identical to their non-stack forms. This includes :doc:`sol::stack_table`, :doc:`sol::stack_function`, :doc:`sol::stack_protected_function`, :doc:`sol::stack_(light\_)userdata` and :doc:`sol::stack_object`. \ No newline at end of file -- cgit v1.2.3-70-g09d2