Detailed Description

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

Inherits Rx::LFR::CPimpl< CLightFieldRuntime_Impl, Interfaces::ELightFieldRuntime::ID >.

Public Member Functions
CLightFieldRuntime_Impl &	GetImpl ()
	Gets the non constant implementation. More...

const CLightFieldRuntime_Impl &	GetImpl () const
	Gets the constant implementation. More...

const void *	GetInterface (Interfaces::ELightFieldRuntime::ID eInterface) const
	Gets the interface defined by the given interface ID. More...

bool	HasInterface (Interfaces::ELightFieldRuntime::ID eInterface)
	Queries if this object has the given interface. More...

Static Public Member Functions
static void	Authenticate (void *pvData=nullptr)
	Authenticates the attached USB dongle with the Light Field Runtime. More...

static void	Decode (unsigned &uOutKey1, 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 (CRxString &sxAppName, CRxString &sxAppVersion)
	Gets application details. More...

static void	GetDongleIDs (int &iDongleID, int &iRaytrixID)
	Get the IDs of the attached dongle. More...

static void *	GetInterface (Interfaces::ELightFieldRuntime::ID eData)
	Gets the interface defined by ELightFieldRuntimeInterface. More...

static void	GetReleaseDate (int &iDay, int &iMonth, 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 (Dongle::ERuntimeFeature::ID 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 (const CRxString &sxAppName, const CRxString &sxAppVersion)
	Sets application details. More...

Member Function Documentation

◆ Authenticate()

static void Rx::LFR::CLightFieldRuntime::Authenticate ( void * pvData = nullptr )

static

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.

Parameters

pvData [in] (Optional) Pointer to internal data. The passed pointer is stored in this class and must be available for the lifetime of this class and is deleted by calling End. Should be null.

◆ Decode()

static void Rx::LFR::CLightFieldRuntime::Decode	(	unsigned &	uOutKey1,
		unsigned &	uOutKey2,
		unsigned	uInKey1,
		unsigned	uInKey2
	)

static

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::CLightFieldRuntime::End ( )

static

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 your application.

◆ GetApplicationDetails()

static void Rx::LFR::CLightFieldRuntime::GetApplicationDetails	(	CRxString &	sxAppName,
		CRxString &	sxAppVersion
	)

static

Gets application details.

Parameters

sxAppName	[out] Name of the application.
sxAppVersion	[out] The application version.

◆ GetDongleIDs()

static void Rx::LFR::CLightFieldRuntime::GetDongleIDs	(	int &	iDongleID,
		int &	iRaytrixID
	)

static

Get the IDs of the attached dongle.

Parameters

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

◆ GetImpl() [1/2]

CLightFieldRuntime_Impl & Rx::LFR::CPimpl< CLightFieldRuntime_Impl , Interfaces::ELightFieldRuntime::ID >::GetImpl

inlineinherited

Gets the non constant implementation.

Returns: The implementation.

◆ GetImpl() [2/2]

const CLightFieldRuntime_Impl & Rx::LFR::CPimpl< CLightFieldRuntime_Impl , Interfaces::ELightFieldRuntime::ID >::GetImpl

inlineinherited

Gets the constant implementation.

Returns: The implementation.

◆ GetInterface() [1/2]

static void* Rx::LFR::CLightFieldRuntime::GetInterface ( Interfaces::ELightFieldRuntime::ID eData )

static

Gets the interface defined by ELightFieldRuntimeInterface.

Parameters

eData [in] The interface type.

Returns: Null if it fails, else the interface.

◆ GetInterface() [2/2]

const void* Rx::LFR::CPimpl< CLightFieldRuntime_Impl , Interfaces::ELightFieldRuntime::ID >::GetInterface ( Interfaces::ELightFieldRuntime::ID eInterface ) const

inherited

Gets the interface defined by the given interface ID.

Parameters

eInterface [in] The interface ID.

Returns: Null if it fails, else the interface.

◆ GetReleaseDate()

static void Rx::LFR::CLightFieldRuntime::GetReleaseDate	(	int &	iDay,
		int &	iMonth,
		int &	iYear
	)

static

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.

◆ HasInterface()

bool Rx::LFR::CPimpl< CLightFieldRuntime_Impl , Interfaces::ELightFieldRuntime::ID >::HasInterface ( Interfaces::ELightFieldRuntime::ID eInterface )

inlineinherited

Queries if this object has the given interface.

Parameters

eInterface [in] The interface to query.

Returns: True if this class has the given interface, false if not.

◆ IsAuthenticated()

static bool Rx::LFR::CLightFieldRuntime::IsAuthenticated ( )

static

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::CLightFieldRuntime::IsFeatureSupported ( Dongle::ERuntimeFeature::ID eFeatureID )

static

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

Parameters

eFeatureID [in] The feature ID to query.

Returns: True if the feature is supported, false if not.

◆ IsFeatureSupported() [2/2]

static bool Rx::LFR::CLightFieldRuntime::IsFeatureSupported ( unsigned uFeatureIDs )

static

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 Dongle::ERuntimeFeature::ID to query.

Returns: True if all features are supported, false if not.

◆ SetApplicationDetails()

static void Rx::LFR::CLightFieldRuntime::SetApplicationDetails	(	const CRxString &	sxAppName,
		const CRxString &	sxAppVersion
	)

static

Sets application details.

Parameters

sxAppName	[in] Name of the application.
sxAppVersion	[in] The application version.

Detailed Description

Public Member Functions

Static Public Member Functions

Member Function Documentation

◆ Authenticate()

◆ Decode()

◆ End()

◆ GetApplicationDetails()

◆ GetDongleIDs()

◆ GetImpl() [1/2]

◆ GetImpl() [2/2]

◆ GetInterface() [1/2]

◆ GetInterface() [2/2]

◆ GetReleaseDate()

◆ HasInterface()

◆ IsAuthenticated()

◆ IsFeatureSupported() [1/2]

◆ IsFeatureSupported() [2/2]

◆ SetApplicationDetails()