Classes | |
struct | VuCameraRegionOfInterest |
Data structure for setting and getting focus and exposure regions of interest in the camera image. More... | |
struct | VuCameraVideoMode |
Camera video mode description. More... | |
Typedefs | |
typedef struct VuCameraVideoModeList_ | VuCameraVideoModeList |
List of video modes available for a camera. | |
Enumerations | |
enum | VuCameraVideoModePreset : int32_t { VU_CAMERA_VIDEO_MODE_PRESET_DEFAULT = 0x1 , VU_CAMERA_VIDEO_MODE_PRESET_OPTIMIZE_SPEED = 0x2 , VU_CAMERA_VIDEO_MODE_PRESET_OPTIMIZE_QUALITY = 0x3 } |
Supported camera video mode presets. More... | |
enum | VuCameraFocusMode : int32_t { VU_CAMERA_FOCUS_MODE_UNKNOWN = 0x1 , VU_CAMERA_FOCUS_MODE_TRIGGERAUTO = 0x3 , VU_CAMERA_FOCUS_MODE_CONTINUOUSAUTO = 0x4 , VU_CAMERA_FOCUS_MODE_INFINITY = 0x5 , VU_CAMERA_FOCUS_MODE_MACRO = 0x6 , VU_CAMERA_FOCUS_MODE_FIXED = 0x7 } |
Supported camera focus modes. More... | |
enum | VuCameraExposureMode : int32_t { VU_CAMERA_EXPOSURE_MODE_UNKNOWN = 0x1 , VU_CAMERA_EXPOSURE_MODE_TRIGGERAUTO = 0x2 , VU_CAMERA_EXPOSURE_MODE_CONTINUOUSAUTO = 0x3 , VU_CAMERA_EXPOSURE_MODE_FIXED = 0x4 } |
Supported camera exposure modes. More... | |
Functions | |
VuResult | vuEngineGetCameraController (const VuEngine *engine, VuController **controller) |
Retrieve Camera Controller to get access to camera-specific functionality in Engine. | |
VuResult | vuCameraControllerGetVideoModes (const VuController *controller, VuCameraVideoModeList *cameraVideoModeList) |
Get all the supported video modes for the camera. | |
VuResult | vuCameraVideoModeListCreate (VuCameraVideoModeList **list) |
Create a camera video mode list. | |
VuResult | vuCameraVideoModeListGetSize (const VuCameraVideoModeList *list, int32_t *listSize) |
Get number of elements in a camera video mode list. | |
VuResult | vuCameraVideoModeListGetElement (const VuCameraVideoModeList *list, int32_t element, VuCameraVideoMode *videoMode) |
Get an element in a camera video mode list. | |
VuResult | vuCameraVideoModeListDestroy (VuCameraVideoModeList *list) |
Destroy a camera video mode list. | |
VuResult | vuCameraControllerGetActiveVideoMode (const VuController *controller, VuCameraVideoModePreset *cameraVideoModePreset) |
Get the the currently active video mode of the camera. | |
VuResult | vuCameraControllerSetActiveVideoMode (VuController *controller, VuCameraVideoModePreset cameraVideoModePreset) |
Set the current video mode of the camera from the list of supported presets. | |
VuResult | vuCameraControllerGetFlashMode (const VuController *controller, VuBool *flashMode) |
Get the current flash mode of the camera. | |
VuResult | vuCameraControllerSetFlashMode (VuController *controller, VuBool flashMode) |
Set the flash mode of the camera. | |
VuResult | vuCameraControllerIsFlashModeSupported (VuController *controller, VuBool *isFlashModeSupported) |
Check if setting the flash mode is supported on the current device and camera. | |
VuResult | vuCameraControllerGetFocusMode (const VuController *controller, VuCameraFocusMode *focusMode) |
Get the current focus mode of the camera. | |
VuResult | vuCameraControllerSetFocusMode (VuController *controller, VuCameraFocusMode focusMode) |
Set the focus mode of the camera. | |
VuResult | vuCameraControllerGetExposureMode (const VuController *controller, VuCameraExposureMode *exposureMode) |
Get the current exposure mode of the camera. | |
VuResult | vuCameraControllerSetExposureMode (VuController *controller, VuCameraExposureMode exposureMode) |
Set the exposure mode of the camera. | |
VuResult | vuCameraControllerIsFocusModeSupported (VuController *controller, VuCameraFocusMode focusMode, VuBool *isFocusModeSupported) |
Check if setting a specific focus mode is supported on the current device. | |
VuResult | vuCameraControllerIsExposureModeSupported (VuController *controller, VuCameraExposureMode exposureMode, VuBool *isExposureModeSupported) |
Check if setting a specific exposure mode is supported on the current device. | |
VuResult | vuCameraControllerGetFocusRegion (const VuController *controller, VuCameraRegionOfInterest *focusROI) |
Get the region of interest currently active for camera focus control. | |
VuResult | vuCameraControllerSetFocusRegion (VuController *controller, VuCameraRegionOfInterest focusROI) |
Set the active region of interest for camera focus control. | |
VuResult | vuCameraControllerGetExposureRegion (const VuController *controller, VuCameraRegionOfInterest *exposureROI) |
Get the region of interest currently active for camera exposure control. | |
VuResult | vuCameraControllerSetExposureRegion (VuController *controller, VuCameraRegionOfInterest exposureROI) |
Set the active region of interest for camera exposure control. | |
VuResult | vuCameraControllerIsFocusRegionSupported (const VuController *controller, VuBool *isFocusRegionSupported) |
Check if setting a focus region is supported on the current device. | |
VuResult | vuCameraControllerIsExposureRegionSupported (const VuController *controller, VuBool *isExposureRegionSupported) |
Check if setting an exposure region is supported on the current device. | |
VuResult | vuCameraControllerGetRegisteredImageFormats (const VuController *controller, VuImagePixelFormatList *list) |
Get list of image formats registered to be returned with the camera frame. | |
VuResult | vuCameraControllerRegisterImageFormat (VuController *controller, VuImagePixelFormat format) |
Register a video pixel format to be delivered in the list of images of a camera frame. | |
VuResult | vuCameraControllerUnregisterImageFormat (VuController *controller, VuImagePixelFormat format) |
Unregister a video pixel format from being delivered in the list of images of a camera frame. | |
VuResult | vuCameraControllerIsDepthSupported (const VuController *controller, VuBool *supported) |
Check if depth frames are supported on this device. | |
VuResult | vuCameraControllerEnableDepth (VuController *controller) |
Enable depth frames. | |
VuResult | vuCameraControllerDisableDepth (VuController *controller) |
Disable depth frames. | |
VuBool | vuCameraControllerIsDepthEnabled (const VuController *controller) |
Check if depth frames are currently enabled. | |
This controller allows the control of camera features such as configuring the video mode, focus mode, exposure mode, flash mode or accessing advanced camera properties.
enum VuCameraVideoModePreset : int32_t |
Supported camera video mode presets.
enum VuCameraFocusMode : int32_t |
Supported camera focus modes.
enum VuCameraExposureMode : int32_t |
Supported camera exposure modes.
VuResult vuCameraControllerGetVideoModes | ( | const VuController * | controller, |
VuCameraVideoModeList * | cameraVideoModeList ) |
Get all the supported video modes for the camera.
VuResult vuCameraControllerSetActiveVideoMode | ( | VuController * | controller, |
VuCameraVideoModePreset | cameraVideoModePreset ) |
Set the current video mode of the camera from the list of supported presets.
VuResult vuCameraControllerGetFlashMode | ( | const VuController * | controller, |
VuBool * | flashMode ) |
Get the current flash mode of the camera.
VuResult vuCameraControllerSetFlashMode | ( | VuController * | controller, |
VuBool | flashMode ) |
Set the flash mode of the camera.
VuResult vuCameraControllerIsFlashModeSupported | ( | VuController * | controller, |
VuBool * | isFlashModeSupported ) |
Check if setting the flash mode is supported on the current device and camera.
VuResult vuCameraControllerGetFocusMode | ( | const VuController * | controller, |
VuCameraFocusMode * | focusMode ) |
Get the current focus mode of the camera.
VuResult vuCameraControllerSetFocusMode | ( | VuController * | controller, |
VuCameraFocusMode | focusMode ) |
Set the focus mode of the camera.
VuResult vuCameraControllerGetExposureMode | ( | const VuController * | controller, |
VuCameraExposureMode * | exposureMode ) |
Get the current exposure mode of the camera.
VuResult vuCameraControllerSetExposureMode | ( | VuController * | controller, |
VuCameraExposureMode | exposureMode ) |
Set the exposure mode of the camera.
VuResult vuCameraControllerIsFocusModeSupported | ( | VuController * | controller, |
VuCameraFocusMode | focusMode, | ||
VuBool * | isFocusModeSupported ) |
Check if setting a specific focus mode is supported on the current device.
VuResult vuCameraControllerIsExposureModeSupported | ( | VuController * | controller, |
VuCameraExposureMode | exposureMode, | ||
VuBool * | isExposureModeSupported ) |
Check if setting a specific exposure mode is supported on the current device.
VuResult vuCameraControllerGetFocusRegion | ( | const VuController * | controller, |
VuCameraRegionOfInterest * | focusROI ) |
Get the region of interest currently active for camera focus control.
VuResult vuCameraControllerSetFocusRegion | ( | VuController * | controller, |
VuCameraRegionOfInterest | focusROI ) |
Set the active region of interest for camera focus control.
VuResult vuCameraControllerGetExposureRegion | ( | const VuController * | controller, |
VuCameraRegionOfInterest * | exposureROI ) |
Get the region of interest currently active for camera exposure control.
VuResult vuCameraControllerSetExposureRegion | ( | VuController * | controller, |
VuCameraRegionOfInterest | exposureROI ) |
Set the active region of interest for camera exposure control.
VuResult vuCameraControllerIsFocusRegionSupported | ( | const VuController * | controller, |
VuBool * | isFocusRegionSupported ) |
Check if setting a focus region is supported on the current device.
VuResult vuCameraControllerIsExposureRegionSupported | ( | const VuController * | controller, |
VuBool * | isExposureRegionSupported ) |
Check if setting an exposure region is supported on the current device.
VuResult vuCameraControllerRegisterImageFormat | ( | VuController * | controller, |
VuImagePixelFormat | format ) |
Register a video pixel format to be delivered in the list of images of a camera frame.
For a registered video pixel format an image will be converted from the native video pixel format of the camera on each state update and delivered in the list of images of the VuCameraFrame. The list of images can be queried via vuCameraFrameGetImages.
By default only the image with the native video pixel format of the camera will be delivered. The native video pixel format can be queried via vuCameraControllerGetVideoModes in field VuCameraVideoMode::format.
VuResult vuCameraControllerUnregisterImageFormat | ( | VuController * | controller, |
VuImagePixelFormat | format ) |
Unregister a video pixel format from being delivered in the list of images of a camera frame.
Unregistering a video pixel format will stop Engine from delivering (and potentially converting to) an image of the given video pixel format on each state update in the list of images of the VuCameraFrame.
VuResult vuCameraControllerIsDepthSupported | ( | const VuController * | controller, |
VuBool * | supported ) |
Check if depth frames are supported on this device.
VuResult vuCameraControllerEnableDepth | ( | VuController * | controller | ) |
Enable depth frames.
VuResult vuCameraControllerDisableDepth | ( | VuController * | controller | ) |
Disable depth frames.
VuBool vuCameraControllerIsDepthEnabled | ( | const VuController * | controller | ) |
Check if depth frames are currently enabled.