File: copy.rst

package info (click to toggle)
luabind 0.9.1%2Bdfsg-5
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 1,460 kB
  • sloc: cpp: 13,761; makefile: 120; sh: 24; ansic: 11
file content (53 lines) | stat: -rwxr-xr-x 1,053 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
copy
----------------

Motivation
~~~~~~~~~~

This will make a copy of the parameter. This is the default behavior when
passing parameters by-value. Note that this can only be used when passing from
C++ to Lua. This policy requires that the parameter type has an accessible copy
constructor.

Defined in
~~~~~~~~~~

.. parsed-literal::

    #include <luabind/copy_policy.hpp>

Synopsis
~~~~~~~~

.. parsed-literal::

    copy(index)

Parameters
~~~~~~~~~~

============= ===============================================================
Parameter     Purpose
============= ===============================================================
``index``     The index to copy. ``result`` when used while wrapping C++
              functions. ``_N`` when passing arguments to Lua.
============= ===============================================================

Example
~~~~~~~

.. parsed-literal::

    X* get()
    {
        static X instance;
        return &instance;
    }

    ...

    module(L)
    [
        def("create", &create, **copy(result)**)
    ];