Fove SDK
v0.16.0
|
Compositor API. More...
#include <FoveAPI.h>
Public Member Functions | |
Compositor ()=default | |
Creates a null compositor. More... | |
Compositor (Fove_Compositor &compositor) | |
Creates a compositor from an existing C API object. More... | |
Compositor (Compositor &&other) | |
Move constructs a compositor. More... | |
~Compositor () | |
Destroys the compositor, freeing any resources used (including all layers) More... | |
Result< CompositorLayer > | createLayer (const CompositorLayerCreateInfo &layerInfo) |
Wraps fove_Compositor_createLayer() | |
Result | destroy () |
Destroys the compositor object, releasing resources. More... | |
Result< AdapterId > | getAdapterId (AdapterId *outAdapterId) |
Wraps fove_Compositor_getAdapterId() | |
Result< Pose > | getLastRenderPose () |
Wraps fove_Compositor_getLastRenderPose() | |
Result< bool > | isReady () |
Wraps fove_Compositor_isReady() | |
Compositor & | operator= (Compositor &&other) |
Destroys the existing compositor if any, then moves the one referenced by other , if any, into this object. More... | |
Result | submit (const CompositorLayerSubmitInfo *submitInfo, const size_t layerCount) |
Wraps fove_Compositor_submit() | |
Result | submit (const CompositorLayerSubmitInfo &submitInfo) |
Alternate version of submit() that simply takes one layer. | |
Result< Pose > | waitForRenderPose () |
Wraps fove_Compositor_waitForRenderPose() | |
Public Member Functions inherited from Fove::Object< Fove_Compositor > | |
Fove_Compositor * | getCObject () const |
Returns the underlying C type which the caller can use to invoke the C API directly. More... | |
Compositor API.
This class is a wrapper around the C API's Fove_Compositor.
It is the main way to draw content to a headset.
|
default |
Creates a null compositor.
Please use Headset::createCompositor() to get a valid compositor
Fove::Compositor::Compositor | ( | Fove_Compositor & | compositor | ) |
Creates a compositor from an existing C API object.
This is not normally invoked directly, rather Headset::createCompositor(), which wraps this, is typically used.
Fove::Compositor::Compositor | ( | Compositor && | other | ) |
Move constructs a compositor.
other | may be null or non-null. By return, it will be null. |
Fove::Compositor::~Compositor | ( | ) |
Destroys the compositor, freeing any resources used (including all layers)
Since an error cannot be returned, any error from fove_Compositor_destroy will be logged.
Result Fove::Compositor::destroy | ( | ) |
Destroys the compositor object, releasing resources.
Afer this call, this object will be in a null state and future calls will fail. This is handled by the destructor, usually the user doesn't need to call this.
Compositor& Fove::Compositor::operator= | ( | Compositor && | other | ) |
Destroys the existing compositor if any, then moves the one referenced by other
, if any, into this object.
other | may be null or non-null. By return, it will be null. |