Operation mode configuration for brightness control components. More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Mode_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if brightness component mode configuration is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Mode_Set (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode mode)
	Set the automatic mode for a specific brightness component.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Mode_Get (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode *mode)
	Get the current automatic mode for a specific brightness component.

Detailed Description

Operation mode configuration for brightness control components.

For ongoing adaptations the Continuous mode has to be used so that it responds to deviations from the target value. To disable the control functionality automatically once the target value has been reached, (approximately) use the Once mode.

Function Documentation

◆ peak_afl_AutoController_BrightnessComponent_Mode_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode *	mode )

Get the current automatic mode for a specific brightness component.

Retrieves the current automatic processing mode configuration for an individual brightness component within a brightness controller. This allows inspection of how different brightness adjustment mechanisms are currently configured to operate. The information is useful for understanding the controller's current behavior and for debugging brightness control performance.

Parameters

[in]	controller	Controller handle to query for brightness component mode
[in]	component	Brightness component to query. Available components include exposure time, analog gain, digital gain, and other brightness adjustment mechanisms. See peak_afl_controller_brightness_component for available options.
[out]	mode	Pointer to receive the current automatic processing mode: PEAK_AFL_CONTROLLER_AUTOMODE_OFF: Component is disabled PEAK_AFL_CONTROLLER_AUTOMODE_ONCE: One-shot adjustment mode PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS: Continuous adjustment mode See peak_afl_controller_automode for all possible values.

Returns: PEAK_AFL_STATUS_SUCCESS Brightness component mode retrieved successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle, component, or NULL mode pointer; PEAK_AFL_STATUS_NOT_SUPPORTED Component mode configuration is not supported; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Check support with peak_afl_AutoController_BrightnessComponent_Mode_IsSupported() before calling; The returned mode reflects the current active configuration for the specified component; Different components can have different modes within the same controller; Use this function to verify component mode settings after configuration

See also: peak_afl_AutoController_BrightnessComponent_Mode_IsSupported(); peak_afl_AutoController_BrightnessComponent_Mode_Set(); peak_afl_controller_brightness_component; peak_afl_controller_automode

Since: 1.2

◆ peak_afl_AutoController_BrightnessComponent_Mode_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if brightness component mode configuration is supported for a controller.

Determines whether the specified controller supports individual brightness component mode configuration. This feature allows independent control of different brightness adjustment mechanisms (such as exposure time, analog gain, digital gain) within a single brightness controller. Each component can be configured with its own automatic mode, providing fine-grained control over brightness adjustment behavior.

Parameters

[in]	controller	Controller handle to check for brightness component mode support
[out]	supported	Pointer to receive support status: PEAK_AFL_TRUE: Brightness component mode configuration is supported PEAK_AFL_FALSE: Brightness component mode configuration is not supported

Returns: PEAK_AFL_STATUS_SUCCESS Operation completed successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle or NULL supported pointer; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Check this function before attempting to configure individual component modes; This feature is typically available only for advanced brightness controllers; Component mode support may vary between different controller implementations; Available components are defined in peak_afl_controller_brightness_component

See also: peak_afl_AutoController_BrightnessComponent_Mode_Set(); peak_afl_AutoController_BrightnessComponent_Mode_Get(); peak_afl_controller_brightness_component

Since: 1.2

◆ peak_afl_AutoController_BrightnessComponent_Mode_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode	mode )

Set the automatic mode for a specific brightness component.

Configures the automatic processing mode for an individual brightness component within a brightness controller. This allows fine-grained control over how different brightness adjustment mechanisms (such as exposure time, analog gain, digital gain) operate independently. Each component can be set to different modes, enabling sophisticated brightness control strategies that prioritize certain adjustment methods over others.

Parameters

[in]	controller	Controller handle for which to set the brightness component mode
[in]	component	Brightness component to configure. Available components include exposure time, analog gain, digital gain, and other brightness adjustment mechanisms. See peak_afl_controller_brightness_component for available options.
[in]	mode	Automatic processing mode for the specified component: PEAK_AFL_CONTROLLER_AUTOMODE_OFF: Component is disabled PEAK_AFL_CONTROLLER_AUTOMODE_ONCE: One-shot adjustment PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS: Continuous adjustment See peak_afl_controller_automode for complete list.

Returns: PEAK_AFL_STATUS_SUCCESS Brightness component mode configured successfully; PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized; PEAK_AFL_STATUS_INVALID_PARAMETER Invalid controller handle, component, or mode; PEAK_AFL_STATUS_NOT_SUPPORTED Component mode configuration is not supported; PEAK_AFL_STATUS_ERROR An unexpected internal error occurred

Note: Check support with peak_afl_AutoController_BrightnessComponent_Mode_IsSupported() before using; Component mode changes take effect for subsequent image processing operations; Different components can have different modes for sophisticated control strategies; This feature is typically available only for advanced brightness controllers

See also: peak_afl_AutoController_BrightnessComponent_Mode_IsSupported(); peak_afl_AutoController_BrightnessComponent_Mode_Get(); peak_afl_controller_brightness_component; peak_afl_controller_automode

Since: 1.2

Functions

Detailed Description

Function Documentation

◆ peak_afl_AutoController_BrightnessComponent_Mode_Get()

◆ peak_afl_AutoController_BrightnessComponent_Mode_IsSupported()

◆ peak_afl_AutoController_BrightnessComponent_Mode_Set()