You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: FabricSplice.h
+6-4
Original file line number
Diff line number
Diff line change
@@ -41,14 +41,16 @@ Indices and Tables
41
41
Introduction
42
42
============
43
43
44
+
.. note:: You can find the source code for the SpliceAPI here: http://github.com/fabric-engine/SpliceAPI
45
+
44
46
The Fabric:Splice C/C++ API, referred to as :dfn:`SPLICECAPI` in this document, is an abstraction layer to the `Fabric Core CAPI <http://documentation.fabric-engine.com/CreationPlatform/latest/HTML/CAPIProgrammingGuide/index.html>`_. The SPLICEAPI provides a simpler way to integrate Fabric Core based functionality into C/C++ hosts applications and wraps lots of the rudimentary facilities. The :dfn:`SPLICECAPI` also supports additional facilities, such as persistence, for example.
45
47
46
-
Aside from this documentation API you can find a general descriptiong of how to integrate Splice into a host application here: :ref:`SPLICEINTEGRATION`. This also includes recommendations for build settings and C defines.
48
+
Aside from this documentation API you can find a general description of how to integrate Splice into a host application here: :ref:`SPLICEINTEGRATION`. This also includes recommendations for build settings and C defines.
47
49
48
50
One API, Two Interfaces
49
51
-----------------------
50
52
51
-
:dfn:`SPLICECAPI` is implemented as a pure C API with a thin, inlined C++ interface that makes it easier to use in C++ applications. This is done to minimize linking issues, as the C linking interface on the platforms that Fabric:Splice supports is much more controlled than the C++ linking interface. The C++ interface is thus purely a C++ programmer convience; however, it is a big programmer convenience, and as such it is recommended that you use the C++ language interface when possible. Both interfaces link with exactly the same shared library (DLL).
53
+
:dfn:`SPLICECAPI` is implemented as a pure C API with a thin, inlined C++ interface that makes it easier to use in C++ applications. This is done to minimize linking issues, as the C linking interface on the platforms that Fabric:Splice supports is much more controlled than the C++ linking interface. The C++ interface is thus purely a C++ programmer convenience; however, it is a big programmer convenience, and as such it is recommended that you use the C++ language interface when possible. Both interfaces link with exactly the same shared library (DLL).
52
54
53
55
Since the host application targeted with the :dfn:`SPLICECAPI` are mainly C++ based, when discussing the API in this guide, we will only present the C++ version.
54
56
@@ -949,7 +951,7 @@ Class Outline
949
951
FabricSplice::Scripting
950
952
===============================
951
953
952
-
The Scripting class provides static methods for parsing script arguments. This can be useful within Splice integrations. Options are provided as json strings typically, and the following helper functions simlpify parsing these.
954
+
The Scripting class provides static methods for parsing script arguments. This can be useful within Splice integrations. Options are provided as json strings typically, and the following helper functions simplify parsing these.
953
955
954
956
Class Outline
955
957
---------------------------------
@@ -1007,7 +1009,7 @@ Example
1007
1009
printf("Splice Error %s\n", e.what());
1008
1010
}
1009
1011
1010
-
It's recommended to wrap the try and catch calles into macros, so that you can deploy them easily anywhere you use the :dfn:`SPLICECAPI`.
1012
+
It's recommended to wrap the try and catch calls into macros, so that you can deploy them easily anywhere you use the :dfn:`SPLICECAPI`.
0 commit comments