Require a T5_Glasses for invocation
◆ t5CancelCamImageBuffer()
Clear out the remaining buffers and return all buffers as a vector of camera images.
- Exclusive Connection
- Requires an exclusive connection - established with makeExclusive().
- Threading
- Exclusivity group 1 - Functions in this group must not be called simultaneously from different threads.
- Parameters
-
[in] | glasses | - T5_Glasses returned by T5ApiSys::createGlasses(). |
[in] | buffer | - A pointer to an image buffer that should be cancelled and no longer used by the service |
- Return values
-
Referenced by tiltfive::Glasses::cancelCamImageBuffer().
◆ t5ConfigureCameraStreamForGlasses()
Configure the camera stream.
- Threading
- Exclusivity group 1 - Functions in this group must not be called concurrently from different threads.
- Parameters
-
- Return values
-
The following are internal errors that should be discarded and/or logged:
- Return values
-
Referenced by tiltfive::Glasses::configureCameraStream().
◆ t5GetFilledCamImageBuffer()
Get a new filled image buffer from the camera stream. Will always return the oldest filled buffer. This function does not block on call, and will return a TryAgain error if there are no available filled buffers. To ensure images don't become stale, continual polling of t5GetFilledCamImageBuffer() and resubmission of empty buffers via t5SubmitEmptyCamImageBuffer() is expected.
- Exclusive Connection
- Requires an exclusive connection - established with makeExclusive().
- Threading
- Exclusivity group 1 - Functions in this group must not be called simultaneously from different threads.
- Parameters
-
[in] | glasses | - T5_Glasses returned by T5ApiSys::createGlasses(). |
[out] | image | - T5_CamImage representing a camera image wrapper that will contain a filled buffer upon successful return. |
- Return values
-
Referenced by tiltfive::Glasses::getFilledCamImageBuffer().
◆ t5ReleaseGlasses()
Release previously-reserved glasses.
Release glasses that were previously reserved for exclusive operations by the client. After calling this, exclusive operations cannot be used with the glasses unless the glasses are again reserved and readied.
- Threading
- Exclusivity group 1 - Functions in this group must not be called concurrently from different threads.
- Parameters
-
[in] | glasses | - T5_Glasses returned by T5ApiSys::createGlasses() |
- Return values
-
Referenced by tiltfive::Glasses::release().
◆ t5SubmitEmptyCamImageBuffer()
Submit an empty image buffer to be filled by the camera frame stream.
- Exclusive Connection
- Requires an exclusive connection - established with makeExclusive().
- Threading
- Exclusivity group 1 - Functions in this group must not be called simultaneously from different threads.
The memory in the image buffer Must remain valid until the corresponding wrapper is returned by t5GetFilledCamImageBuffer or the buffer is canceled by t5CancelCamImageBuffer
Note, only the image buffer inside of T5_CamImage is required to be kept valid. The T5_CamImage wrapper is not.
Incoming image is expected to have 0 width, height, and stride, and a buffer size larger than the minimum image size.
- Parameters
-
[in] | glasses | - T5_Glasses returned by T5ApiSys::createGlasses(). |
[in] | image | - T5_CamImage representing current camera image buffer to be filled. |
- Return values
-
Referenced by tiltfive::Glasses::submitEmptyCamImageBuffer().