OpenCV for Unity  2.6.0
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.9.0/index.html ) for the details of the argument of the method.
Public Member Functions | List of all members
OpenCVForUnity.UnityUtils.Helper.VideoCaptureCameraInputToMatHelper Class Reference

VideoCaptureCameraInput to mat helper. v 1.0.1 Depends on OpenCVForUnity version 2.4.4 (WebCamTextureToMatHelper v 1.1.3) or later. (Use the WebCamDevice.isFrontFacing and WebCamTexture.videoRotationAngle properties to flip the camera input image in VideoCaptue to the correct orientation.) More...

Inheritance diagram for OpenCVForUnity.UnityUtils.Helper.VideoCaptureCameraInputToMatHelper:
OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper

Public Member Functions

virtual VideoCapture GetVideoCapture ()
 Returns the VideoCapture instanse. More...
 
- Public Member Functions inherited from OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper
virtual void Initialize ()
 Initializes this instance. More...
 
virtual void Initialize (int requestedWidth, int requestedHeight)
 Initializes this instance. More...
 
virtual void Initialize (bool requestedIsFrontFacing, float requestedFPS=30f, bool rotate90Degree=false)
 Initializes this instance. More...
 
virtual void Initialize (string deviceName, int requestedWidth, int requestedHeight, bool requestedIsFrontFacing=false, float requestedFPS=30f, bool rotate90Degree=false)
 Initializes this instance. More...
 
virtual bool IsInitialized ()
 Indicates whether this instance has been initialized. More...
 
virtual void Play ()
 Starts the camera. More...
 
virtual void Pause ()
 Pauses the active camera. More...
 
virtual void Stop ()
 Stops the active camera. More...
 
virtual bool IsPlaying ()
 Indicates whether the active camera is currently playing. More...
 
virtual bool IsFrontFacing ()
 Indicates whether the active camera device is currently front facng. More...
 
virtual string GetDeviceName ()
 Returns the active camera device name. More...
 
virtual int GetWidth ()
 Returns the active camera width. More...
 
virtual int GetHeight ()
 Returns the active camera height. More...
 
virtual float GetFPS ()
 Returns the active camera framerate. More...
 
virtual WebCamTexture GetWebCamTexture ()
 Returns the active WebcamTexture. More...
 
virtual WebCamDevice GetWebCamDevice ()
 Returns the active WebcamDevice. More...
 
virtual Matrix4x4 GetCameraToWorldMatrix ()
 Returns the camera to world matrix. More...
 
virtual Matrix4x4 GetProjectionMatrix ()
 Returns the projection matrix matrix. More...
 
virtual bool DidUpdateThisFrame ()
 Indicates whether the video buffer of the frame has been updated. More...
 
virtual Mat GetMat ()
 Gets the mat of the current frame. The Mat object's type is 'CV_8UC4' or 'CV_8UC3' or 'CV_8UC1' (ColorFormat is determined by the outputColorFormat setting). Please do not dispose of the returned mat as it will be reused. More...
 
virtual Color32 [] GetBufferColors ()
 Gets the buffer colors. More...
 
virtual void Dispose ()
 Releases all resource used by the WebCamTextureToMatHelper object. More...
 

Additional Inherited Members

- Public Types inherited from OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper
enum  ColorFormat : int {
  ColorFormat.GRAY = 0, ColorFormat.RGB, ColorFormat.BGR, ColorFormat.RGBA,
  ColorFormat.BGRA
}
 
enum  ErrorCode : int { ErrorCode.UNKNOWN = 0, ErrorCode.CAMERA_DEVICE_NOT_EXIST, ErrorCode.CAMERA_PERMISSION_DENIED, ErrorCode.TIMEOUT }
 
- Public Attributes inherited from OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper
UnityEvent onInitialized
 UnityEvent that is triggered when this instance is initialized. More...
 
UnityEvent onDisposed
 UnityEvent that is triggered when this instance is disposed. More...
 
ErrorUnityEvent onErrorOccurred
 UnityEvent that is triggered when this instance is error Occurred. More...
 
bool avoidAndroidFrontCameraLowLightIssue = false
 Indicates whether this instance avoids the front camera low light issue that occurs in only some Android devices (e.g. Google Pixel, Pixel2). Sets compulsorily the requestedFPS parameter to 15 (only when using the front camera), to avoid the problem of the WebCamTexture image becoming low light. https://forum.unity.com/threads/android-webcamtexture-in-low-light-only-some-models.520656/ https://forum.unity.com/threads/released-opencv-for-unity.277080/page-33#post-3445178 More...
 
- Protected Member Functions inherited from OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper
virtual void OnValidate ()
 
virtual void Update ()
 
virtual IEnumerator OnApplicationFocus (bool hasFocus)
 
virtual void OnDestroy ()
 Raises the destroy event. More...
 
virtual IEnumerator _Initialize ()
 Initializes this instance by coroutine. More...
 
virtual IEnumerator hasUserAuthorizedCameraPermission ()
 Checks camera permission state by coroutine. More...
 
virtual void FlipMat (Mat mat, bool flipVertical, bool flipHorizontal)
 Flips the mat. More...
 
virtual int Channels (ColorFormat type)
 
virtual int ColorConversionCodes (ColorFormat srcType, ColorFormat dstType)
 
virtual void CancelInitCoroutine ()
 Cancel Init Coroutine. More...
 
virtual void ReleaseResources ()
 To release the resources. More...
 
- Protected Attributes inherited from OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper
string _requestedDeviceName = null
 Set the name of the camera device to use. (or device index number) More...
 
int _requestedWidth = 640
 Set the width of camera. More...
 
int _requestedHeight = 480
 Set the height of camera. More...
 
bool _requestedIsFrontFacing = false
 Set whether to use the front facing camera. More...
 
float _requestedFPS = 30f
 Set the frame rate of camera. More...
 
bool _rotate90Degree = false
 Sets whether to rotate camera frame 90 degrees. (clockwise) More...
 
bool _flipVertical = false
 Determines if flips vertically. More...
 
bool _flipHorizontal = false
 Determines if flips horizontal. More...
 
ColorFormat _outputColorFormat = ColorFormat.RGBA
 Select the output color format. More...
 
int _timeoutFrameCount = 1500
 The number of frames before the initialization process times out. More...
 
WebCamTexture webCamTexture
 The active WebcamTexture. More...
 
WebCamDevice webCamDevice
 The active WebcamDevice. More...
 
Mat frameMat
 The frame mat. More...
 
Mat baseMat
 The base mat. More...
 
Mat rotatedFrameMat
 The rotated frame mat More...
 
Color32 [] colors
 The buffer colors. More...
 
ColorFormat baseColorFormat = ColorFormat.RGBA
 The base color format. More...
 
bool isInitWaiting = false
 Indicates whether this instance is waiting for initialization to complete. More...
 
bool hasInitDone = false
 Indicates whether this instance has been initialized. More...
 
IEnumerator initCoroutine
 The initialization coroutine. More...
 
ScreenOrientation screenOrientation
 The orientation of the screen. More...
 
int screenWidth
 The width of the screen. More...
 
int screenHeight
 The height of the screen. More...
 
bool isScreenSizeChangeWaiting = false
 
- Properties inherited from OpenCVForUnity.UnityUtils.Helper.WebCamTextureToMatHelper
virtual string requestedDeviceName [get, set]
 
virtual int requestedWidth [get, set]
 
virtual int requestedHeight [get, set]
 
virtual bool requestedIsFrontFacing [get, set]
 
virtual float requestedFPS [get, set]
 
virtual bool rotate90Degree [get, set]
 
virtual bool flipVertical [get, set]
 
virtual bool flipHorizontal [get, set]
 
virtual ColorFormat outputColorFormat [get, set]
 
virtual int timeoutFrameCount [get, set]
 

Detailed Description

VideoCaptureCameraInput to mat helper. v 1.0.1 Depends on OpenCVForUnity version 2.4.4 (WebCamTextureToMatHelper v 1.1.3) or later. (Use the WebCamDevice.isFrontFacing and WebCamTexture.videoRotationAngle properties to flip the camera input image in VideoCaptue to the correct orientation.)

Member Function Documentation

◆ GetVideoCapture()

virtual VideoCapture OpenCVForUnity.UnityUtils.Helper.VideoCaptureCameraInputToMatHelper.GetVideoCapture ( )
virtual

Returns the VideoCapture instanse.

Returns
The VideoCapture instanse.

The documentation for this class was generated from the following file: