Fove SDK
v0.16.0
|
Main API for using headsets. More...
#include <FoveAPI.h>
Static Public Member Functions | |
static Result< Headset > | create (const ClientCapabilities capabilities) |
Creates a new headset object with the given capabitilies. | |
Main API for using headsets.
This class is a wrapper around the C API's Fove_Headset, and is the main class of the FOVE API.
|
default |
Creates an empty headset.
Please use Headset::create() to create a valid headset.
Fove::Headset::Headset | ( | Fove_Headset & | headset | ) |
Creates a headset from an existing C API object.
This is not normally invoked directly, rather Headset::create(), which wraps this, is typically used.
Fove::Headset::Headset | ( | Headset && | other | ) |
Move constructs a headset.
other | May be empty or non-empty. By return, it will be empty. |
Fove::Headset::~Headset | ( | ) |
Destroys the headset, releasing any resources.
Since an error cannot be returned, any error from fove_Headset_destroy will be logged.
Result Fove::Headset::destroy | ( | ) |
Destroys the headset, releasing resources.
Afer this call, this object will be in an empty state and future calls will fail. This is handled by the destructor, usually the user doesn't need to call this.
Result<ResearchHeadset> Fove::Headset::getResearchHeadset | ( | const ResearchCapabilities | caps | ) |
Creates a new research headet.
Keep in mind the research API is meant for researcher use and not for general purpose software. Using this function will limit backwards compatibility.