HAL_LTDC_SetPitch() function

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

Syntax

from stm32f4xx_hal_ltdc.h:593

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

Implemented in stm32f4xx_hal_ltdc.c:1411

Arguments

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 value

HAL status

Notes

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).

Examples

HAL_LTDC_SetPitch() is referenced by 25 libraries and example projects.

References

Location	Text
stm32f4xx_hal_ltdc.c:1411	HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
stm32f4xx_hal_ltdc.h:593	HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);