stm32f4xx_hal_ltdc.h File Reference

Header file of LTDC HAL module. More...

Go to the source code of this file.

Data Structures
struct	LTDC_ColorTypeDef
	LTDC color structure definition. More...
struct	LTDC_InitTypeDef
	LTDC Init structure definition. More...
struct	LTDC_LayerCfgTypeDef
	LTDC Layer structure definition. More...
struct	endif
	ADC handle Structure definition. More...

Typedefs
typedef struct __LTDC_HandleTypeDef else typedef struct endif	LTDC_HandleTypeDef
	LTDC handle Structure definition.
typedef void(*	pLTDC_CallbackTypeDef) (LTDC_HandleTypeDef *hltdc)
	HAL LTDC Callback pointer definition. More...

Enumerations
enum	HAL_LTDC_StateTypeDef {   HAL_LTDC_STATE_RESET = 0x00U , HAL_LTDC_STATE_READY = 0x01U , HAL_LTDC_STATE_BUSY = 0x02U , HAL_LTDC_STATE_TIMEOUT = 0x03U ,   HAL_LTDC_STATE_ERROR = 0x04U }
	HAL LTDC State structures definition. More...
enum	HAL_LTDC_CallbackIDTypeDef {   HAL_LTDC_MSPINIT_CB_ID = 0x00U , HAL_LTDC_MSPDEINIT_CB_ID = 0x01U , HAL_LTDC_LINE_EVENT_CB_ID = 0x02U , HAL_LTDC_RELOAD_EVENT_CB_ID = 0x03U ,   HAL_LTDC_ERROR_CB_ID = 0x04U }
	HAL LTDC Callback ID enumeration definition. More...

Functions
HAL_StatusTypeDef	HAL_LTDC_Init (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC according to the specified parameters in the LTDC_InitTypeDef. More...
HAL_StatusTypeDef	HAL_LTDC_DeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC peripheral. More...
void	HAL_LTDC_MspInit (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC MSP. More...
void	HAL_LTDC_MspDeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC MSP. More...
void	HAL_LTDC_ErrorCallback (LTDC_HandleTypeDef *hltdc)
	Error LTDC callback. More...
void	HAL_LTDC_LineEventCallback (LTDC_HandleTypeDef *hltdc)
	Line Event callback. More...
void	HAL_LTDC_ReloadEventCallback (LTDC_HandleTypeDef *hltdc)
	Reload Event callback. More...
HAL_StatusTypeDef	HAL_LTDC_RegisterCallback (LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID, pLTDC_CallbackTypeDef pCallback)
	Register a User LTDC Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_LTDC_UnRegisterCallback (LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID)
	Unregister an LTDC Callback LTDC callback is redirected to the weak predefined callback. More...
void	HAL_LTDC_IRQHandler (LTDC_HandleTypeDef *hltdc)
	Handle LTDC interrupt request. More...
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. More...
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size. More...
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position. More...
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format. More...
HAL_StatusTypeDef	HAL_LTDC_SetAlpha (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value. More...
HAL_StatusTypeDef	HAL_LTDC_SetAddress (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address. More...
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(). More...
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying. More...
HAL_StatusTypeDef	HAL_LTDC_ConfigCLUT (LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx)
	Load the color lookup table. More...
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying. More...
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying. More...
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table. More...
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table. More...
HAL_StatusTypeDef	HAL_LTDC_ProgramLineEvent (LTDC_HandleTypeDef *hltdc, uint32_t Line)
	Define the position of the line interrupt. More...
HAL_StatusTypeDef	HAL_LTDC_EnableDither (LTDC_HandleTypeDef *hltdc)
	Enable Dither. More...
HAL_StatusTypeDef	HAL_LTDC_DisableDither (LTDC_HandleTypeDef *hltdc)
	Disable Dither. More...
HAL_StatusTypeDef	HAL_LTDC_Reload (LTDC_HandleTypeDef *hltdc, uint32_t ReloadType)
	Reload LTDC Layers configuration. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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(). More...
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. More...
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. More...
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. More...
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. More...
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. More...
HAL_LTDC_StateTypeDef	HAL_LTDC_GetState (LTDC_HandleTypeDef *hltdc)
	Return the LTDC handle state. More...
uint32_t	HAL_LTDC_GetError (LTDC_HandleTypeDef *hltdc)
	Return the LTDC handle error code. More...

Detailed Description

Header file of LTDC HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_ltdc.h.