Raytrix Light Field SDK  5.0
Rx::LFR::Net::LightFieldRuntime Class Reference

Detailed Description

Provides methods for authenticating with the Light Field Runtime and for querying LFR parameters.

Static Public Member Functions

static void Authenticate ()
 Authenticates the attached USB dongle with the Light Field Runtime. More...
 
static void Decode (RX_OUT unsigned % uOutKey1, RX_OUT unsigned % uOutKey2, unsigned uInKey1, unsigned uInKey2)
 Decodes both given input keys into the given output keys using the USB dongle. More...
 
static void End ()
 Finalizes the Light Field Runtime. Frees the memory used by this class. Finalizes also the Cuda device but does not finalize other classes. More...
 
static void GetApplicationDetails (System::String^ sAppName, System::String^ sAppVersion)
 Gets application name and version. More...
 
static void GetDongleIDs (RX_OUT int % iDongleID, RX_OUT int % iRaytrixID)
 Get the IDs of the attached dongle. More...
 
static System::Object ^ GetInterface (Interfaces::ELightFieldRuntime eData)
 Gets the interface defined by Interfaces::ELightFieldRuntime. More...
 
static System::DateTime GetReleaseDate ()
 Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date. More...
 
static void GetReleaseDate (RX_OUT int % iDay, RX_OUT int % iMonth, RX_OUT int % iYear)
 Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date. More...
 
static bool IsAuthenticated ()
 Queries if a USB dongle is authenticated with the Light Field Runtime. More...
 
static bool IsFeatureSupported (Rx::Net::ERuntimeFeature eFeatureID)
 Queries if the given feature is supported by your dongle. Returns always false if called before Authenticate. More...
 
static bool IsFeatureSupported (unsigned uFeatureIDs)
 Queries if the given features are supported by your dongle. Returns always false if called before Authenticate. More...
 
static void SetApplicationDetails (System::String^ sAppName, System::String^ sAppVersion)
 Sets the app name and version. More...
 

Member Function Documentation

◆ Authenticate()

static void Rx::LFR::Net::LightFieldRuntime::Authenticate ( )
inlinestatic

Authenticates the attached USB dongle with the Light Field Runtime.

An exception is thrown in the following cases:

  • There is no USB dongle attached to the system.
  • This version of the Light Field Runtime is not supported by the dongle license.
  • The dongle license does not include the SDK feature.

◆ Decode()

static void Rx::LFR::Net::LightFieldRuntime::Decode ( RX_OUT unsigned %  uOutKey1,
RX_OUT unsigned %  uOutKey2,
unsigned  uInKey1,
unsigned  uInKey2 
)
inlinestatic

Decodes both given input keys into the given output keys using the USB dongle.

Parameters
uOutKey1[out] The first output key.
uOutKey2[out] The second output key.
uInKey1[in] The first input key.
uInKey2[in] The second input key.

◆ End()

static void Rx::LFR::Net::LightFieldRuntime::End ( )
inlinestatic

Finalizes the Light Field Runtime. Frees the memory used by this class. Finalizes also the Cuda device but does not finalize other classes.

This function is NOT called automatically. You have to call this method at the end of you application.

◆ GetApplicationDetails()

static void Rx::LFR::Net::LightFieldRuntime::GetApplicationDetails ( System::String^  sAppName,
System::String^  sAppVersion 
)
inlinestatic

Gets application name and version.

Parameters
sAppName[out] Name of the application.
sAppVersion[out] The application version.

◆ GetDongleIDs()

static void Rx::LFR::Net::LightFieldRuntime::GetDongleIDs ( RX_OUT int %  iDongleID,
RX_OUT int %  iRaytrixID 
)
inlinestatic

Get the IDs of the attached dongle.

Parameters
iDongleID[Out] The hardware dongle ID.
iRaytrixID[Out] The Raytrix dongle ID.

◆ GetInterface()

static System::Object ^ Rx::LFR::Net::LightFieldRuntime::GetInterface ( Interfaces::ELightFieldRuntime  eData)
inlinestatic

Gets the interface defined by Interfaces::ELightFieldRuntime.

Parameters
eData[in] The interface type.
Returns
Null if it fails, else the interface.

◆ GetReleaseDate() [1/2]

static System::DateTime Rx::LFR::Net::LightFieldRuntime::GetReleaseDate ( )
inlinestatic

Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date.

Returns
The release date.

◆ GetReleaseDate() [2/2]

static void Rx::LFR::Net::LightFieldRuntime::GetReleaseDate ( RX_OUT int %  iDay,
RX_OUT int %  iMonth,
RX_OUT int %  iYear 
)
inlinestatic

Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date.

Parameters
iDay[out] The release day.
iMonth[out] The release month.
iYear[out] The release year.

◆ IsAuthenticated()

static bool Rx::LFR::Net::LightFieldRuntime::IsAuthenticated ( )
inlinestatic

Queries if a USB dongle is authenticated with the Light Field Runtime.

Returns
True if authenticated, false if not.

◆ IsFeatureSupported() [1/2]

static bool Rx::LFR::Net::LightFieldRuntime::IsFeatureSupported ( Rx::Net::ERuntimeFeature  eFeatureID)
inlinestatic

Queries if the given feature is supported by your dongle. Returns always false if called before Authenticate.

Parameters
eFeatureIDThe feature ID to query.
Returns
True if the feature is supported, false if not.

◆ IsFeatureSupported() [2/2]

static bool Rx::LFR::Net::LightFieldRuntime::IsFeatureSupported ( unsigned  uFeatureIDs)
inlinestatic

Queries if the given features are supported by your dongle. Returns always false if called before Authenticate.

Parameters
uFeatureIDs[in] A OR-ed list of Rx::Net::ERuntimeFeature to query.
Returns
True if all features are supported, false if not.

◆ SetApplicationDetails()

static void Rx::LFR::Net::LightFieldRuntime::SetApplicationDetails ( System::String^  sAppName,
System::String^  sAppVersion 
)
inlinestatic

Sets the app name and version.

Parameters
sAppName[in] Name of the sx application.
sAppVersion[in] The application version.