documentation

VLDetectScreenChangeBehaviour Class Reference

Inherits VLWorkerReferenceBehaviour.

Data Structures

class  Overwrite
 

Public Member Functions

delegate void OrientationChangeAction (ScreenOrientation orientation)
 
delegate void SizeChangeAction (int width, int height)
 
ScreenOrientation GetOrientation ()
 Returns the current screen orientation considering the overwrite setting. More...
 
bool SetDeviceOrientation (DeviceOrientation devOrientation)
 Sets the image rotation mode of AutoInitManager in vlSDK More...
 

Static Public Member Functions

static VLDetectScreenChangeBehaviour FindInstance (GameObject go)
 
static ScreenOrientation GetOrientation (GameObject go)
 

Data Fields

DeviceOrientation currentDeviceOrientation = DeviceOrientation.Unknown
 
Overwrite overwrite
 Settings for overwriting the screen orientation. More...
 
- Data Fields inherited from VLWorkerReferenceBehaviour
VLWorkerBehaviour workerBehaviour
 Reference to used VLWorkerBehaviour. More...
 

Events

static OrientationChangeAction OnOrientationChange
 
static SizeChangeAction OnSizeChange
 

Additional Inherited Members

- Protected Member Functions inherited from VLWorkerReferenceBehaviour
bool InitWorkerReference ()
 Initializes the workerBehaviour and worker member variables. More...
 
- Protected Attributes inherited from VLWorkerReferenceBehaviour
VLWorker worker
 

Member Function Documentation

◆ FindInstance()

static VLDetectScreenChangeBehaviour VLDetectScreenChangeBehaviour.FindInstance ( GameObject  go)
inlinestatic

◆ GetOrientation() [1/2]

static ScreenOrientation VLDetectScreenChangeBehaviour.GetOrientation ( GameObject  go)
inlinestatic

◆ GetOrientation() [2/2]

ScreenOrientation VLDetectScreenChangeBehaviour.GetOrientation ( )
inline

Returns the current screen orientation considering the overwrite setting.

Returns
Screen.orientation or overwrite.orientation depending on the overwrite.active value.

◆ OrientationChangeAction()

delegate void VLDetectScreenChangeBehaviour.OrientationChangeAction ( ScreenOrientation  orientation)

◆ SetDeviceOrientation()

bool VLDetectScreenChangeBehaviour.SetDeviceOrientation ( DeviceOrientation  devOrientation)
inline

Sets the image rotation mode of AutoInitManager in vlSDK

◆ SizeChangeAction()

delegate void VLDetectScreenChangeBehaviour.SizeChangeAction ( int  width,
int  height 
)

Field Documentation

◆ currentDeviceOrientation

DeviceOrientation VLDetectScreenChangeBehaviour.currentDeviceOrientation = DeviceOrientation.Unknown

◆ overwrite

Overwrite VLDetectScreenChangeBehaviour.overwrite

Settings for overwriting the screen orientation.

On systems without a screen orientation sensor, Unity will always report a portrait screen orientation. By activating the orientation overwrite, it's possible to simulate a different screen orientation. This allows the proper playback of iOS and Android image sequences captured in landscape mode with an "imageRecorder" configuration.

Event Documentation

◆ OnOrientationChange

OrientationChangeAction VLDetectScreenChangeBehaviour.OnOrientationChange
static

◆ OnSizeChange

SizeChangeAction VLDetectScreenChangeBehaviour.OnSizeChange
static