doc/pure_out_value.rst

   1 pure_out_value
   2 ----------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 This works exactly like ``out_value``, except that it will pass a
   8 default constructed object instead of converting an argument from
   9 Lua. This means that the parameter will be removed from the lua
  10 signature.
  11
  12 Defined in
  13 ~~~~~~~~~~
  14
  15 .. parsed-literal::
  16
  17     #include <luabind/out_value_policy.hpp>
  18
  19 Synopsis
  20 ~~~~~~~~
  21
  22 .. parsed-literal::
  23
  24     pure_out_value(index, policies = none)
  25
  26
  27 Parameters
  28 ~~~~~~~~~~
  29
  30 =============== =============================================================
  31 Parameter       Purpose
  32 =============== =============================================================
  33 ``index``       The index of the parameter to be used as an out parameter.
  34 ``policies``    The policies used internally to convert the out parameter
  35                 to Lua. ``_1`` is used as the internal index.
  36 =============== =============================================================
  37
  38 Example
  39 ~~~~~~~
  40
  41 Note that no values are passed to the calls to ``f1`` and ``f2``.
  42
  43 .. parsed-literal::
  44
  45     void f1(float& val) { val = 10.f; }
  46     void f2(float\* val) { \*val = 10.f; }
  47
  48     module(L)
  49     [
  50         def("f", &f, **pure_out_value(_1)**)
  51     ];
  52
  53     Lua 5.0  Copyright (C) 1994-2003 Tecgraf, PUC-Rio
  54     > print(f1())
  55     10
  56     > print(f2())
  57     10
  58