doc/copy.rst

   1 copy
   2 ----------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 This will make a copy of the parameter. This is the default behavior when
   8 passing parameters by-value. Note that this can only be used when passing from
   9 C++ to Lua. This policy requires that the parameter type has an accessible copy
  10 constructor.
  11
  12 Defined in
  13 ~~~~~~~~~~
  14
  15 .. parsed-literal::
  16
  17     #include <luabind/copy_policy.hpp>
  18
  19 Synopsis
  20 ~~~~~~~~
  21
  22 .. parsed-literal::
  23
  24     copy(index)
  25
  26 Parameters
  27 ~~~~~~~~~~
  28
  29 ============= ===============================================================
  30 Parameter     Purpose
  31 ============= ===============================================================
  32 ``index``     The index to copy. ``result`` when used while wrapping C++
  33               functions. ``_N`` when passing arguments to Lua.
  34 ============= ===============================================================
  35
  36 Example
  37 ~~~~~~~
  38
  39 .. parsed-literal::
  40
  41     X* get()
  42     {
  43         static X instance;
  44         return &instance;
  45     }
  46
  47     ...
  48
  49     module(L)
  50     [
  51         def("create", &create, **copy(result)**)
  52     ];
  53