Color related APIs

This group describes the Color related APIs. More...

Functions
int	ADL2_Display_Color_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iColorType, int *lpCurrent, int *lpDefault, int *lpMin, int *lpMax, int *lpStep)
	Function to retrieve the detailed information a specified display color item. More...
int	ADL2_Display_Color_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iColorType, int iCurrent)
	Function to set the current value of a specific color and type. More...
int	ADL2_Display_ColorCaps_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpCaps, int *lpValids)
	Function to get the Color Caps display information. More...
int	ADL2_Display_ColorTemperatureSource_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpTempSource)
	Function to get color temperature source. More...
int	ADL2_Display_ColorTemperatureSource_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iTempSource)
	Function to set the color temperature source. More...
int	ADL2_Display_ColorTemperatureSourceDefault_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpTempSourceDefault)
	Function to get default color temperature source. More...
int	ADL2_Display_Gamut_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGamutReference gamut, ADLGamutInfo *lpCap)
int	ADL2_Display_Gamut_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGamutReference gamut, ADLGamutData *lpSource)
int	ADL2_Display_Gamut_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLGamutReference gamut, const ADLGamutData *lpSource)
int	ADL_Display_Color_Get (int iAdapterIndex, int iDisplayIndex, int iColorType, int *lpCurrent, int *lpDefault, int *lpMin, int *lpMax, int *lpStep)
	Function to retrieve the detailed information a specified display color item. More...
int	ADL_Display_Color_Set (int iAdapterIndex, int iDisplayIndex, int iColorType, int iCurrent)
	Function to set the current value of a specific color and type. More...
int	ADL_Display_ColorCaps_Get (int iAdapterIndex, int iDisplayIndex, int *lpCaps, int *lpValids)
	Function to get the Color Caps display information. More...
int	ADL_Display_ColorTemperatureSource_Get (int iAdapterIndex, int iDisplayIndex, int *lpTempSource)
	Function to get color temperature source. More...
int	ADL_Display_ColorTemperatureSource_Set (int iAdapterIndex, int iDisplayIndex, int iTempSource)
	Function to set the color temperature source. More...
int	ADL_Display_Gamut_Caps (int iAdapterIndex, int iDisplayIndex, ADLGamutReference gamut, ADLGamutInfo *lpCap)
int	ADL_Display_Gamut_Get (int iAdapterIndex, int iDisplayIndex, ADLGamutReference gamut, ADLGamutData *lpSource)
	Function to get the current ADLGamutData setting for the display. This function get the ADLGamutData setting for a specified display. More...
int	ADL_Display_Gamut_Set (int iAdapterIndex, int iDisplayIndex, ADLGamutReference gamut, const ADLGamutData *lpSource)

Detailed Description

This group describes the Color related APIs.

Function Documentation

ADL2_Display_Color_Get()

int ADL2_Display_Color_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int	iColorType,
		int *	lpCurrent,
		int *	lpDefault,
		int *	lpMin,
		int *	lpMax,
		int *	lpStep
	)

Function to retrieve the detailed information a specified display color item.

This function retrieves the detailed information for a specified display color.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iColorType	The desired color type. It can be any of the defined type. Display Color Type and Source
[out]	lpCurrent	The pointer to the current color value.
[out]	lpDefault	The pointer to the default color value.
[out]	lpMin	The pointer to the minimum color value.
[out]	lpMax	The pointer to the maximum color value.
[out]	lpStep	The pointer to the increment of the color setting.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

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_Display_Color_Set()

int ADL2_Display_Color_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int	iColorType,
		int	iCurrent
	)

Function to set the current value of a specific color and type.

This function sets the display color for a specified adapter, display, and color type.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iColorType	The desired color type. It can be any of the defined type. Display Color Type and Source
[in]	iCurrent	The desired color value.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

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_Display_ColorCaps_Get()

int ADL2_Display_ColorCaps_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpCaps,
		int *	lpValids
	)

Function to get the Color Caps display information.

This function retrieves the display Color Caps information for a specified adapter and 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. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpCaps	The pointer to the Color Caps information retrieved from the driver. Display Color Type and Source
[out]	lpValids	The pointer to the bit vector indicating which bit is valid on the lpCaps returned.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

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_Display_ColorTemperatureSource_Get()

int ADL2_Display_ColorTemperatureSource_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpTempSource
	)

Function to get color temperature source.

This function retrieves the current color temperature source.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpTempSource	The pointer of the retrieved current color temperature source. Display Color Type and Source

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

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_Display_ColorTemperatureSource_Set()

int ADL2_Display_ColorTemperatureSource_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int	iTempSource
	)

Function to set the color temperature source.

This function sets the current color temperature source.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iTempSource	The desired color temperature source. Display Color Type and Source

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

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_Display_ColorTemperatureSourceDefault_Get()

int ADL2_Display_ColorTemperatureSourceDefault_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpTempSourceDefault
	)

Function to get default color temperature source.

This function retrieves the default color temperature source.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpTempSourceDefault	The pointer of the retrieved default color temperature source. Display Color Type and Source

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

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_Display_Gamut_Caps()

int ADL2_Display_Gamut_Caps	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGamutReference	gamut,
		ADLGamutInfo *	lpCap
	)

Function to get the current ADLGamutInfo setting for the display. This function get the ADLGamutInfo setting 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 index of the desired adapter.
[in]	iDisplayIndex	The index of the desired display.
[in]	gamut	The gamut reference - whether it is related to graphics or video, source or destination
[out]	ADLGamutInfo	driver supplies the mask of supported gamut spaces and white points, driver supports this feature from NI ASIC.

Returns

If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

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_Display_Gamut_Get()

int ADL2_Display_Gamut_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGamutReference	gamut,
		ADLGamutData *	lpSource
	)

Function to get the current ADLGamutData setting for the display. This function get the ADLGamutData setting 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 index of the desired adapter.
[in]	iDisplayIndex	The index of the desired display.
[in]	gamut	. The gamut reference - whether it is related to graphics or video, source or destination
[out]	ADLGamutData	driver supplies the currently used gamut, driver supports this feature from NI ASIC.

Returns

If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

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_Display_Gamut_Set()

int ADL2_Display_Gamut_Set	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGamutReference	gamut,
		const ADLGamutData *	lpSource
	)

Function to set the current ADLGamutData setting for the display. This function sets the ADLGamutData setting 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 index of the desired adapter.
[in]	iDisplayIndex	The index of the desired display.
[in]	gamut	The gamut reference - whether it is related to graphics or video, source or destination
[in]	ADLGamutData	to be set, the method sets the new gamut or saves the requested gamut if the current destination if gamut from EDID.

Returns

If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

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_Display_Color_Get()

int ADL_Display_Color_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int	iColorType,
		int *	lpCurrent,
		int *	lpDefault,
		int *	lpMin,
		int *	lpMax,
		int *	lpStep
	)

Function to retrieve the detailed information a specified display color item.

This function retrieves the detailed information for a specified display color.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iColorType	The desired color type. It can be any of the defined type. Display Color Type and Source
[out]	lpCurrent	The pointer to the current color value.
[out]	lpDefault	The pointer to the default color value.
[out]	lpMin	The pointer to the minimum color value.
[out]	lpMax	The pointer to the maximum color value.
[out]	lpStep	The pointer to the increment of the color setting.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

ADL_Display_Color_Set()

int ADL_Display_Color_Set	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int	iColorType,
		int	iCurrent
	)

Function to set the current value of a specific color and type.

This function sets the display color for a specified adapter, display, and color type.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iColorType	The desired color type. It can be any of the defined type. Display Color Type and Source
[in]	iCurrent	The desired color value.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

ADL_Display_ColorCaps_Get()

int ADL_Display_ColorCaps_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpCaps,
		int *	lpValids
	)

Function to get the Color Caps display information.

This function retrieves the display Color Caps information for a specified adapter and 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. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpCaps	The pointer to the Color Caps information retrieved from the driver. Display Color Type and Source
[out]	lpValids	The pointer to the bit vector indicating which bit is valid on the lpCaps returned.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

ADL_Display_ColorTemperatureSource_Get()

int ADL_Display_ColorTemperatureSource_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpTempSource
	)

Function to get color temperature source.

This function retrieves the current color temperature source.

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. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpTempSource	The pointer of the retrieved current color temperature source. Display Color Type and Source

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

ADL_Display_ColorTemperatureSource_Set()

int ADL_Display_ColorTemperatureSource_Set	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int	iTempSource
	)

Function to set the color temperature source.

This function sets the current color temperature source.

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. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iTempSource	The desired color temperature source. Display Color Type and Source

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

ADL_Display_Gamut_Caps()

int ADL_Display_Gamut_Caps	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGamutReference	gamut,
		ADLGamutInfo *	lpCap
	)

Function to get the current ADLGamutInfo setting for the display. This function get the ADLGamutInfo setting for a specified display.

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The index of the desired adapter.
[in]	iDisplayIndex	The index of the desired display.
[in]	gamut	The gamut reference - whether it is related to graphics or video, source or destination
[out]	ADLGamutInfo	driver supplies the mask of supported gamut spaces and white points, driver supports this feature from NI ASIC.

Returns

If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

ADL_Display_Gamut_Get()

int ADL_Display_Gamut_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGamutReference	gamut,
		ADLGamutData *	lpSource
	)

Function to get the current ADLGamutData setting for the display. This function get the ADLGamutData setting for a specified display.

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The index of the desired adapter.
[in]	iDisplayIndex	The index of the desired display.
[in]	gamut	. The gamut reference - whether it is related to graphics or video, source or destination
[out]	ADLGamutData	driver supplies the currently used gamut, driver supports this feature from NI ASIC.

Returns

If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

ADL_Display_Gamut_Set()

int ADL_Display_Gamut_Set	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLGamutReference	gamut,
		const ADLGamutData *	lpSource
	)

Function to set the current ADLGamutData setting for the display. This function sets the ADLGamutData setting for a specified display.

Supported Platforms:

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

Parameters

[in]	iAdapterIndex	The index of the desired adapter.
[in]	iDisplayIndex	The index of the desired display.
[in]	gamut	The gamut reference - whether it is related to graphics or video, source or destination
[in]	ADLGamutData	to be set, the method sets the new gamut or saves the requested gamut if the current destination if gamut from EDID.

Returns

If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes