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 --- lib/sol2/docs/source/api/variadic_results.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 lib/sol2/docs/source/api/variadic_results.rst (limited to 'lib/sol2/docs/source/api/variadic_results.rst') diff --git a/lib/sol2/docs/source/api/variadic_results.rst b/lib/sol2/docs/source/api/variadic_results.rst new file mode 100644 index 0000000..39067e1 --- /dev/null +++ b/lib/sol2/docs/source/api/variadic_results.rst @@ -0,0 +1,11 @@ +variadic_results +================ +*push multiple disparate arguments into lua* + +.. code-block:: cpp + + struct variadic_results : std::vector { ... }; + +This type allows someone to prepare multiple returns before returning them into Lua. It derives from ``std::vector``, so it can be used exactly like that, and objects can be added using the various constructors and functions relating to :doc:`sol::object`. You can see it and other return-type helpers in action `here`_. + +.. _here: https://github.com/ThePhD/sol2/blob/develop/examples/source/multi_results.cpp -- cgit v1.2.3