doc/raw.rst

   1 raw
   2 ---
   3
   4 .. note::
   5
   6     ``raw()`` has been deprecated. ``lua_State*`` parameters are
   7     automatically handled by luabind.
   8
   9 Motivation
  10 ~~~~~~~~~~
  11
  12 This converter policy will pass through the ``lua_State*`` unmodified.
  13 This can be useful for example when binding functions that need to
  14 return a ``luabind::object``. The parameter will be removed from the
  15 function signature, decreasing the function arity by one.
  16
  17 Defined in
  18 ~~~~~~~~~~
  19
  20 .. parsed-literal::
  21
  22     #include <luabind/raw_policy.hpp>
  23
  24 Synopsis
  25 ~~~~~~~~
  26
  27 .. parsed-literal::
  28
  29     raw(index)
  30
  31 Parameters
  32 ~~~~~~~~~~
  33
  34 ============= ===============================================================
  35 Parameter     Purpose
  36 ============= ===============================================================
  37 ``index``     The index of the lua_State* parameter.
  38 ============= ===============================================================
  39
  40 Example
  41 ~~~~~~~
  42
  43 .. parsed-literal::
  44
  45     void greet(lua_State* L)
  46     {
  47         lua_pushstring(L, "hello");
  48     }
  49
  50     ...
  51
  52     module(L)
  53     [
  54         def("greet", &greet, **raw(_1)**)
  55     ];
  56
  57     > print(greet())
  58     hello
  59