Background Configuration Functions

Functions
__STATIC_INLINE void	LL_DMA2D_BGND_SetMemAddr (DMA2D_TypeDef *DMA2Dx, uint32_t MemoryAddress)
	Set DMA2D background memory address, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetMemAddr (DMA2D_TypeDef *DMA2Dx)
	Get DMA2D background memory address, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_EnableCLUTLoad (DMA2D_TypeDef *DMA2Dx)
	Enable DMA2D background CLUT loading.
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_IsEnabledCLUTLoad (DMA2D_TypeDef *DMA2Dx)
	Indicate if DMA2D background CLUT loading is enabled.
__STATIC_INLINE void	LL_DMA2D_BGND_SetColorMode (DMA2D_TypeDef *DMA2Dx, uint32_t ColorMode)
	Set DMA2D background color mode.
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetColorMode (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background color mode.
__STATIC_INLINE void	LL_DMA2D_BGND_SetAlphaMode (DMA2D_TypeDef *DMA2Dx, uint32_t AphaMode)
	Set DMA2D background alpha mode.
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetAlphaMode (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background alpha mode.
__STATIC_INLINE void	LL_DMA2D_BGND_SetAlpha (DMA2D_TypeDef *DMA2Dx, uint32_t Alpha)
	Set DMA2D background alpha value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetAlpha (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background alpha value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetLineOffset (DMA2D_TypeDef *DMA2Dx, uint32_t LineOffset)
	Set DMA2D background line offset, expressed on 14 bits ([13:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetLineOffset (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background line offset, expressed on 14 bits ([13:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetColor (DMA2D_TypeDef *DMA2Dx, uint32_t Red, uint32_t Green, uint32_t Blue)
	Set DMA2D background color values, expressed on 24 bits ([23:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetRedColor (DMA2D_TypeDef *DMA2Dx, uint32_t Red)
	Set DMA2D background red color value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetRedColor (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background red color value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetGreenColor (DMA2D_TypeDef *DMA2Dx, uint32_t Green)
	Set DMA2D background green color value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetGreenColor (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background green color value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetBlueColor (DMA2D_TypeDef *DMA2Dx, uint32_t Blue)
	Set DMA2D background blue color value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetBlueColor (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background blue color value, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetCLUTMemAddr (DMA2D_TypeDef *DMA2Dx, uint32_t CLUTMemoryAddress)
	Set DMA2D background CLUT memory address, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetCLUTMemAddr (DMA2D_TypeDef *DMA2Dx)
	Get DMA2D background CLUT memory address, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetCLUTSize (DMA2D_TypeDef *DMA2Dx, uint32_t CLUTSize)
	Set DMA2D background CLUT size, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetCLUTSize (DMA2D_TypeDef *DMA2Dx)
	Get DMA2D background CLUT size, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE void	LL_DMA2D_BGND_SetCLUTColorMode (DMA2D_TypeDef *DMA2Dx, uint32_t CLUTColorMode)
	Set DMA2D background CLUT color mode.
__STATIC_INLINE uint32_t	LL_DMA2D_BGND_GetCLUTColorMode (DMA2D_TypeDef *DMA2Dx)
	Return DMA2D background CLUT color mode.

---

Function Documentation

__STATIC_INLINE void LL_DMA2D_BGND_EnableCLUTLoad

(

DMA2D_TypeDef *

DMA2Dx

)

Enable DMA2D background CLUT loading.

Reference Manual to LL API cross reference:

BGPFCCR START LL_DMA2D_BGND_EnableCLUTLoad

Parameters:

DMA2Dx

DMA2D Instance

Return values:

None

Definition at line 1155 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetAlpha

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background alpha value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGPFCCR ALPHA LL_DMA2D_BGND_GetAlpha

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Alpha

value between Min_Data=0 and Max_Data=0xFF

Definition at line 1263 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetAlphaMode

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background alpha mode.

Reference Manual to LL API cross reference:

BGPFCCR AM LL_DMA2D_BGND_GetAlphaMode

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Returned

value can be one of the following values: LL_DMA2D_ALPHA_MODE_NO_MODIF LL_DMA2D_ALPHA_MODE_REPLACE LL_DMA2D_ALPHA_MODE_COMBINE

Definition at line 1240 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetBlueColor

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background blue color value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGCOLR BLUE LL_DMA2D_BGND_GetBlueColor

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Blue	color value between Min_Data=0 and Max_Data=0xFF

Definition at line 1372 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetCLUTColorMode

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background CLUT color mode.

Reference Manual to LL API cross reference:

BGPFCCR CCM LL_DMA2D_BGND_GetCLUTColorMode

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Returned

value can be one of the following values: LL_DMA2D_CLUT_COLOR_MODE_ARGB8888 LL_DMA2D_CLUT_COLOR_MODE_RGB888

Definition at line 1445 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetCLUTMemAddr

(

DMA2D_TypeDef *

DMA2Dx

)

Get DMA2D background CLUT memory address, expressed on 32 bits ([31:0] bits).

Reference Manual to LL API cross reference:

BGCMAR MA LL_DMA2D_BGND_GetCLUTMemAddr

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Background

CLUT memory address value between Min_Data=0 and Max_Data=0xFFFFFFFF

Definition at line 1395 of file stm32f4xx_ll_dma2d.h.

References LL_DMA2D_ReadReg.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetCLUTSize

(

DMA2D_TypeDef *

DMA2Dx

)

Get DMA2D background CLUT size, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGPFCCR CS LL_DMA2D_BGND_GetCLUTSize

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Background

CLUT size value between Min_Data=0 and Max_Data=0xFF

Definition at line 1418 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetColorMode

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background color mode.

Reference Manual to LL API cross reference:

BGPFCCR CM LL_DMA2D_BGND_GetColorMode

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Returned

value can be one of the following values: LL_DMA2D_INPUT_MODE_ARGB8888 LL_DMA2D_INPUT_MODE_RGB888 LL_DMA2D_INPUT_MODE_RGB565 LL_DMA2D_INPUT_MODE_ARGB1555 LL_DMA2D_INPUT_MODE_ARGB4444 LL_DMA2D_INPUT_MODE_L8 LL_DMA2D_INPUT_MODE_AL44 LL_DMA2D_INPUT_MODE_AL88 LL_DMA2D_INPUT_MODE_L4 LL_DMA2D_INPUT_MODE_A8 LL_DMA2D_INPUT_MODE_A4

Definition at line 1211 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetGreenColor

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background green color value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGCOLR GREEN LL_DMA2D_BGND_GetGreenColor

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Green

color value between Min_Data=0 and Max_Data=0xFF

Definition at line 1349 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetLineOffset

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background line offset, expressed on 14 bits ([13:0] bits).

Reference Manual to LL API cross reference:

BGOR LO LL_DMA2D_BGND_GetLineOffset

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Background

line offset value between Min_Data=0 and Max_Data=0x3FF

Definition at line 1286 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetMemAddr

(

DMA2D_TypeDef *

DMA2Dx

)

Get DMA2D background memory address, expressed on 32 bits ([31:0] bits).

Reference Manual to LL API cross reference:

BGMAR MA LL_DMA2D_BGND_GetMemAddr

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Background

memory address value between Min_Data=0 and Max_Data=0xFFFFFFFF

Definition at line 1144 of file stm32f4xx_ll_dma2d.h.

References LL_DMA2D_ReadReg.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_GetRedColor

(

DMA2D_TypeDef *

DMA2Dx

)

Return DMA2D background red color value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGCOLR RED LL_DMA2D_BGND_GetRedColor

Parameters:

DMA2Dx

DMA2D Instance

Return values:

Red	color value between Min_Data=0 and Max_Data=0xFF

Definition at line 1326 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_BGND_IsEnabledCLUTLoad

(

DMA2D_TypeDef *

DMA2Dx

)

Indicate if DMA2D background CLUT loading is enabled.

Reference Manual to LL API cross reference:

BGPFCCR START LL_DMA2D_BGND_IsEnabledCLUTLoad

Parameters:

DMA2Dx

DMA2D Instance

Return values:

State

of bit (1 or 0).

Definition at line 1166 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_Init().

__STATIC_INLINE void LL_DMA2D_BGND_SetAlpha	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	Alpha
	)

Set DMA2D background alpha value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGPFCCR ALPHA LL_DMA2D_BGND_SetAlpha

Parameters:

DMA2Dx	DMA2D Instance
Alpha	Value between Min_Data=0 and Max_Data=0xFF

Return values:

None

Definition at line 1252 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetAlphaMode	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	AphaMode
	)

Set DMA2D background alpha mode.

Reference Manual to LL API cross reference:

BGPFCCR AM LL_DMA2D_BGND_SetAlphaMode

Parameters:

DMA2Dx	DMA2D Instance
AphaMode	This parameter can be one of the following values: LL_DMA2D_ALPHA_MODE_NO_MODIF LL_DMA2D_ALPHA_MODE_REPLACE LL_DMA2D_ALPHA_MODE_COMBINE

Return values:

None

Definition at line 1226 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetBlueColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	Blue
	)

Set DMA2D background blue color value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGCOLR BLUE LL_DMA2D_BGND_SetBlueColor

Parameters:

DMA2Dx	DMA2D Instance
Blue	Value between Min_Data=0 and Max_Data=0xFF

Return values:

None

Definition at line 1361 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetCLUTColorMode	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	CLUTColorMode
	)

Set DMA2D background CLUT color mode.

Reference Manual to LL API cross reference:

BGPFCCR CCM LL_DMA2D_BGND_SetCLUTColorMode

Parameters:

DMA2Dx	DMA2D Instance
CLUTColorMode	This parameter can be one of the following values: LL_DMA2D_CLUT_COLOR_MODE_ARGB8888 LL_DMA2D_CLUT_COLOR_MODE_RGB888

Return values:

None

Definition at line 1432 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetCLUTMemAddr	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	CLUTMemoryAddress
	)

Set DMA2D background CLUT memory address, expressed on 32 bits ([31:0] bits).

Reference Manual to LL API cross reference:

BGCMAR MA LL_DMA2D_BGND_SetCLUTMemAddr

Parameters:

DMA2Dx	DMA2D Instance
CLUTMemoryAddress	Value between Min_Data=0 and Max_Data=0xFFFFFFFF

Return values:

None

Definition at line 1384 of file stm32f4xx_ll_dma2d.h.

References LL_DMA2D_WriteReg.

Referenced by LL_DMA2D_ConfigLayer().

__STATIC_INLINE void LL_DMA2D_BGND_SetCLUTSize	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	CLUTSize
	)

Set DMA2D background CLUT size, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGPFCCR CS LL_DMA2D_BGND_SetCLUTSize

Parameters:

DMA2Dx	DMA2D Instance
CLUTSize	Value between Min_Data=0 and Max_Data=0xFF

Return values:

None

Definition at line 1407 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	Red,
		uint32_t	Green,
		uint32_t	Blue
	)

Set DMA2D background color values, expressed on 24 bits ([23:0] bits).

Reference Manual to LL API cross reference:

BGCOLR RED LL_DMA2D_BGND_SetColor

Reference Manual to LL API cross reference:

BGCOLR GREEN LL_DMA2D_BGND_SetColor

Reference Manual to LL API cross reference:

BGCOLR BLUE LL_DMA2D_BGND_SetColor

Parameters:

DMA2Dx	DMA2D Instance
Red	Value between Min_Data=0 and Max_Data=0xFF
Green	Value between Min_Data=0 and Max_Data=0xFF
Blue	Value between Min_Data=0 and Max_Data=0xFF

Return values:

None

Definition at line 1302 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_ConfigLayer().

__STATIC_INLINE void LL_DMA2D_BGND_SetColorMode	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	ColorMode
	)

Set DMA2D background color mode.

Reference Manual to LL API cross reference:

BGPFCCR CM LL_DMA2D_BGND_SetColorMode

Parameters:

DMA2Dx	DMA2D Instance
ColorMode	This parameter can be one of the following values: LL_DMA2D_INPUT_MODE_ARGB8888 LL_DMA2D_INPUT_MODE_RGB888 LL_DMA2D_INPUT_MODE_RGB565 LL_DMA2D_INPUT_MODE_ARGB1555 LL_DMA2D_INPUT_MODE_ARGB4444 LL_DMA2D_INPUT_MODE_L8 LL_DMA2D_INPUT_MODE_AL44 LL_DMA2D_INPUT_MODE_AL88 LL_DMA2D_INPUT_MODE_L4 LL_DMA2D_INPUT_MODE_A8 LL_DMA2D_INPUT_MODE_A4

Return values:

None

Definition at line 1189 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetGreenColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	Green
	)

Set DMA2D background green color value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGCOLR GREEN LL_DMA2D_BGND_SetGreenColor

Parameters:

DMA2Dx	DMA2D Instance
Green	Value between Min_Data=0 and Max_Data=0xFF

Return values:

None

Definition at line 1338 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_BGND_SetLineOffset	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	LineOffset
	)

Set DMA2D background line offset, expressed on 14 bits ([13:0] bits).

Reference Manual to LL API cross reference:

BGOR LO LL_DMA2D_BGND_SetLineOffset

Parameters:

DMA2Dx	DMA2D Instance
LineOffset	Value between Min_Data=0 and Max_Data=0x3FF

Return values:

None

Definition at line 1275 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_ConfigLayer().

__STATIC_INLINE void LL_DMA2D_BGND_SetMemAddr	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	MemoryAddress
	)

Set DMA2D background memory address, expressed on 32 bits ([31:0] bits).

Reference Manual to LL API cross reference:

BGMAR MA LL_DMA2D_BGND_SetMemAddr

Parameters:

DMA2Dx	DMA2D Instance
MemoryAddress	Value between Min_Data=0 and Max_Data=0xFFFFFFFF

Return values:

None

Definition at line 1133 of file stm32f4xx_ll_dma2d.h.

References LL_DMA2D_WriteReg.

Referenced by LL_DMA2D_ConfigLayer().

__STATIC_INLINE void LL_DMA2D_BGND_SetRedColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	Red
	)

Set DMA2D background red color value, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:

BGCOLR RED LL_DMA2D_BGND_SetRedColor

Parameters:

DMA2Dx	DMA2D Instance
Red	Value between Min_Data=0 and Max_Data=0xFF

Return values:

None

Definition at line 1315 of file stm32f4xx_ll_dma2d.h.