Represents the physical camera used to capture the real world. More...
Classes | |
class | HoloLensDevice |
HoloLens specific camera functionality. More... | |
class | WebCamDevice |
WebCam specific camera functionality. More... | |
Public Member Functions | |
Vector2 | GetCameraFieldOfViewRads () |
Get the field of view for the active camera. This is a Vector2 containing the x- and y- components of the FOV in radians. If the value cannot be obtained for some reason, then Vector2.zero will be returned. | |
Image | GetCameraImage (PixelFormat format) |
Returns a camera image from the current Vuforia State for the requested format. Returns null if this image is not available. You must call SetFrameFormat before accessing the corresponding camera image. | |
Intrinsics | GetCameraIntrinsics () |
Returns the camera intrinsics from the current Vuforia State. | |
CameraRegionOfInterest | GetExposureRegion () |
Get the region of interest currently active for auto-exposure. | |
CameraRegionOfInterest | GetFocusRegion () |
Get the region of interest currently active for auto-focus. | |
int | GetRecommendedFPS () |
Returns the current framerate of the camera, which is what's recommended as the framerate cap of the application in most cases. | |
Rect | GetVideoBackgroundRectInViewPort () |
The area in the viewport that is covered by the video background. | |
VideoModeData | GetVideoMode () |
Get the video mode data that matches the selected CameraMode. | |
VideoModeData | GetVideoMode (CameraMode mode) |
Get the video mode data that matches the given CameraMode. | |
bool | IsExposureModeSupported (ExposureMode exposureMode) |
Check if setting a specific exposure mode is supported on the current device. | |
bool | IsFlashSupported () |
Check if flash is supported on the current device. | |
bool | IsFocusModeSupported (FocusMode focusMode) |
Check if setting a specific focus mode is supported on the current device. | |
bool | SetCameraMode (CameraMode mode) |
Set the current camera mode which which preferences either quality or speed This can only be called before starting Vuforia, otherwise returns false. | |
bool | SetExposureMode (ExposureMode exposureMode) |
Set the active exposure mode. Returns false if this mode is not available or can't be activated. | |
bool | SetExposureRegion (CameraRegionOfInterest regionOfInterest) |
Set the active region of interest for auto-exposure. | |
bool | SetFlash (bool on) |
Activate or deactivate the camera device flash. Returns false if flash is not available or can't be activated. | |
bool | SetFocusMode (FocusMode focusMode) |
Set the active focus mode. Returns false if this mode is not available or can't be activated. | |
bool | SetFocusRegion (CameraRegionOfInterest regionOfInterest) |
Set the active region of interest for auto-focus. | |
bool | SetFrameFormat (PixelFormat format, bool enabled) |
Enables or disables the request of the camera image in the desired pixel format. Returns true on success, false otherwise. Note that this may result in processing overhead. Image is accessed using GetCameraImage. Note that there may be a delay of several frames until the camera image becomes available. | |
Properties | |
CameraMode | CameraMode [get] |
Get the current camera mode which which preferences either quality or speed. | |
ExposureMode | ExposureMode [get] |
Get the current exposure mode of the camera, e.g. automatic or continuous. | |
bool | ExposureRegionSupported [get] |
Check if setting an exposure region is supported on the current device. | |
bool | Flash [get] |
Get camera device flash state. | |
FocusMode | FocusMode [get] |
Get the current focus mode of the camera, e.g. manual or automatic Must be called after Engine has been started. | |
bool | FocusRegionSupported [get] |
Check if setting a focus region is supported on the current device. | |
HoloLensDevice | HoloLens [get] |
Hololens specific camera functionality. | |
bool | IsActive [get] |
Returns whether the camera is currently capturing. | |
WebCamDevice | WebCam [get] |
Webcam specific functionality. | |
Represents the physical camera used to capture the real world.
Most functionality is not accessible until Vuforia has initialized completely. This can be checked by a call to VuforiaBehaviour.Instance.IsInitialized
|
inline |
Get the field of view for the active camera. This is a Vector2 containing the x- and y- components of the FOV in radians. If the value cannot be obtained for some reason, then Vector2.zero will be returned.
|
inline |
Returns a camera image from the current Vuforia State for the requested format. Returns null if this image is not available. You must call SetFrameFormat before accessing the corresponding camera image.
|
inline |
Returns the camera intrinsics from the current Vuforia State.
|
inline |
Get the region of interest currently active for auto-exposure.
|
inline |
Get the region of interest currently active for auto-focus.
|
inline |
Returns the current framerate of the camera, which is what's recommended as the framerate cap of the application in most cases.
|
inline |
The area in the viewport that is covered by the video background.
|
inline |
Get the video mode data that matches the selected CameraMode.
|
inline |
Get the video mode data that matches the given CameraMode.
|
inline |
Check if setting a specific exposure mode is supported on the current device.
exposureMode | The exposure mode to be checked for support |
|
inline |
Check if flash is supported on the current device.
|
inline |
Check if setting a specific focus mode is supported on the current device.
focusMode | The focus mode to be checked for support |
|
inline |
Set the current camera mode which which preferences either quality or speed This can only be called before starting Vuforia, otherwise returns false.
|
inline |
Set the active exposure mode. Returns false if this mode is not available or can't be activated.
exposureMode | The mode of the setting |
|
inline |
Set the active region of interest for auto-exposure.
regionOfInterest | The region of interest to be set for exposure |
|
inline |
Activate or deactivate the camera device flash. Returns false if flash is not available or can't be activated.
|
inline |
Set the active focus mode. Returns false if this mode is not available or can't be activated.
focusMode | The mode of the setting |
|
inline |
Set the active region of interest for auto-focus.
regionOfInterest | The region of interest to be set for focus |
|
inline |
Enables or disables the request of the camera image in the desired pixel format. Returns true on success, false otherwise. Note that this may result in processing overhead. Image is accessed using GetCameraImage. Note that there may be a delay of several frames until the camera image becomes available.
|
get |
Get the current camera mode which which preferences either quality or speed.
Get the current exposure mode of the camera, e.g. automatic or continuous.
|
get |
Check if setting an exposure region is supported on the current device.
|
get |
Get camera device flash state.
Get the current focus mode of the camera, e.g. manual or automatic Must be called after Engine has been started.
|
get |
Check if setting a focus region is supported on the current device.
|
get |
Hololens specific camera functionality.
|
get |
Returns whether the camera is currently capturing.
|
get |
Webcam specific functionality.