|
|
The code base contains some example files that demonstrate instantiating and using various actions. In this post we will take a look at how to build and execute those example files on a variety of systems.
|
|
|
|
|
|
The Pulse SDK
|
|
|
-------------
|
|
|
## The Pulse SDK
|
|
|
|
|
|
The Pulse engine is really just a few static C++ libraries. You will just need to link those libraries into your application.
|
|
|
|
|
|
As part of the Pulse build instructions, you performed an install. This will provide all the files you need for your application. They will be located in an 'install' folder in your Pulse build directory.
|
|
|
|
|
|
Pulse Examples
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
Inside the sdk/howto folder of the source repository is a stand-alone CMake project providing an example of finding and using the Pulse engine in another C++ project.
|
|
|
|
|
|
C++ Examples
|
|
|
^^^^^^^^^^^^
|
|
|
### C++ Examples
|
|
|
|
|
|
As Pulse is written in C++, you will have more flexibility and control of Pulse by using the C++ interface. All C++ examples are in the sdk/howto/cpp folder. All of the C++ files are used to build a simple command line executable.
|
|
|
|
|
|
### Java Examples
|
|
|
|
|
|
Pulse provides a custom JNI bridge that provides control to a Pulse engine running in C++.
|
|
|
|
|
|
### C# Examples
|
|
|
|
|
|
Pulse provides a custom CLR bridge that provides control to a Pulse engine running in C++.
|
|
|
|
|
|
As Pulse is written in C++, you will have more flexibility and control of Pulse by using the C++ interface.
|
|
|
## Using Pulse in your applications
|
|
|
|
|
|
Java Examples
|
|
|
^^^^^^^^^^^^^
|
|
|
|
|
|
C# Examples
|
|
|
^^^^^^^^^^^
|
|
|
We encourage you to use <a href="https://cmake.org/">CMake</a> for your projects. Pulse provides a simple CMake configuration file that is used to inform other CMake projects about Pulse and its built components. This file is the PulseConfig.cmake file in the install folder of your Pulse build.
|
|
|
|
|
|
Using Pulse in your applications
|
|
|
--------------------------------
|
|
|
## Connecting a CMake project to Pulse
|
|
|
|
|
|
We encourage you to use CMake for your projects. Pulse provides a simple CMake configuration file that is used to inform other CMake projects about Pulse and its built components. This file is the PulseConfiguration.cmake file in the install folder of your Pulse build.
|
|
|
By utilizing the <a href="https://cmake.org/cmake/help/latest/command/find_package.html">find_package</a> command in your projects CMake files, you will be provided CMake variables that specify the location of Pulse headers and libraries (both debug and release).
|
|
|
|
|
|
Connecting a CMake project to Pulse
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|