doc/out_value.rst

   1 out_value
   2 ----------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 This policy makes it possible to wrap functions that take non-const references
   8 or pointer to non-const as it's parameters with the intention to write return
   9 values to them. Since it's impossible to pass references to primitive types
  10 in lua, this policy will add another return value with the value after the
  11 call. If the function already has one return value, one instance of this
  12 policy will add another return value (read about multiple return values in
  13 the lua manual).
  14
  15 Defined in
  16 ~~~~~~~~~~
  17
  18 .. parsed-literal::
  19
  20     #include <luabind/out_value_policy.hpp>
  21
  22 Synopsis
  23 ~~~~~~~~
  24
  25 .. parsed-literal::
  26
  27     out_value(index, policies = none)
  28
  29
  30 Parameters
  31 ~~~~~~~~~~
  32
  33 =============== =============================================================
  34 Parameter       Purpose
  35 =============== =============================================================
  36 ``index``       The index of the parameter to be used as an out parameter.
  37 ``policies``    The policies used internally to convert the out parameter
  38                 to/from Lua. ``_1`` means **to** C++, ``_2`` means **from**
  39                 C++.
  40 =============== =============================================================
  41
  42 Example
  43 ~~~~~~~
  44
  45 .. parsed-literal::
  46
  47     void f1(float& val) { val = val + 10.f; }
  48     void f2(float\* val) { \*val = \*val + 10.f; }
  49
  50     module(L)
  51     [
  52         def("f", &f, **out_value(_1)**)
  53     ];
  54
  55     Lua 5.0  Copyright (C) 1994-2003 Tecgraf, PUC-Rio
  56     > print(f1(10))
  57     20
  58     > print(f2(10))
  59     20
  60