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.
  10
  11 Defined in
  12 ~~~~~~~~~~
  13
  14 .. parsed-literal::
  15
  16     #include <luabind/out_value_policy.hpp>
  17
  18 Synopsis
  19 ~~~~~~~~
  20
  21 .. parsed-literal::
  22
  23     out_value(index, policies = none)
  24
  25
  26 Parameters
  27 ~~~~~~~~~~
  28
  29 =============== =============================================================
  30 Parameter       Purpose
  31 =============== =============================================================
  32 ``index``       The index of the parameter to be used as an out parameter.
  33 ``policies``    The policies used internally to convert the out parameter
  34                 to/from Lua. ``_1`` means **to** C++, ``_2`` means **from**
  35                 C++.
  36 =============== =============================================================
  37
  38 Example
  39 ~~~~~~~
  40
  41 .. parsed-literal::
  42
  43     void f1(float& val) { val = val + 10.f; }
  44     void f2(float\* val) { \*val = \*val + 10.f; }
  45
  46     module(L)
  47     [
  48         def("f", &f, **out_value(_1)**)
  49     ];
  50
  51     Lua 5.0  Copyright (C) 1994-2003 Tecgraf, PUC-Rio
  52     > print(f1(10))
  53     20
  54     > print(f2(10))
  55     20
  56