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.
  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     pure_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 Lua. ``_1`` is used as the internal index.
  35 =============== =============================================================
  36
  37 Example
  38 ~~~~~~~
  39
  40 .. parsed-literal::
  41
  42     void f1(float& val) { val = 10.f; }
  43     void f2(float\* val) { \*val = 10.f; }
  44
  45     module(L)
  46     [
  47         def("f", &f, **pure_out_value(_1)**)
  48     ];
  49
  50     Lua 5.0  Copyright (C) 1994-2003 Tecgraf, PUC-Rio
  51     > print(f1())
  52     10
  53     > print(f2())
  54     10
  55