summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/sol2/docs/source/api/stack_reference.rst
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/sol2/docs/source/api/stack_reference.rst')
-rw-r--r--3rdparty/sol2/docs/source/api/stack_reference.rst8
1 files changed, 0 insertions, 8 deletions
diff --git a/3rdparty/sol2/docs/source/api/stack_reference.rst b/3rdparty/sol2/docs/source/api/stack_reference.rst
deleted file mode 100644
index db5359d11aa..00000000000
--- a/3rdparty/sol2/docs/source/api/stack_reference.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-stack_reference
-===============
-zero-overhead object on the stack
----------------------------------
-
-When you work with a :doc:`sol::reference<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<table>`, :doc:`sol::stack_function<function>`, :doc:`sol::stack_protected_function<protected_function>`, :doc:`sol::stack_(light\_)userdata<userdata>` and :doc:`sol::stack_object<object>`. \ No newline at end of file