## **Overview**
**Related Modules:**
[Display](Display.md)
**Description:**
Defines pointers to the layer driver functions.
## **Summary**
## Data Fields
InitDisplay )(uint32_t devId) | |
DeinitDisplay )(uint32_t devId) | Deinitializes a display device. |
GetDisplayInfo )(uint32_t devId, DisplayInfo *dispInfo) | Obtains information about a display device. |
OpenLayer )(uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId) | Opens a layer on a specified display device. |
CloseLayer )(uint32_t devId, uint32_t layerId) | Closes a layer that is no longer required on a specified display device. |
SetLayerVisible )(uint32_t devId, uint32_t layerId, bool visible) | Sets whether a layer is visible. |
GetLayerVisibleState )(uint32_t devId, uint32_t layerId, bool *visible) | Checks whether a layer is visible. |
SetLayerSize )(uint32_t devId, uint32_t layerId, IRect *rect) | |
GetLayerSize )(uint32_t devId, uint32_t layerId, IRect *rect) | |
SetLayerCrop )(uint32_t devId, uint32_t layerId, IRect *rect) | Sets the rectangular area to crop for a layer. |
SetLayerZorder )(uint32_t devId, uint32_t layerId, uint32_t zorder) | |
GetLayerZorder )(uint32_t devId, uint32_t layerId, uint32_t *zorder) | Obtains the z-order of a layer. |
SetLayerPreMulti )(uint32_t devId, uint32_t layerId, bool preMul) | |
GetLayerPreMulti )(uint32_t devId, uint32_t layerId, bool *preMul) | Obtains the premultiplication flag of a layer. |
SetLayerAlpha )(uint32_t devId, uint32_t layerid, LayerAlpha *alpha) | Sets the alpha value for a layer. |
GetLayerAlpha )(uint32_t devId, uint32_t layerId, LayerAlpha *alpha) | Obtains the alpha value of a layer. |
SetLayerColorKey )(uint32_t devId, uint32_t layerId, bool enable, uint32_t key) | Sets the color key for a layer. |
GetLayerColorKey )(uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key) | Obtains the color key of a layer. |
SetLayerPalette )(uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len) | |
GetLayerPalette )(uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len) | Obtains the palette of a layer. |
SetTransformMode )(uint32_t devId, uint32_t layerId, TransformType type) | Sets the transform mode for a layer. |
SetLayerCompression )(uint32_t devId, uint32_t layerId, int32_t compType) | Sets the compression feature for a layer. |
GetLayerCompression )(uint32_t devId, uint32_t layerId, int32_t *compType) | Checks whether the compression feature is enabled for a layer. |
SetLayerDirtyRegion )(uint32_t devId, uint32_t layerId, IRect *region) | Sets the flushing area for a layer. |
GetLayerBuffer )(uint32_t devId, uint32_t layerId, LayerBuffer *buffer) | Obtains the buffer of a layer. |
Flush )(uint32_t devId, uint32_t layerId, LayerBuffer *buffer) | |
WaitForVBlank )(uint32_t devId, uint32_t layerId) | Waits for the arrival of vertical blanking. |
SnapShot )(uint32_t devId, LayerBuffer *buffer) | Implements the snapshot feature. |
## **Details**
## **Field Documentation**
## CloseLayer
```
int32_t(* LayerFuncs::CloseLayer) (uint32_t devId, uint32_t layerId)
```
**Description:**
Closes a layer that is no longer required on a specified display device.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[OpenLayer](LayerFuncs.md#a795f4e168d5b284a9c33f636c278207f)
## DeinitDisplay
```
int32_t(* LayerFuncs::DeinitDisplay) (uint32_t devId)
```
**Description:**
Deinitializes a display device.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[InitDisplay](LayerFuncs.md#a0641c3b48542646daa80386122bed46a)
## Flush
```
int32_t(* LayerFuncs::Flush) (uint32_t devId, uint32_t layerId, [LayerBuffer](LayerBuffer.md) *buffer)
```
**Description:**
Flushes a layer.
Display data in the buffer is flushed to a specified layer so that the image data is displayed on the screen.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
buffer | Indicates the pointer to the buffer in which the display data is to flush. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
## GetDisplayInfo
```
int32_t(* LayerFuncs::GetDisplayInfo) (uint32_t devId, [DisplayInfo](DisplayInfo.md) *dispInfo)
```
**Description:**
Obtains information about a display device.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
dispInfo | Indicates the pointer to the display device information obtained. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
## GetLayerAlpha
```
int32_t(* LayerFuncs::GetLayerAlpha) (uint32_t devId, uint32_t layerId, [LayerAlpha](LayerAlpha.md) *alpha)
```
**Description:**
Obtains the alpha value of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
alpha | Indicates the pointer to the obtained alpha value. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerAlpha](LayerFuncs.md#a20e554afa2f7b1015fd23ce240344b13)
## GetLayerBuffer
```
int32_t(* LayerFuncs::GetLayerBuffer) (uint32_t devId, uint32_t layerId, [LayerBuffer](LayerBuffer.md) *buffer)
```
**Description:**
Obtains the buffer of a layer.
After drawing a picture in the buffer, the application calls the [Flush](LayerFuncs.md#abb480bf2b85e93841c49fdc9800bd1e7) function to display the picture on the screen.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
buffer | Indicates the pointer to the obtained buffer. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[Flush](LayerFuncs.md#abb480bf2b85e93841c49fdc9800bd1e7)
## GetLayerColorKey
```
int32_t(* LayerFuncs::GetLayerColorKey) (uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key)
```
**Description:**
Obtains the color key of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
enable | Indicates the pointer to the color key enable bit. |
key | Indicates the pointer to the color key. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerColorKey](LayerFuncs.md#a5701fe1e0e2414de577aa5329bd873c9)
## GetLayerCompression
```
int32_t(* LayerFuncs::GetLayerCompression) (uint32_t devId, uint32_t layerId, int32_t *compType)
```
**Description:**
Checks whether the compression feature is enabled for a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
compType | Indicates the pointer to the variable specifying whether the compression feature is enabled. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerCompression](LayerFuncs.md#a46c9750d8615dc874b66ac4b10796b24)
## GetLayerPalette
```
int32_t(* LayerFuncs::GetLayerPalette) (uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len)
```
**Description:**
Obtains the palette of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
palette | Indicates the pointer to the obtained palette. |
len | Indicates the length of the palette. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerPalette](LayerFuncs.md#a3982c76e093852ef386fc372581be4af)
## GetLayerPreMulti
```
int32_t(* LayerFuncs::GetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool *preMul)
```
**Description:**
Obtains the premultiplication flag of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
preMul | Indicates the pointer to the obtained layer premultiplication flag. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerPreMulti](LayerFuncs.md#a456aa01ca3ffa81d2e49c0a9487f816f)
## GetLayerSize
```
int32_t(* LayerFuncs::GetLayerSize) (uint32_t devId, uint32_t layerId, [IRect](IRect.md) *rect)
```
**Description:**
Obtains the size of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
rect | Indicates the pointer to the obtained layer size. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerSize](LayerFuncs.md#ab58e66b0676b1baa1662c175d43bf219)
## GetLayerVisibleState
```
int32_t(* LayerFuncs::GetLayerVisibleState) (uint32_t devId, uint32_t layerId, bool *visible)
```
**Description:**
Checks whether a layer is visible.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerVisible](LayerFuncs.md#aaa5bf7f98e8dc47510a4f26fb38094b6)
## GetLayerZorder
```
int32_t(* LayerFuncs::GetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_t *zorder)
```
**Description:**
Obtains the z-order of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
zorder | Indicates the pointer to the obtained z-order. The value is an integer ranging from 0 to 255. A larger z-order value indicates a higher layer. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[SetLayerZorder](LayerFuncs.md#aa3803c2a6395651d1538ffb62d29733d)
## InitDisplay
```
int32_t(* LayerFuncs::InitDisplay) (uint32_t devId)
```
**Description:**
Initializes a display device.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[DeinitDisplay](LayerFuncs.md#a8d7a715d7d2b4bd5ab0db92c2a1eec93)
## OpenLayer
```
int32_t(* LayerFuncs::OpenLayer) (uint32_t devId, const [LayerInfo](LayerInfo.md) *layerInfo, uint32_t *layerId)
```
**Description:**
Opens a layer on a specified display device.
Before using a layer on the GUI, you must open the layer based on the layer information. After the layer is opened, you can obtain the layer ID and then use other functions based on the layer ID.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerInfo | Indicates the pointer to the layer information passed to open a layer, including the layer type, layer size, and pixel format. |
layerId | Indicates the pointer to the layer ID, which identifies a unique layer. The layer ID is returned to the GUI after the layer is successfully opened. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[CloseLayer](LayerFuncs.md#a2e375f75209da329f131b914377e9616)
## SetLayerAlpha
```
int32_t(* LayerFuncs::SetLayerAlpha) (uint32_t devId, uint32_t layerid, [LayerAlpha](LayerAlpha.md) *alpha)
```
**Description:**
Sets the alpha value for a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
alpha | Indicates the pointer to the alpha value to set. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerAlpha](LayerFuncs.md#acf1e01338eeb0fd957f53ed0d2551394)
## SetLayerColorKey
```
int32_t(* LayerFuncs::SetLayerColorKey) (uint32_t devId, uint32_t layerId, bool enable, uint32_t key)
```
**Description:**
Sets the color key for a layer.
The color key is used during layer overlay.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
enable | Specify whether to enable the color key. |
key | Indicates the color key. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerColorKey](LayerFuncs.md#aea882232b6279b8be82c45e889187b24)
## SetLayerCompression
```
int32_t(* LayerFuncs::SetLayerCompression) (uint32_t devId, uint32_t layerId, int32_t compType)
```
**Description:**
Sets the compression feature for a layer.
In specific scenarios, images need to be compressed. You can set whether to enable layer compression.
**Parameters:**
**Returns:**
**** Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise. ****
**See also:**
**** [GetLayerCompression](LayerFuncs.md#ab0b5855ea4ee5228516303cba84907ce) ****
## SetLayerCrop
```
int32_t(* LayerFuncs::SetLayerCrop) (uint32_t devId, uint32_t layerId, [IRect](IRect.md) *rect)
```
**Description:**
Sets the rectangular area to crop for a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
rect | Indicates the pointer to the rectangular area to crop. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
## SetLayerDirtyRegion
```
int32_t(* LayerFuncs::SetLayerDirtyRegion) (uint32_t devId, uint32_t layerId, [IRect](IRect.md) *region)
```
**Description:**
Sets the flushing area for a layer.
After the GUI draws an image, you must set the layer flushing area before calling the [Flush](LayerFuncs.md#abb480bf2b85e93841c49fdc9800bd1e7) function to flush the screen.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
region | Indicates the pointer to the flushing area to set. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
## SetLayerPalette
```
int32_t(* LayerFuncs::SetLayerPalette) (uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len)
```
**Description:**
Sets the palette for a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
palette | Indicates the pointer to the palette to set. |
len | Indicates the length of the palette. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerPalette](LayerFuncs.md#af713bc39e51dc8168c278e2f126bf4e3)
## SetLayerPreMulti
```
int32_t(* LayerFuncs::SetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool preMul)
```
**Description:**
Sets layer premultiplication.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerPreMulti](LayerFuncs.md#a4a0e26f8401da1232f03bb37502ff4bd)
## SetLayerSize
```
int32_t(* LayerFuncs::SetLayerSize) (uint32_t devId, uint32_t layerId, [IRect](IRect.md) *rect)
```
**Description:**
Sets the size of a layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
rect | Indicates the pointer to the layer size to set, in pixels. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerSize](LayerFuncs.md#a56be84be25eba64497b2a842c1f68b26)
## SetLayerVisible
```
int32_t(* LayerFuncs::SetLayerVisible) (uint32_t devId, uint32_t layerId, bool visible)
```
**Description:**
Sets whether a layer is visible.
A visible layer is displayed on the screen, whereas an invisible layer is not displayed on the screen.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerVisibleState](LayerFuncs.md#a6bbff71bb4f17eb84a4db4857a0b0985)
## SetLayerZorder
```
int32_t(* LayerFuncs::SetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_t zorder)
```
**Description:**
Sets the z-order for a layer.
A larger z-order value indicates a higher layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
zorder | Indicates the z-order to set. The value is an integer ranging from 0 to 255. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
**See also:**
[GetLayerZorder](LayerFuncs.md#a5644645442e1d6943b55ce0a6a801b8c)
## SetTransformMode
```
int32_t(* LayerFuncs::SetTransformMode) (uint32_t devId, uint32_t layerId, [TransformType](Display.md#gaa65f3b21a9a92ff022e435a7304126d2) type)
```
**Description:**
Sets the transform mode for a layer.
Using this function, you can rotate, scale, and move the layer.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
type | Indicates the transformation mode to set. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
## SnapShot
```
int32_t(* LayerFuncs::SnapShot) (uint32_t devId, [LayerBuffer](LayerBuffer.md) *buffer)
```
**Description:**
Implements the snapshot feature.
This function saves the screenshot of image data on the display device to the buffer for debugging or as requested by applications.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
buffer | Indicates the pointer to the buffer for saving screenshots. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.
## WaitForVBlank
```
int32_t(* LayerFuncs::WaitForVBlank) (uint32_t devId, uint32_t layerId)
```
**Description:**
Waits for the arrival of vertical blanking.
This function blocks the process until vertical blanking arrives, implementing the synchronization between software and hardware.
**Parameters:**
devId | Indicates the ID of a display device. The value ranges from 0 to 4, where 0 indicates the first display device and 4 indicates the last display device. |
layerId | Indicates the layer ID, which identifies a unique layer. You can perform operations on the layer with the specified layer ID. |
timeOut | Indicates the maximum duration that the process waits for the arrival of vertical blanking. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [DispErrCode](Display.md#ga12a925dadef7573cd74d63d06824f9b0) otherwise.