diff options
Diffstat (limited to 'lib/sol2/docs/source/api/yielding.rst')
| -rw-r--r-- | lib/sol2/docs/source/api/yielding.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/yielding.rst b/lib/sol2/docs/source/api/yielding.rst new file mode 100644 index 0000000..ad124b1 --- /dev/null +++ b/lib/sol2/docs/source/api/yielding.rst @@ -0,0 +1,10 @@ +yielding
+========
+*telling a C++ function to yield its results into Lua*
+
+.. code-block:: cpp
+
+ template <typename F>
+ yield_wrapper<F> yielding( F&& f )
+
+``sol::yielding`` is useful for calling C++ functions which need to yield into a Lua coroutine. It is a wrapper around a single argument which is expected to be bound as a function. You can pass it anywhere a regular function can be bound, **except for in usertype definitions**.
|