STM32F4xx_HAL_Driver  1.8.3
DMA2D Exported Types
+ Collaboration diagram for DMA2D Exported Types:

Data Structures

struct  DMA2D_CLUTCfgTypeDef
 DMA2D CLUT Structure definition. More...
 
struct  DMA2D_InitTypeDef
 DMA2D Init structure definition. More...
 
struct  DMA2D_LayerCfgTypeDef
 DMA2D Layer structure definition. More...
 
struct  __DMA2D_HandleTypeDef
 DMA2D handle Structure definition. More...
 

Typedefs

typedef struct __DMA2D_HandleTypeDef DMA2D_HandleTypeDef
 DMA2D handle Structure definition.
 
typedef void(* pDMA2D_CallbackTypeDef) (DMA2D_HandleTypeDef *hdma2d)
 HAL DMA2D Callback pointer definition. More...
 

Enumerations

enum  HAL_DMA2D_StateTypeDef {
  HAL_DMA2D_STATE_RESET = 0x00U , HAL_DMA2D_STATE_READY = 0x01U , HAL_DMA2D_STATE_BUSY = 0x02U , HAL_DMA2D_STATE_TIMEOUT = 0x03U ,
  HAL_DMA2D_STATE_ERROR = 0x04U , HAL_DMA2D_STATE_SUSPEND = 0x05U
}
 HAL DMA2D State structures definition. More...
 

Detailed Description


Data Structure Documentation

◆ DMA2D_CLUTCfgTypeDef

struct DMA2D_CLUTCfgTypeDef

DMA2D CLUT Structure definition.

Definition at line 50 of file stm32f4xx_hal_dma2d.h.

Data Fields
uint32_t CLUTColorMode

Configures the DMA2D CLUT color mode. This parameter can be one value of DMA2D CLUT Color Mode.

uint32_t * pCLUT

Configures the DMA2D CLUT memory address.

uint32_t Size

Configures the DMA2D CLUT size. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF.

◆ DMA2D_InitTypeDef

struct DMA2D_InitTypeDef

DMA2D Init structure definition.

Definition at line 64 of file stm32f4xx_hal_dma2d.h.

Data Fields
uint32_t ColorMode

Configures the color format of the output image. This parameter can be one value of DMA2D Output Color Mode.

uint32_t Mode

Configures the DMA2D transfer mode. This parameter can be one value of DMA2D Mode.

uint32_t OutputOffset

Specifies the Offset value. This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x3FFF.

◆ DMA2D_LayerCfgTypeDef

struct DMA2D_LayerCfgTypeDef

DMA2D Layer structure definition.

Definition at line 85 of file stm32f4xx_hal_dma2d.h.

Data Fields
uint32_t AlphaMode

Configures the DMA2D foreground or background alpha mode. This parameter can be one value of DMA2D Alpha Mode.

uint32_t InputAlpha

Specifies the DMA2D foreground or background alpha value and color value in case of A8 or A4 color mode. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF except for the color modes detailed below.

Note
In case of A8 or A4 color mode (ARGB), this parameter must be a number between Min_Data = 0x00000000 and Max_Data = 0xFFFFFFFF where
  • InputAlpha[24:31] is the alpha value ALPHA[0:7]
  • InputAlpha[16:23] is the red value RED[0:7]
  • InputAlpha[8:15] is the green value GREEN[0:7]
  • InputAlpha[0:7] is the blue value BLUE[0:7].
uint32_t InputColorMode

Configures the DMA2D foreground or background color mode. This parameter can be one value of DMA2D Input Color Mode.

uint32_t InputOffset

Configures the DMA2D foreground or background offset. This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x3FFF.

◆ __DMA2D_HandleTypeDef

struct __DMA2D_HandleTypeDef

DMA2D handle Structure definition.

Definition at line 128 of file stm32f4xx_hal_dma2d.h.

+ Collaboration diagram for __DMA2D_HandleTypeDef:

Data Fields

DMA2D_TypeDef * Instance
 
DMA2D_InitTypeDef Init
 
void(* XferCpltCallback )(struct __DMA2D_HandleTypeDef *hdma2d)
 
void(* XferErrorCallback )(struct __DMA2D_HandleTypeDef *hdma2d)
 
void(* LineEventCallback )(struct __DMA2D_HandleTypeDef *hdma2d)
 
void(* CLUTLoadingCpltCallback )(struct __DMA2D_HandleTypeDef *hdma2d)
 
void(* MspInitCallback )(struct __DMA2D_HandleTypeDef *hdma2d)
 
void(* MspDeInitCallback )(struct __DMA2D_HandleTypeDef *hdma2d)
 
DMA2D_LayerCfgTypeDef LayerCfg [MAX_DMA2D_LAYER]
 
HAL_LockTypeDef Lock
 
__IO HAL_DMA2D_StateTypeDef State
 
__IO uint32_t ErrorCode
 

Field Documentation

◆ CLUTLoadingCpltCallback

void(* __DMA2D_HandleTypeDef::CLUTLoadingCpltCallback) (struct __DMA2D_HandleTypeDef *hdma2d)

DMA2D CLUT loading completion callback

Definition at line 141 of file stm32f4xx_hal_dma2d.h.

◆ ErrorCode

__IO uint32_t __DMA2D_HandleTypeDef::ErrorCode

DMA2D error code.

Definition at line 155 of file stm32f4xx_hal_dma2d.h.

◆ Init

DMA2D_InitTypeDef __DMA2D_HandleTypeDef::Init

DMA2D communication parameters.

Definition at line 132 of file stm32f4xx_hal_dma2d.h.

◆ Instance

DMA2D_TypeDef* __DMA2D_HandleTypeDef::Instance

DMA2D register base address.

Definition at line 130 of file stm32f4xx_hal_dma2d.h.

◆ LayerCfg

DMA2D_LayerCfgTypeDef __DMA2D_HandleTypeDef::LayerCfg[MAX_DMA2D_LAYER]

DMA2D Layers parameters

Definition at line 149 of file stm32f4xx_hal_dma2d.h.

◆ LineEventCallback

void(* __DMA2D_HandleTypeDef::LineEventCallback) (struct __DMA2D_HandleTypeDef *hdma2d)

DMA2D line event callback.

Definition at line 139 of file stm32f4xx_hal_dma2d.h.

◆ Lock

HAL_LockTypeDef __DMA2D_HandleTypeDef::Lock

DMA2D lock.

Definition at line 151 of file stm32f4xx_hal_dma2d.h.

◆ MspDeInitCallback

void(* __DMA2D_HandleTypeDef::MspDeInitCallback) (struct __DMA2D_HandleTypeDef *hdma2d)

DMA2D Msp DeInit callback.

Definition at line 145 of file stm32f4xx_hal_dma2d.h.

◆ MspInitCallback

void(* __DMA2D_HandleTypeDef::MspInitCallback) (struct __DMA2D_HandleTypeDef *hdma2d)

DMA2D Msp Init callback.

Definition at line 143 of file stm32f4xx_hal_dma2d.h.

◆ State

__IO HAL_DMA2D_StateTypeDef __DMA2D_HandleTypeDef::State

DMA2D transfer state.

Definition at line 153 of file stm32f4xx_hal_dma2d.h.

◆ XferCpltCallback

void(* __DMA2D_HandleTypeDef::XferCpltCallback) (struct __DMA2D_HandleTypeDef *hdma2d)

DMA2D transfer complete callback.

Definition at line 134 of file stm32f4xx_hal_dma2d.h.

◆ XferErrorCallback

void(* __DMA2D_HandleTypeDef::XferErrorCallback) (struct __DMA2D_HandleTypeDef *hdma2d)

DMA2D transfer error callback.

Definition at line 136 of file stm32f4xx_hal_dma2d.h.

Typedef Documentation

◆ pDMA2D_CallbackTypeDef

typedef void(* pDMA2D_CallbackTypeDef) (DMA2D_HandleTypeDef *hdma2d)

HAL DMA2D Callback pointer definition.

Pointer to a DMA2D common callback function

Definition at line 162 of file stm32f4xx_hal_dma2d.h.

Enumeration Type Documentation

◆ HAL_DMA2D_StateTypeDef

HAL DMA2D State structures definition.

Enumerator
HAL_DMA2D_STATE_RESET 

DMA2D not yet initialized or disabled

HAL_DMA2D_STATE_READY 

Peripheral Initialized and ready for use

HAL_DMA2D_STATE_BUSY 

An internal process is ongoing

HAL_DMA2D_STATE_TIMEOUT 

Timeout state

HAL_DMA2D_STATE_ERROR 

DMA2D state error

HAL_DMA2D_STATE_SUSPEND 

DMA2D process is suspended

Definition at line 115 of file stm32f4xx_hal_dma2d.h.