This group describes the Framelock Genlock APIs. More...

Functions
int	ADL2_FRTCPro_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported)

int	ADL2_FRTCPro_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_FRTCPRO_Settings *FRTCPROSettings)

int	ADL2_FRTCPro_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_FRTCPRO_Settings FRTCPROSettings, ADL_FRTCPRO_CHANGED_REASON changeReason)

int	ADL2_Workstation_DisplayGenlockCapable_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpCanGenlock)
	Function to determine whether or not a display is capable of Genlock functionality. More...

int	ADL2_Workstation_DisplayGLSyncMode_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGlSyncMode *lpGlSyncMode)
	Function to retrieve the GL-Sync mode for a display. More...

int	ADL2_Workstation_DisplayGLSyncMode_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGlSyncMode glSyncMode)
	Function to set the GL-Sync mode for a display. More...

int	ADL2_Workstation_GLSyncGenlockConfiguration_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iGlSyncConnector, int iGlValidMask, ADLGLSyncGenlockConfig *lpGlSyncGenlockConfig)
	Function to retrieve the GL-Sync Genlock configuration settings. More...

int	ADL2_Workstation_GLSyncGenlockConfiguration_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iGlSyncConnector, ADLGLSyncGenlockConfig glSyncGenlockConfig)
	Function to set the GL-Sync Genlock configuration settings. More...

int	ADL2_Workstation_GLSyncModuleDetect_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iGlSyncConnector, ADLGLSyncModuleID *lpGlSyncModuleID)
	Function to detect the GL-Sync module. More...

int	ADL2_Workstation_GLSyncModuleInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iGlSyncConnector, int lpNumGLSyncGPUPorts, int lpNumGlSyncPorts, int lpMaxSyncDelay, int lpMaxSampleRate, ADLGLSyncPortCaps **ppGlSyncPorts)
	Function to describe the GL-Sync module caps. More...

int	ADL2_Workstation_GLSyncPortState_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iGlSyncConnector, int iGlSyncPortType, int iNumLEDs, ADLGlSyncPortInfo lpGlSyncPortInfo, int *ppGlSyncLEDs)
	Function to retrieve GL-Sync port information. More...

int	ADL2_Workstation_GLSyncPortState_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iGlSyncConnector, ADLGlSyncPortControl glSyncPortControl)
	Function to perform GL-Sync port control. More...

int	ADL2_Workstation_GLSyncSupportedTopology_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iNumSyncModes, ADLGlSyncMode2 glSyncModes, int iNumSugSyncModes, ADLGlSyncMode2 **glSugSyncModes)
	Function to get the supported GL-Sync topology. More...

int	ADL_Workstation_DisplayGenlockCapable_Get (int iAdapterIndex, int iDisplayIndex, int *lpCanGenlock)
	Function to determine whether or not a display is capable of Genlock functionality. More...

int	ADL_Workstation_DisplayGLSyncMode_Get (int iAdapterIndex, int iDisplayIndex, ADLGlSyncMode *lpGlSyncMode)
	Function to retrieve the GL-Sync mode for a display. More...

int	ADL_Workstation_DisplayGLSyncMode_Set (int iAdapterIndex, int iDisplayIndex, ADLGlSyncMode glSyncMode)
	Function to set the GL-Sync mode for a display. More...

int	ADL_Workstation_GLSyncGenlockConfiguration_Get (int iAdapterIndex, int iGlSyncConnector, int iGlValidMask, ADLGLSyncGenlockConfig *lpGlSyncGenlockConfig)
	Function to retrieve the GL-Sync Genlock configuration settings. More...

int	ADL_Workstation_GLSyncGenlockConfiguration_Set (int iAdapterIndex, int iGlSyncConnector, ADLGLSyncGenlockConfig glSyncGenlockConfig)
	Function to set the GL-Sync Genlock configuration settings. More...

int	ADL_Workstation_GLSyncModuleDetect_Get (int iAdapterIndex, int iGlSyncConnector, ADLGLSyncModuleID *lpGlSyncModuleID)
	Function to detect the GL-Sync module. More...

int	ADL_Workstation_GLSyncModuleInfo_Get (int iAdapterIndex, int iGlSyncConnector, int lpNumGLSyncGPUPorts, int lpNumGlSyncPorts, int lpMaxSyncDelay, int lpMaxSampleRate, ADLGLSyncPortCaps **ppGlSyncPorts)
	Function to describe the GL-Sync module caps. More...

int	ADL_Workstation_GLSyncPortState_Get (int iAdapterIndex, int iGlSyncConnector, int iGlSyncPortType, int iNumLEDs, ADLGlSyncPortInfo lpGlSyncPortInfo, int *ppGlSyncLEDs)
	Function to retrieve GL-Sync port information. More...

int	ADL_Workstation_GLSyncPortState_Set (int iAdapterIndex, int iGlSyncConnector, ADLGlSyncPortControl glSyncPortControl)
	Function to perform GL-Sync port control. More...

int	ADL_Workstation_GLSyncSupportedTopology_Get (int iAdapterIndex, int iNumSyncModes, ADLGlSyncMode2 glSyncModes, int iNumSugSyncModes, ADLGlSyncMode2 **glSugSyncModes)
	Function to get the supported GL-Sync topology. More...

Detailed Description

This group describes the Framelock Genlock APIs.

Function Documentation

◆ ADL2_FRTCPro_Caps()

int ADL2_FRTCPro_Caps	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int *	lpSupported
	)

Function to get FRTCPRO caps

This Function to get FRTCPRO caps.

Supported Platforms:: Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	context	: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	: The ADL index handle of the desired adapter.
[out]	lpSupported	: The value indicating the FRTCPRO Feature support state.

◆ ADL2_FRTCPro_Settings_Get()

int ADL2_FRTCPro_Settings_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADL_FRTCPRO_Settings *	FRTCPROSettings
	)

Function to get FRTCPRO setting

This function is to get FRTCPRO Setting.

Supported Platforms:: Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	context	: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	: The ADL index handle of the desired adapter.
[out]	FRTCPROSettings	: The structure indicating capability of the FRTCPRO Feature status,enable/disable,default value.

◆ ADL2_FRTCPro_Settings_Set()

int ADL2_FRTCPro_Settings_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		ADL_FRTCPRO_Settings	FRTCPROSettings,
		ADL_FRTCPRO_CHANGED_REASON	changeReason
	)

Function to set FRTCPRO Setting

This function set FRTCPRO Setting.

Supported Platforms:: Windows 7, 10 and above; 32bit and 64bit

Parameters

[in]	context	: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	: The ADL index handle of the desired adapter.
[in]	FRTCPROSettings	: The structure indicating capability of the FRTCPRO Feature status,enable/disable,default value.
[in]	changeReason	: The structure indicating reason of the FRTCPRO Feature status changed.

◆ ADL2_Workstation_DisplayGenlockCapable_Get()

int ADL2_Workstation_DisplayGenlockCapable_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpCanGenlock
	)

Function to determine whether or not a display is capable of Genlock functionality.

This function determines whether a specified display can be used for Framelock/Genlock.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index, which can be retrieved from the ADLDisplayInfo data structure.
[out]	lpCanGenlock	The pointer to the retrieved Genlock capabilities. 1: the display is Genlock-capable; 0: the display is not Genlock-capable.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_DisplayGLSyncMode_Get()

int ADL2_Workstation_DisplayGLSyncMode_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGlSyncMode *	lpGlSyncMode
	)

Function to retrieve the GL-Sync mode for a display.

This function implements the DI call to retrieve the GL-Sync mode for a specified display.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index.
[out]	lpGlSyncMode	The pointer to the ADLGlSyncMode structure storing the GL-Sync mode of the specified display.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_DisplayGLSyncMode_Set()

int ADL2_Workstation_DisplayGLSyncMode_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGlSyncMode	glSyncMode
	)

Function to set the GL-Sync mode for a display.

This function implements the DI call to set the GL-Sync mode for a specified display.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index.
[in]	glSyncMode	The ADLGlSyncMode structure describing the GL-Sync mode to set for the specified display.

Returns: If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncGenlockConfiguration_Get()

int ADL2_Workstation_GLSyncGenlockConfiguration_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iGlSyncConnector,
		int	iGlValidMask,
		ADLGLSyncGenlockConfig *	lpGlSyncGenlockConfig
	)

Function to retrieve the GL-Sync Genlock configuration settings.

This function retrieves the Genlock configuration settings of a specific GPU connector on a GL-Sync module attached to a specified adapter on a GL-Sync connector.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	iGlValidMask	The mask indicating the Genlock settings to be retrieved (bit field of ADL_GLSYNC_CONFIGMASK_*). Genlock related values
[out]	lpGlSyncGenlockConfig	The pointer to the ADLGLSyncGenlockConfig structure with the retrieved Genlock settings.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncGenlockConfiguration_Set()

int ADL2_Workstation_GLSyncGenlockConfiguration_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iGlSyncConnector,
		ADLGLSyncGenlockConfig	glSyncGenlockConfig
	)

Function to set the GL-Sync Genlock configuration settings.

This function sets the Genlock configuration settings of a specific GPU connector on a GL-Sync module attached to a specified adapter on a GL-Sync connector.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	glSyncGenlockConfig	The Genlock settings to be set in ADLGLSyncGenlockConfig structure

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncModuleDetect_Get()

int ADL2_Workstation_GLSyncModuleDetect_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iGlSyncConnector,
		ADLGLSyncModuleID *	lpGlSyncModuleID
	)

Function to detect the GL-Sync module.

This function detects the GL-Sync module attached to a specified adapter and GL-Sync connector.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[out]	lpGlSyncModuleID	The pointer to the retrieved GL-Sync module information. If no GL-Sync module is attached, lpGlSyncModuleID->ulModuleID is set to 0.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncModuleInfo_Get()

int ADL2_Workstation_GLSyncModuleInfo_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iGlSyncConnector,
		int *	lpNumGLSyncGPUPorts,
		int *	lpNumGlSyncPorts,
		int *	lpMaxSyncDelay,
		int *	lpMaxSampleRate,
		ADLGLSyncPortCaps **	ppGlSyncPorts
	)

Function to describe the GL-Sync module caps.

This function describes the hardware capabilities of the GL-Sync module attached to a specific adapter and GL-Sync connector.
This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by ppGlSyncPorts. Caller is responsible to de-alocate the memory.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[out]	lpNumGLSyncGPUPorts	The pointer to the number of GPU ports on the specified GL-Sync module.
[out]	lpNumGlSyncPorts	The pointer to the number of external ports (RJ45/BNC) on the specified GL-Sync module.
[out]	lpMaxSyncDelay	The pointer to the maximum value of the sync delay Genlock setting.
[out]	lpMaxSampleRate	The pointer to the maximum value of the sample rate Genlock setting.
[out]	ppGlSyncPorts	The pointer to the pointer to the retrieved information about the external ports on the specified GL-Sync connector. The user passes a memory allocation callback to allocate memory for this and to free the memory once done with it.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncPortState_Get()

int ADL2_Workstation_GLSyncPortState_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iGlSyncConnector,
		int	iGlSyncPortType,
		int	iNumLEDs,
		ADLGlSyncPortInfo *	lpGlSyncPortInfo,
		int **	ppGlSyncLEDs
	)

Function to retrieve GL-Sync port information.

This function implements the DI call to retrieve the information about a GL-Sync port of a specified GL-Sync module and adapter. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by ppGlSyncLEDs. Caller is responsible to de-alocate the memory.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	iGlSyncPortType	The desired GL-Sync port (ADL_GLSYNC_PORT_*). Genlock related values
[in]	iNumLEDs	The number of LEDs for the specified port. If the number of LEDs is unknown, specify a value of 0.
[out]	lpGlSyncPortInfo	The pointer to the retrieved port information in ADLGlSyncPortInfo structure
[out]	ppGlSyncLEDs	The pointer to the pointer to the retrieved information about the LEDs associated to the specified GL-Sync connector. The user must pass a memory allocation callback to allocate memory for this and to free the memory once done with it.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncPortState_Set()

int ADL2_Workstation_GLSyncPortState_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iGlSyncConnector,
		ADLGlSyncPortControl	glSyncPortControl
	)

Function to perform GL-Sync port control.

This function implements the DI call to enable or disable an output signal on the RJ-45 ports of a specified GL-Sync module and adapter.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	glSyncPortControl	The ADLGlSyncPortControl structure to be set.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_Workstation_GLSyncSupportedTopology_Get()

int ADL2_Workstation_GLSyncSupportedTopology_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iNumSyncModes,
		ADLGlSyncMode2 *	glSyncModes,
		int *	iNumSugSyncModes,
		ADLGlSyncMode2 **	glSugSyncModes
	)

Function to get the supported GL-Sync topology.

This function implements the DI call to set the GL-Sync mode for a specified display.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	context	Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iNumSyncModes
[in]	glSyncModes
[out]	iNumSugSyncModes
[out]	glSugSyncModes

Returns: If the function is successful, ADL_OK is returned.
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Remarks: Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL_Workstation_DisplayGenlockCapable_Get()

int ADL_Workstation_DisplayGenlockCapable_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpCanGenlock
	)

Function to determine whether or not a display is capable of Genlock functionality.

This function determines whether a specified display can be used for Framelock/Genlock.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index, which can be retrieved from the ADLDisplayInfo data structure.
[out]	lpCanGenlock	The pointer to the retrieved Genlock capabilities. 1: the display is Genlock-capable; 0: the display is not Genlock-capable.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_DisplayGLSyncMode_Get()

int ADL_Workstation_DisplayGLSyncMode_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGlSyncMode *	lpGlSyncMode
	)

Function to retrieve the GL-Sync mode for a display.

This function implements the DI call to retrieve the GL-Sync mode for a specified display.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index.
[out]	lpGlSyncMode	The pointer to the ADLGlSyncMode structure storing the GL-Sync mode of the specified display.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_DisplayGLSyncMode_Set()

int ADL_Workstation_DisplayGLSyncMode_Set	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGlSyncMode	glSyncMode
	)

Function to set the GL-Sync mode for a display.

This function implements the DI call to set the GL-Sync mode for a specified display.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index.
[in]	glSyncMode	The ADLGlSyncMode structure describing the GL-Sync mode to set for the specified display.

Returns: If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncGenlockConfiguration_Get()

int ADL_Workstation_GLSyncGenlockConfiguration_Get	(	int	iAdapterIndex,
		int	iGlSyncConnector,
		int	iGlValidMask,
		ADLGLSyncGenlockConfig *	lpGlSyncGenlockConfig
	)

Function to retrieve the GL-Sync Genlock configuration settings.

This function retrieves the Genlock configuration settings of a specific GPU connector on a GL-Sync module attached to a specified adapter on a GL-Sync connector.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	iGlValidMask	The mask indicating the Genlock settings to be retrieved (bit field of ADL_GLSYNC_CONFIGMASK_*). Genlock related values
[out]	lpGlSyncGenlockConfig	The pointer to the ADLGLSyncGenlockConfig structure with the retrieved Genlock settings.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncGenlockConfiguration_Set()

int ADL_Workstation_GLSyncGenlockConfiguration_Set	(	int	iAdapterIndex,
		int	iGlSyncConnector,
		ADLGLSyncGenlockConfig	glSyncGenlockConfig
	)

Function to set the GL-Sync Genlock configuration settings.

This function sets the Genlock configuration settings of a specific GPU connector on a GL-Sync module attached to a specified adapter on a GL-Sync connector.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	glSyncGenlockConfig	The Genlock settings to be set in ADLGLSyncGenlockConfig structure

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncModuleDetect_Get()

int ADL_Workstation_GLSyncModuleDetect_Get	(	int	iAdapterIndex,
		int	iGlSyncConnector,
		ADLGLSyncModuleID *	lpGlSyncModuleID
	)

Function to detect the GL-Sync module.

This function detects the GL-Sync module attached to a specified adapter and GL-Sync connector.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[out]	lpGlSyncModuleID	The pointer to the retrieved GL-Sync module information. If no GL-Sync module is attached, lpGlSyncModuleID->ulModuleID is set to 0.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncModuleInfo_Get()

int ADL_Workstation_GLSyncModuleInfo_Get	(	int	iAdapterIndex,
		int	iGlSyncConnector,
		int *	lpNumGLSyncGPUPorts,
		int *	lpNumGlSyncPorts,
		int *	lpMaxSyncDelay,
		int *	lpMaxSampleRate,
		ADLGLSyncPortCaps **	ppGlSyncPorts
	)

Function to describe the GL-Sync module caps.

This function describes the hardware capabilities of the GL-Sync module attached to a specific adapter and GL-Sync connector.
This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by ppGlSyncPorts. Caller is responsible to de-alocate the memory.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[out]	lpNumGLSyncGPUPorts	The pointer to the number of GPU ports on the specified GL-Sync module.
[out]	lpNumGlSyncPorts	The pointer to the number of external ports (RJ45/BNC) on the specified GL-Sync module.
[out]	lpMaxSyncDelay	The pointer to the maximum value of the sync delay Genlock setting.
[out]	lpMaxSampleRate	The pointer to the maximum value of the sample rate Genlock setting.
[out]	ppGlSyncPorts	The pointer to the pointer to the retrieved information about the external ports on the specified GL-Sync connector. The user passes a memory allocation callback to allocate memory for this and to free the memory once done with it.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncPortState_Get()

int ADL_Workstation_GLSyncPortState_Get	(	int	iAdapterIndex,
		int	iGlSyncConnector,
		int	iGlSyncPortType,
		int	iNumLEDs,
		ADLGlSyncPortInfo *	lpGlSyncPortInfo,
		int **	ppGlSyncLEDs
	)

Function to retrieve GL-Sync port information.

This function implements the DI call to retrieve the information about a GL-Sync port of a specified GL-Sync module and adapter. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by ppGlSyncLEDs. Caller is responsible to de-alocate the memory.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	iGlSyncPortType	The desired GL-Sync port (ADL_GLSYNC_PORT_*). Genlock related values
[in]	iNumLEDs	The number of LEDs for the specified port. If the number of LEDs is unknown, specify a value of 0.
[out]	lpGlSyncPortInfo	The pointer to the retrieved port information in ADLGlSyncPortInfo structure
[out]	ppGlSyncLEDs	The pointer to the pointer to the retrieved information about the LEDs associated to the specified GL-Sync connector. The user must pass a memory allocation callback to allocate memory for this and to free the memory once done with it.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncPortState_Set()

int ADL_Workstation_GLSyncPortState_Set	(	int	iAdapterIndex,
		int	iGlSyncConnector,
		ADLGlSyncPortControl	glSyncPortControl
	)

Function to perform GL-Sync port control.

This function implements the DI call to enable or disable an output signal on the RJ-45 ports of a specified GL-Sync module and adapter.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iGlSyncConnector	The index of the desired GL-Sync connector. The index can range from 0 to NumOfGLSyncConnectors - 1.
[in]	glSyncPortControl	The ADLGlSyncPortControl structure to be set.

Returns: If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GLSyncSupportedTopology_Get()

int ADL_Workstation_GLSyncSupportedTopology_Get	(	int	iAdapterIndex,
		int	iNumSyncModes,
		ADLGlSyncMode2 *	glSyncModes,
		int *	iNumSugSyncModes,
		ADLGlSyncMode2 **	glSugSyncModes
	)

Function to get the supported GL-Sync topology.

This function implements the DI call to set the GL-Sync mode for a specified display.

Supported Platforms:: Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iNumSyncModes
[in]	glSyncModes
[out]	iNumSugSyncModes
[out]	glSugSyncModes

Returns: If the function is successful, ADL_OK is returned.
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

Functions

Detailed Description

Function Documentation

◆ ADL2_FRTCPro_Caps()

◆ ADL2_FRTCPro_Settings_Get()

◆ ADL2_FRTCPro_Settings_Set()

◆ ADL2_Workstation_DisplayGenlockCapable_Get()

◆ ADL2_Workstation_DisplayGLSyncMode_Get()

◆ ADL2_Workstation_DisplayGLSyncMode_Set()

◆ ADL2_Workstation_GLSyncGenlockConfiguration_Get()

◆ ADL2_Workstation_GLSyncGenlockConfiguration_Set()

◆ ADL2_Workstation_GLSyncModuleDetect_Get()

◆ ADL2_Workstation_GLSyncModuleInfo_Get()

◆ ADL2_Workstation_GLSyncPortState_Get()

◆ ADL2_Workstation_GLSyncPortState_Set()

◆ ADL2_Workstation_GLSyncSupportedTopology_Get()

◆ ADL_Workstation_DisplayGenlockCapable_Get()

◆ ADL_Workstation_DisplayGLSyncMode_Get()

◆ ADL_Workstation_DisplayGLSyncMode_Set()

◆ ADL_Workstation_GLSyncGenlockConfiguration_Get()

◆ ADL_Workstation_GLSyncGenlockConfiguration_Set()

◆ ADL_Workstation_GLSyncModuleDetect_Get()

◆ ADL_Workstation_GLSyncModuleInfo_Get()

◆ ADL_Workstation_GLSyncPortState_Get()

◆ ADL_Workstation_GLSyncPortState_Set()

◆ ADL_Workstation_GLSyncSupportedTopology_Get()