Peripheral Control functions

Peripheral Control functions. More...

Functions
HAL_StatusTypeDef	HAL_LTDC_ConfigLayer (LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC Layer according to the specified parameters in the LTDC_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying.
HAL_StatusTypeDef	HAL_LTDC_ConfigCLUT (LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx)
	Load the color lookup table.
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying.
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying.
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table.
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table.
HAL_StatusTypeDef	HAL_LTDC_EnableDither (LTDC_HandleTypeDef *hltdc)
	Enable Dither.
HAL_StatusTypeDef	HAL_LTDC_DisableDither (LTDC_HandleTypeDef *hltdc)
	Disable Dither.
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size.
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position.
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format.
HAL_StatusTypeDef	HAL_LTDC_SetAlpha (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value.
HAL_StatusTypeDef	HAL_LTDC_SetAddress (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address.
HAL_StatusTypeDef	HAL_LTDC_SetPitch (LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
	Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen.
HAL_StatusTypeDef	HAL_LTDC_ProgramLineEvent (LTDC_HandleTypeDef *hltdc, uint32_t Line)
	Define the position of the line interrupt.
HAL_StatusTypeDef	HAL_LTDC_Reload (LTDC_HandleTypeDef *hltdc, uint32_t ReloadType)
	Reload LTDC Layers configuration.
HAL_StatusTypeDef	HAL_LTDC_ConfigLayer_NoReload (LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC Layer according to the specified without reloading parameters in the LTDC_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetAlpha_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetAddress_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetPitch_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
	Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen.
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying without reloading.
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying without reloading.
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying without reloading.
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table without reloading.
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table without reloading.

---

Detailed Description

Peripheral Control functions.

 ===============================================================================
                    ##### Peripheral Control functions #####
 ===============================================================================  
    [..]  This section provides functions allowing to:
      (+) Configure the LTDC foreground or/and background parameters.
      (+) Set the active layer.
      (+) Configure the color keying.
      (+) Configure the C-LUT.
      (+) Enable / Disable the color keying.
      (+) Enable / Disable the C-LUT.
      (+) Update the layer position.
      (+) Update the layer size.
      (+) Update pixel format on the fly. 
      (+) Update transparency on the fly.
      (+) Update address on the fly.

---

Function Documentation

HAL_StatusTypeDef HAL_LTDC_ConfigCLUT	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t *	pCLUT,
		uint32_t	CLUTSize,
		uint32_t	LayerIdx
	)

Load the color lookup table.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
pCLUT	pointer to the color lookup table address.
CLUTSize	the color lookup table size.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 580 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_LAYER, LTDC_PIXEL_FORMAT_AL44, LTDC_LayerCfgTypeDef::PixelFormat, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	RGBValue,
		uint32_t	LayerIdx
	)

Configure the color keying.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
RGBValue	the color key value
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 542 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	RGBValue,
		uint32_t	LayerIdx
	)

Configure the color keying without reloading.

Variant of the function HAL_LTDC_ConfigColorKeying without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
RGBValue	the color key value
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1580 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_ConfigLayer	(	LTDC_HandleTypeDef *	hltdc,
		LTDC_LayerCfgTypeDef *	pLayerCfg,
		uint32_t	LayerIdx
	)

Configure the LTDC Layer according to the specified parameters in the LTDC_InitTypeDef and create the associated handle.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
pLayerCfg	pointer to a LTDC_LayerCfgTypeDef structure that contains the configuration information for the Layer.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 492 of file stm32f4xx_hal_ltdc.c.

References LTDC_LayerCfgTypeDef::Alpha, LTDC_LayerCfgTypeDef::Alpha0, assert_param, LTDC_LayerCfgTypeDef::BlendingFactor1, LTDC_LayerCfgTypeDef::BlendingFactor2, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_LayerCfgTypeDef::ImageHeight, LTDC_LayerCfgTypeDef::ImageWidth, LTDC_HandleTypeDef::Instance, IS_LTDC_ALPHA, IS_LTDC_BLENDING_FACTOR1, IS_LTDC_BLENDING_FACTOR2, IS_LTDC_CFBLL, IS_LTDC_CFBLNBR, IS_LTDC_HCONFIGSP, IS_LTDC_HCONFIGST, IS_LTDC_LAYER, IS_LTDC_PIXEL_FORMAT, IS_LTDC_VCONFIGSP, IS_LTDC_VCONFIGST, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_LayerCfgTypeDef::PixelFormat, LTDC_HandleTypeDef::State, LTDC_LayerCfgTypeDef::WindowX0, LTDC_LayerCfgTypeDef::WindowX1, LTDC_LayerCfgTypeDef::WindowY0, and LTDC_LayerCfgTypeDef::WindowY1.

HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		LTDC_LayerCfgTypeDef *	pLayerCfg,
		uint32_t	LayerIdx
	)

Configure the LTDC Layer according to the specified without reloading parameters in the LTDC_InitTypeDef and create the associated handle.

Variant of the function HAL_LTDC_ConfigLayer without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
pLayerCfg	pointer to a LTDC_LayerCfgTypeDef structure that contains the configuration information for the Layer.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1216 of file stm32f4xx_hal_ltdc.c.

References LTDC_LayerCfgTypeDef::Alpha, LTDC_LayerCfgTypeDef::Alpha0, assert_param, LTDC_LayerCfgTypeDef::BlendingFactor1, LTDC_LayerCfgTypeDef::BlendingFactor2, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_LayerCfgTypeDef::ImageHeight, LTDC_LayerCfgTypeDef::ImageWidth, IS_LTDC_ALPHA, IS_LTDC_BLENDING_FACTOR1, IS_LTDC_BLENDING_FACTOR2, IS_LTDC_CFBLL, IS_LTDC_CFBLNBR, IS_LTDC_HCONFIGSP, IS_LTDC_HCONFIGST, IS_LTDC_LAYER, IS_LTDC_PIXEL_FORMAT, IS_LTDC_VCONFIGSP, IS_LTDC_VCONFIGST, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_LayerCfgTypeDef::PixelFormat, LTDC_HandleTypeDef::State, LTDC_LayerCfgTypeDef::WindowX0, LTDC_LayerCfgTypeDef::WindowX1, LTDC_LayerCfgTypeDef::WindowY0, and LTDC_LayerCfgTypeDef::WindowY1.

HAL_StatusTypeDef HAL_LTDC_DisableCLUT	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color lookup table.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 735 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color lookup table without reloading.

Variant of the function HAL_LTDC_DisableCLUT without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1721 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_DisableColorKeying	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color keying.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 665 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Disable the color keying without reloading.

Variant of the function HAL_LTDC_DisableColorKeying without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1651 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_DisableDither

(

LTDC_HandleTypeDef *

hltdc

)

Disable Dither.

Parameters:

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values:

HAL

status

Definition at line 795 of file stm32f4xx_hal_ltdc.c.

References HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_EnableCLUT	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color lookup table.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 700 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color lookup table without reloading.

Variant of the function HAL_LTDC_EnableCLUT without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1686 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_EnableColorKeying	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color keying.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 630 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LayerIdx
	)

Enable the color keying without reloading.

Variant of the function HAL_LTDC_EnableColorKeying without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1616 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_LAYER, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_EnableDither

(

LTDC_HandleTypeDef *

hltdc

)

Enable Dither.

Parameters:

hltdc

pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.

Return values:

HAL

status

Definition at line 768 of file stm32f4xx_hal_ltdc.c.

References HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Line
	)

Define the position of the line interrupt.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Line	Line Interrupt Position.

Note:

User application may resort to HAL_LTDC_LineEventCallback() at line interrupt generation.

Return values:

HAL

status

Definition at line 1138 of file stm32f4xx_hal_ltdc.c.

References __HAL_LTDC_DISABLE_IT, __HAL_LTDC_ENABLE_IT, assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LIPOS, LTDC_IT_LI, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_Reload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	ReloadType
	)

Reload LTDC Layers configuration.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
ReloadType	This parameter can be one of the following values : LTDC_RELOAD_IMMEDIATE : Immediate Reload LTDC_RELOAD_VERTICAL_BLANKING : Reload in the next Vertical Blanking

Note:

User application may resort to HAL_LTDC_ReloadEventCallback() at reload interrupt generation.

Return values:

HAL

status

Definition at line 1177 of file stm32f4xx_hal_ltdc.c.

References __HAL_LTDC_ENABLE_IT, assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_RELOAD, LTDC_IT_RR, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetAddress	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Address,
		uint32_t	LayerIdx
	)

Reconfigure the frame buffer Address.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Address	new address value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values:

HAL

status

Definition at line 1022 of file stm32f4xx_hal_ltdc.c.

References assert_param, LTDC_LayerCfgTypeDef::FBStartAdress, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Address,
		uint32_t	LayerIdx
	)

Reconfigure the frame buffer Address without reloading.

Variant of the function HAL_LTDC_SetAddress without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Address	new address value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values:

HAL

status

Definition at line 1464 of file stm32f4xx_hal_ltdc.c.

References assert_param, LTDC_LayerCfgTypeDef::FBStartAdress, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetAlpha	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Alpha,
		uint32_t	LayerIdx
	)

Reconfigure the layer alpha value.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Alpha	new alpha value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 978 of file stm32f4xx_hal_ltdc.c.

References LTDC_LayerCfgTypeDef::Alpha, assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_ALPHA, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Alpha,
		uint32_t	LayerIdx
	)

Reconfigure the layer alpha value without reloading.

Variant of the function HAL_LTDC_SetAlpha without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Alpha	new alpha value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1419 of file stm32f4xx_hal_ltdc.c.

References LTDC_LayerCfgTypeDef::Alpha, assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_ALPHA, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetPitch	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LinePitchInPixels,
		uint32_t	LayerIdx
	)

Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen.

Example of a buffer 800x480 attached to layer for which we want to read and display on screen only a portion 320x240 taken in the center of the buffer. The pitch in pixels will be in that case 800 pixels and not 320 pixels as initially configured by previous call to HAL_LTDC_ConfigLayer().

Note:

This function should be called only after a previous call to HAL_LTDC_ConfigLayer() to modify the default pitch configured by HAL_LTDC_ConfigLayer() when required (refer to example described just above).

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LinePitchInPixels	New line pitch in pixels to configure for LTDC layer 'LayerIdx'.
LayerIdx	LTDC layer index concerned by the modification of line pitch.

Return values:

HAL

status

Definition at line 1069 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_LAYER, LTDC_PIXEL_FORMAT_AL88, LTDC_PIXEL_FORMAT_ARGB1555, LTDC_PIXEL_FORMAT_ARGB4444, LTDC_PIXEL_FORMAT_ARGB8888, LTDC_PIXEL_FORMAT_RGB565, LTDC_PIXEL_FORMAT_RGB888, LTDC_LayerCfgTypeDef::PixelFormat, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	LinePitchInPixels,
		uint32_t	LayerIdx
	)

Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen.

Example of a buffer 800x480 attached to layer for which we want to read and display on screen only a portion 320x240 taken in the center of the buffer. The pitch in pixels will be in that case 800 pixels and not 320 pixels as initially configured by previous call to HAL_LTDC_ConfigLayer().

Note:

This function should be called only after a previous call to HAL_LTDC_ConfigLayer() to modify the default pitch configured by HAL_LTDC_ConfigLayer() when required (refer to example described just above). Variant of the function HAL_LTDC_SetPitch without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
LinePitchInPixels	New line pitch in pixels to configure for LTDC layer 'LayerIdx'.
LayerIdx	LTDC layer index concerned by the modification of line pitch.

Return values:

HAL

status

Definition at line 1511 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_LAYER, LTDC_PIXEL_FORMAT_AL88, LTDC_PIXEL_FORMAT_ARGB1555, LTDC_PIXEL_FORMAT_ARGB4444, LTDC_PIXEL_FORMAT_ARGB8888, LTDC_PIXEL_FORMAT_RGB565, LTDC_PIXEL_FORMAT_RGB888, LTDC_LayerCfgTypeDef::PixelFormat, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetPixelFormat	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Pixelformat,
		uint32_t	LayerIdx
	)

Reconfigure the pixel format.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
Pixelformat	new pixel format value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values:

HAL

status

Definition at line 933 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_HandleTypeDef::Instance, IS_LTDC_LAYER, IS_LTDC_PIXEL_FORMAT, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_LayerCfgTypeDef::PixelFormat, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	Pixelformat,
		uint32_t	LayerIdx
	)

Reconfigure the pixel format without reloading.

Variant of the function HAL_LTDC_SetPixelFormat without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDfef structure that contains the configuration information for the LTDC.
Pixelformat	new pixel format value.
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).

Return values:

HAL

status

Definition at line 1374 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, IS_LTDC_LAYER, IS_LTDC_PIXEL_FORMAT, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_LayerCfgTypeDef::PixelFormat, and LTDC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_LTDC_SetWindowPosition	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	X0,
		uint32_t	Y0,
		uint32_t	LayerIdx
	)

Set the LTDC window position.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
X0	LTDC window X offset
Y0	LTDC window Y offset
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 882 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_LayerCfgTypeDef::ImageHeight, LTDC_LayerCfgTypeDef::ImageWidth, LTDC_HandleTypeDef::Instance, IS_LTDC_CFBLL, IS_LTDC_CFBLNBR, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_HandleTypeDef::State, LTDC_LayerCfgTypeDef::WindowX0, LTDC_LayerCfgTypeDef::WindowX1, LTDC_LayerCfgTypeDef::WindowY0, and LTDC_LayerCfgTypeDef::WindowY1.

HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	X0,
		uint32_t	Y0,
		uint32_t	LayerIdx
	)

Set the LTDC window position without reloading.

Variant of the function HAL_LTDC_SetWindowPosition without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
X0	LTDC window X offset
Y0	LTDC window Y offset
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1323 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_LayerCfgTypeDef::ImageHeight, LTDC_LayerCfgTypeDef::ImageWidth, IS_LTDC_CFBLL, IS_LTDC_CFBLNBR, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_HandleTypeDef::State, LTDC_LayerCfgTypeDef::WindowX0, LTDC_LayerCfgTypeDef::WindowX1, LTDC_LayerCfgTypeDef::WindowY0, and LTDC_LayerCfgTypeDef::WindowY1.

HAL_StatusTypeDef HAL_LTDC_SetWindowSize	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	XSize,
		uint32_t	YSize,
		uint32_t	LayerIdx
	)

Set the LTDC window size.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
XSize	LTDC Pixel per line
YSize	LTDC Line number
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 826 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_LayerCfgTypeDef::ImageHeight, LTDC_LayerCfgTypeDef::ImageWidth, LTDC_HandleTypeDef::Instance, IS_LTDC_CFBLL, IS_LTDC_CFBLNBR, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_HandleTypeDef::State, LTDC_LayerCfgTypeDef::WindowX0, LTDC_LayerCfgTypeDef::WindowX1, LTDC_LayerCfgTypeDef::WindowY0, and LTDC_LayerCfgTypeDef::WindowY1.

HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload	(	LTDC_HandleTypeDef *	hltdc,
		uint32_t	XSize,
		uint32_t	YSize,
		uint32_t	LayerIdx
	)

Set the LTDC window size without reloading.

Variant of the function HAL_LTDC_SetWindowSize without immediate reload.

Parameters:

hltdc	pointer to a LTDC_HandleTypeDef structure that contains the configuration information for the LTDC.
XSize	LTDC Pixel per line
YSize	LTDC Line number
LayerIdx	LTDC Layer index. This parameter can be one of the following values: LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1)

Return values:

HAL

status

Definition at line 1267 of file stm32f4xx_hal_ltdc.c.

References assert_param, HAL_LTDC_STATE_BUSY, HAL_LTDC_STATE_READY, LTDC_LayerCfgTypeDef::ImageHeight, LTDC_LayerCfgTypeDef::ImageWidth, IS_LTDC_CFBLL, IS_LTDC_CFBLNBR, IS_LTDC_LAYER, LTDC_HandleTypeDef::LayerCfg, LTDC_SetConfig(), LTDC_HandleTypeDef::State, LTDC_LayerCfgTypeDef::WindowX0, LTDC_LayerCfgTypeDef::WindowX1, LTDC_LayerCfgTypeDef::WindowY0, and LTDC_LayerCfgTypeDef::WindowY1.