OCULUS Scol plugin
 All Classes Functions Groups Pages
Functions
Scol functions definition

Functions

int _CRoculusDevice (mmachine m)
 _CRoculusDevice : This function create a OCULUS object
int _DSoculusDevice (mmachine m)
 _DSoculusDevice : Destroy OCULUS object
int _GetOculusOrientation (mmachine m)
 _GetOculusOrientation : Get the OCULUS Rift sensor orientation
int _GetOculusPredictedOrientation (mmachine m)
 _GetOculusPredictedOrientation : Get the OCULUS Rift sensor predicted orientation
int _GetOculusYawPitchRoll (mmachine m)
 _GetOculusYawPitchRoll : Get the OCULUS Rift sensor Yaw Pitch and Roll
int _GetOculusPredictedYawPitchRoll (mmachine m)
 _GetOculusPredictedYawPitchRoll : Get the OCULUS Rift sensor predicted Yaw Pitch and Roll
int _GetOculusAcceleration (mmachine m)
 _GetOculusAcceleration : Get the OCULUS Rift sensor acceleration
int _GetOculusPosition (mmachine m)
 _GetOculusPosition : Get the OCULUS Rift position from the IR camera
int _GetOculusStereoConfig (mmachine m)
 _GetOculusStereoConfig : Get the OCULUS Rift stereo configuration !!! Deprecated !!! return default values
int _GetOculusAspectRatio (mmachine m)
 _GetOculusAspectRatio : Get the OCULUS Rift camera aspect ratio
int _GetOculusIPD (mmachine m)
 _GetOculusIPD : Get the OCULUS Rift eye spacing
int _GetOculusFovY (mmachine m)
 _GetOculusFovY : Get the OCULUS Rift eye spacing
int _ResetOculusDevice (mmachine m)
 _ResetOculusDevice : Reset OCULUS Rift sensor
int _UpdateOculusLatency (mmachine m)
 _UpdateOculusLatency : update OCULUS Rift latency for a better result call this on each render frame !!! Deprecated !!! use _UpdateOculus to update oculus data each frame
int _StartUpdateOculus (mmachine m)
 _StartUpdateOculus : start OCULUS Rift update you should call this on each render frame
int _EndUpdateOculus (mmachine m)
 _EndUpdateOculus : end OCULUS Rift update you should call this on each render frame
int _SetOculusLowPersistance (mmachine m)
 _SetOculusLowPersistance : Set the oculus low persistance mode
int _GetOculusLowPersistance (mmachine m)
 _GetOculusLowPersistance : Get the oculus low persistance mode
int _GetOculusDeviceType (mmachine m)
 _GetOculusDeviceType : Get the oculus device type
int _GetOculusProjectionMatrix (mmachine m)
 _GetOculusProjectionMatrix : Get the OCULUS Rift camera projection matrix
int _GetOculusTimeWarpMatrix (mmachine m)
 _GetOculusTimeWarpMatrix : Get the OCULUS Rift time warp matrix
int _GetOculusFovTextureSize (mmachine m)
 _GetOculusFovTextureSize : Get the OCULUS Rift texture size for RTT
int _GetOculusUvConfig (mmachine m)
 _GetOculusUvConfig : Get the OCULUS Rift UV texture offsets and scale
int _GetOculusDeformationMeshes (mmachine m)
 _GetOculusDeformationMeshes : Get the OCULUS Rift deformation meshes
int _GetOculusWindowSetting (mmachine m)
 _GetOculusWindowSetting : Get the OCULUS Rift window setting

Detailed Description

Scol functions definition

Function Documentation

int _CRoculusDevice ( mmachine  m)

_CRoculusDevice : This function create a OCULUS object

Prototype: fun [Chn fun [ObjOculus u0] u1 u0 fun [ObjOculus u2] u3 u2] ObjOculus

Parameters
Chn: channel
fun[ObjOculus u0] u1 : callback on connected
u0: connected callback parameter
fun[ObjOculus u2] u3 : callback on disconnected
u2: disconnected callback parameter
Returns
ObjOculus : the OCULUS object if success, NIL otherwise

Definition at line 100 of file scolplugin.cpp.

int _DSoculusDevice ( mmachine  m)

_DSoculusDevice : Destroy OCULUS object

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object to destroy
Returns
I : 0 if success, NIL otherwise

Definition at line 171 of file scolplugin.cpp.

int _EndUpdateOculus ( mmachine  m)

_EndUpdateOculus : end OCULUS Rift update you should call this on each render frame

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object
Returns
I : 0 if success, NIL otherwise

Definition at line 744 of file scolplugin.cpp.

int _GetOculusAcceleration ( mmachine  m)

_GetOculusAcceleration : Get the OCULUS Rift sensor acceleration

fun [ObjOculus] [F F F]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F] : the acceleration if success, NIL otherwise

Definition at line 386 of file scolplugin.cpp.

int _GetOculusAspectRatio ( mmachine  m)

_GetOculusAspectRatio : Get the OCULUS Rift camera aspect ratio

fun [ObjOculus] F

Parameters
ObjOculus: OCULUS Object
Returns
F : Aspect ratio on success, NIL otherwise

Definition at line 552 of file scolplugin.cpp.

int _GetOculusDeformationMeshes ( mmachine  m)

_GetOculusDeformationMeshes : Get the OCULUS Rift deformation meshes

fun [ObjOculus] [[[[[F F F] [[F F] r1] F F] r1] [I r1]] [[[[F F F] [[F F] r1] F F] r1] [I r1]]]

Parameters
ObjOculus: OCULUS Object
Returns
[[[[[F F F] [[F F] r1] F F] r1] [I r1]] [[[[F F F] [[F F] r1] F F] r1] [I r1]]] : the left and right meshes components if success, NIL otherwise

Definition at line 1346 of file scolplugin.cpp.

int _GetOculusDeviceType ( mmachine  m)

_GetOculusDeviceType : Get the oculus device type

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object
Returns
I : 0 none, 3 DK1, 4 DKHD, 6 DK2, NIL otherwise

Definition at line 846 of file scolplugin.cpp.

int _GetOculusFovTextureSize ( mmachine  m)

_GetOculusFovTextureSize : Get the OCULUS Rift texture size for RTT

fun [ObjOculus] [[I I] [I I]]

Parameters
ObjOculus: OCULUS Object
Returns
[[I I] [I I]] : the left and right texture size if success, NIL otherwise

Definition at line 1210 of file scolplugin.cpp.

int _GetOculusFovY ( mmachine  m)

_GetOculusFovY : Get the OCULUS Rift eye spacing

fun [ObjOculus] F

Parameters
ObjOculus: OCULUS Object
Returns
F : FovY on success, NIL otherwise

Definition at line 622 of file scolplugin.cpp.

int _GetOculusIPD ( mmachine  m)

_GetOculusIPD : Get the OCULUS Rift eye spacing

fun [ObjOculus] F

Parameters
ObjOculus: OCULUS Object
Returns
F : IPD on success, NIL otherwise

Definition at line 587 of file scolplugin.cpp.

int _GetOculusLowPersistance ( mmachine  m)

_GetOculusLowPersistance : Get the oculus low persistance mode

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object
Returns
I : 1 if low persistance enabled, 0 to disabled, NIL otherwise

Definition at line 815 of file scolplugin.cpp.

int _GetOculusOrientation ( mmachine  m)

_GetOculusOrientation : Get the OCULUS Rift sensor orientation

fun [ObjOculus] [F F F F]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F F] : the orientation quaternion if success, NIL otherwise

Definition at line 200 of file scolplugin.cpp.

int _GetOculusPosition ( mmachine  m)

_GetOculusPosition : Get the OCULUS Rift position from the IR camera

fun [ObjOculus] [F F F]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F] : the position if success, NIL otherwise

Definition at line 432 of file scolplugin.cpp.

int _GetOculusPredictedOrientation ( mmachine  m)

_GetOculusPredictedOrientation : Get the OCULUS Rift sensor predicted orientation

fun [ObjOculus] [F F F F]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F F] : the orientation quaternion if success, NIL otherwise

Definition at line 247 of file scolplugin.cpp.

int _GetOculusPredictedYawPitchRoll ( mmachine  m)

_GetOculusPredictedYawPitchRoll : Get the OCULUS Rift sensor predicted Yaw Pitch and Roll

fun [ObjOculus] [F F F]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F] : the orientation in the order Yaw Pitch Roll if success, NIL otherwise

Definition at line 340 of file scolplugin.cpp.

int _GetOculusProjectionMatrix ( mmachine  m)

_GetOculusProjectionMatrix : Get the OCULUS Rift camera projection matrix

fun [ObjOculus F F] [[[F F F F] [F F F F] [F F F F] [F F F F]] [[F F F F] [F F F F] [F F F F] [F F F F]]]

Parameters
ObjOculus: OCULUS Object
F: Camera near clip
F: Camera far clip
Returns
[[[F F F F] [F F F F] [F F F F] [F F F F]] [[F F F F] [F F F F] [F F F F] [F F F F]]] : the left and right projection matrix if success, NIL otherwise

Definition at line 879 of file scolplugin.cpp.

int _GetOculusStereoConfig ( mmachine  m)

_GetOculusStereoConfig : Get the OCULUS Rift stereo configuration !!! Deprecated !!! return default values

fun [ObjOculus] [F F F F F [F F F F] [F F F F]]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F F F [F F F F] [F F F F]] : proj center, IPD, Aspect, eye to screen dist, fovY, distorsion, chroma correction, NIL otherwise

Definition at line 479 of file scolplugin.cpp.

int _GetOculusTimeWarpMatrix ( mmachine  m)

_GetOculusTimeWarpMatrix : Get the OCULUS Rift time warp matrix

fun [ObjOculus] [[[F F F F] [F F F F] [F F F F] [F F F F]] [[F F F F] [F F F F] [F F F F] [F F F F]] [[F F F F] [F F F F] [F F F F] [F F F F]] [[F F F F] [F F F F] [F F F F] [F F F F]]]

Parameters
ObjOculus: OCULUS Object
Returns
[[[F F F F] [F F F F] [F F F F] [F F F F]] [[F F F F] [F F F F] [F F F F] [F F F F]]] : the left and right time warp matrix if success, NIL otherwise

Definition at line 1001 of file scolplugin.cpp.

int _GetOculusUvConfig ( mmachine  m)

_GetOculusUvConfig : Get the OCULUS Rift UV texture offsets and scale

fun [ObjOculus [I I] [I I]] [[F F] [F F] [F F] [F F]]

Parameters
ObjOculus: OCULUS Object
[II] : left texture size
[II] : right texture size
Returns
[[F F] [F F] [F F] [F F]] : the left and right uv offset and scale size if success, NIL otherwise

Definition at line 1267 of file scolplugin.cpp.

int _GetOculusWindowSetting ( mmachine  m)

_GetOculusWindowSetting : Get the OCULUS Rift window setting

fun [ObjOculus] [[I I] [I I] I]

Parameters
ObjOculus: OCULUS Object
Returns
[[I I] [I I] I] : the window position and size followed by the monitor index if success, NIL otherwise

Definition at line 1618 of file scolplugin.cpp.

int _GetOculusYawPitchRoll ( mmachine  m)

_GetOculusYawPitchRoll : Get the OCULUS Rift sensor Yaw Pitch and Roll

fun [ObjOculus] [F F F]

Parameters
ObjOculus: OCULUS Object
Returns
[F F F] : the orientation in the order Yaw Pitch Roll if success, NIL otherwise

Definition at line 294 of file scolplugin.cpp.

int _ResetOculusDevice ( mmachine  m)

_ResetOculusDevice : Reset OCULUS Rift sensor

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object
Returns
I : 0 if success, NIL otherwise

Definition at line 657 of file scolplugin.cpp.

int _SetOculusLowPersistance ( mmachine  m)

_SetOculusLowPersistance : Set the oculus low persistance mode

fun [ObjOculus I] I

Parameters
ObjOculus: OCULUS Object
I: 1 to enable low persistance, 0 to disable
Returns
I : 0 if success, NIL otherwise

Definition at line 777 of file scolplugin.cpp.

int _StartUpdateOculus ( mmachine  m)

_StartUpdateOculus : start OCULUS Rift update you should call this on each render frame

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object
Returns
I : 1 if updated 0 if not, NIL otherwise

Definition at line 712 of file scolplugin.cpp.

int _UpdateOculusLatency ( mmachine  m)

_UpdateOculusLatency : update OCULUS Rift latency for a better result call this on each render frame !!! Deprecated !!! use _UpdateOculus to update oculus data each frame

fun [ObjOculus] I

Parameters
ObjOculus: OCULUS Object
Returns
I : 0 if success, NIL otherwise

Definition at line 695 of file scolplugin.cpp.

Generated on Mon Jan 5 2015 21:44:03 for OCULUS Scol plugin by   doxygen 1.8.1.2