diff options
| author | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:19:31 -0400 |
|---|---|---|
| committer | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:19:31 -0400 |
| commit | bd3fe0cac583739bc0d7c4b5c8f301bb350abca0 (patch) | |
| tree | 7eeb1aabcebd6999de1c3457d0882246ec0ff4d4 /deps/sol2/docs/source/api/lua_value.rst | |
| parent | 2662ac356ce14dacfbc91689fd37244facff4989 (diff) | |
Renamed lib to deps so github will ignore it for language stats
Diffstat (limited to 'deps/sol2/docs/source/api/lua_value.rst')
| -rw-r--r-- | deps/sol2/docs/source/api/lua_value.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/deps/sol2/docs/source/api/lua_value.rst b/deps/sol2/docs/source/api/lua_value.rst new file mode 100644 index 0000000..325546c --- /dev/null +++ b/deps/sol2/docs/source/api/lua_value.rst @@ -0,0 +1,16 @@ +lua_value
+=========
+*easy creation of Lua values and tables at the cost of some safety and speed*
+
+.. code-block:: cpp
+
+ struct lua_value;
+ struct array_value;
+
+
+The goal of these types is to make it easy to describe tables and arrays in C++ code. It works by using a thread local ``lua_State*`` variable inside the class so that one can simply pass values. The thread local variable is initialized by creation of a `sol::state`, but can also `be done manually<state-automatic-handlers>` with ``sol::set_default_state``. An example of usage is below:
+
+.. literalinclude:: ../../../examples/source/lua_value.cpp
+ :caption: lua_value.cpp
+ :name: lua-value-example
+ :linenos:
|