The interface of a generator.
Starts generation of the output.
- Parameters
-
hGenerator | [in] A handle to the instance to start generating. |
Checks if the generator is currently generating.
- Parameters
-
hGenerator | [in] A handle to the instance. |
Stops generation of the output.
- Parameters
-
hGenerator | [in] A handle to the instance to stop generating. |
Registers a callback function to be called when generation starts or stops.
- Parameters
-
hGenerator | [in] A handle to the instance. |
handler | [in] A pointer to a function that will be called when generation starts/stops. |
pCookie | [in] A user cookie that will be passed to the callback function. |
phCallback | [out] Optional. Will be filled with a handle to be passed to UnregisterFromGenerationRunningChange(). |
Unregisters a callback function which was registered using RegisterToGenerationRunningChange().
- Parameters
-
hGenerator | [in] A handle to the instance. |
hCallback | [in] The handle to the callback returned from RegisterToGenerationRunningChange(). |
Registers a callback function to be called when new data is available.
- Parameters
-
handler | [in] A pointer to a function that will be called when new data is available. |
pCookie | [in] A user cookie that will be passed to the callback function. |
phCallback | [out] Optional. Will be filled with a handle to be passed to UnregisterFromNewDataAvailable(). |
Unregisters a callback function which was registered using RegisterToNewDataAvailable().
- Parameters
-
hGenerator | [in] A handle to the instance. |
hCallback | [in] The handle to the callback returned from RegisterToNewDataAvailable(). |
Checks whether this node has new data (and so a call to xn::Generator::WaitAndUpdateData() will not block).
- Parameters
-
hGenerator | [in] A handle to the instance to be updated. |
pnTimestamp | [out] If new data is available, the timestamp of that data. |
Updates the data to the latest available one. This function will only be called AFTER the node notified OpenNI it has new data available.
- Parameters
-
hGenerator | [in] A handle to the instance to be updated. |