doc/raw.rst

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