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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
.. image:: media/sol.png
:target: https://github.com/ThePhD/sol2
:alt: sol repository
:align: center
sol2 (sol2, version |version|)
==============================
*a fast, simple C++ and Lua Binding*
When you need to hit the ground running with Lua and C++, `sol`_ is the go-to framework for high-performance binding with an easy to use API.
get going:
----------
.. toctree::
:maxdepth: 1
:name: mastertoc
tutorial/all-the-things
tutorial/tutorial-top
errors
compilation
features
functions
usertypes
containers
threading
traits
api/api-top
mentions
benchmarks
performance
safety
exceptions
rtti
codecvt
build
licenses
origin
connect
--------
Come to the Github Issues! We've got a friendly community, and they can help you out or you can come just to talk about the things you are working on!
|gh|
support
-------
You can support the project and other related endeavors in various ways.
|gs| |pa| |kf| |lp| |pp|
This is a time-consuming effort, so individuals who donate get to:
- steer the direction and time spent on sol
- get their name put up in the CONTRIBUTORS list
- put something of their choice on sol2's README or the documentation's front page
"I need feature X, maybe you have it?"
--------------------------------------
Take a look at the :doc:`Features<features>` page: it links to much of the API. You can also just straight up browse the :doc:`api<api/api-top>` or ease in with the :doc:`tutorials<tutorial/tutorial-top>`. To know more about the implementation for usertypes, see :doc:`here<usertypes>` To know how function arguments are handled, see :ref:`this note<function-argument-handling>`. Don't see a feature you want? Send inquiries for support for a particular abstraction to the `issues`_ tracker.
the basics:
-----------
.. note::
The code below *and* more examples can be found in the `examples directory`_.
.. literalinclude:: ../../examples/source/docs/simple_functions.cpp
:name: simple-functions-example
:linenos:
.. literalinclude:: ../../examples/source/docs/simple_structs.cpp
:name: simple-structs-example
:linenos:
Search
======
* :ref:`search`
.. _Sol: https://github.com/ThePhD/sol2
.. _issues: https://github.com/ThePhD/sol2/issues
.. _examples directory: https://github.com/ThePhD/sol2/tree/develop/examples
.. |pa| image:: media/become_a_patron_button.png
:height: 50
:target: https://www.patreon.com/soasis
:alt: sol2 Patreon
:align: middle
.. |kf| image:: media/Ko-fi_Blue.png
:height: 50
:target: https://ko-fi.com/soasis
:alt: sol2 ko-fi
:align: middle
.. |lp| image:: media/liberapay_logo.png
:height: 50
:target: https://liberapay.com/Soasis
:alt: sol2 ko-fi
:align: middle
.. |pp| image:: media/pp_cc_mark_111x69.jpg
:height: 50
:target: https://www.paypal.me/Soasis
:alt: sol2 PayPal
:align: middle
.. |gh| image:: media/github_logo.png
:height: 75
:target: https://github.com/ThePhD/sol2/issues
:alt: sol2 Github Issues Page
.. |gs| image:: media/github_sponsors_logo.png
:height: 55
:target: https://github.com/users/ThePhD/sponsorship
:alt: sol2 Sponsors Page
.. sol documentation master file, created by
sphinx-quickstart on Mon Feb 29 21:49:51 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
|
