# LayerFuncs - [Overview](#section818032663165632) - [Summary](#section2061830316165632) - [Data Fields](#pub-attribs) - [Details](#section1254774471165632) - [Field](#section842552881165632) - [CloseLayer](#a2e375f75209da329f131b914377e9616) - [DeinitDisplay](#a8d7a715d7d2b4bd5ab0db92c2a1eec93) - [Flush](#abb480bf2b85e93841c49fdc9800bd1e7) - [GetDisplayInfo](#aba57e2b79df0e774727d0c07ef90e715) - [GetLayerAlpha](#acf1e01338eeb0fd957f53ed0d2551394) - [GetLayerBuffer](#a40b406f6b4e6a812a36605041e0e81d6) - [GetLayerColorKey](#aea882232b6279b8be82c45e889187b24) - [GetLayerCompression](#ab0b5855ea4ee5228516303cba84907ce) - [GetLayerPalette](#af713bc39e51dc8168c278e2f126bf4e3) - [GetLayerPreMulti](#a4a0e26f8401da1232f03bb37502ff4bd) - [GetLayerSize](#a56be84be25eba64497b2a842c1f68b26) - [GetLayerVisibleState](#a6bbff71bb4f17eb84a4db4857a0b0985) - [GetLayerZorder](#a5644645442e1d6943b55ce0a6a801b8c) - [InitDisplay](#a0641c3b48542646daa80386122bed46a) - [OpenLayer](#a795f4e168d5b284a9c33f636c278207f) - [SetLayerAlpha](#a20e554afa2f7b1015fd23ce240344b13) - [SetLayerColorKey](#a5701fe1e0e2414de577aa5329bd873c9) - [SetLayerCompression](#a46c9750d8615dc874b66ac4b10796b24) - [SetLayerCrop](#a4f925226529e27678df19423fa6f83ad) - [SetLayerDirtyRegion](#a7aa2a7bf4c0aed948c8617adec2d91b6) - [SetLayerPalette](#a3982c76e093852ef386fc372581be4af) - [SetLayerPreMulti](#a456aa01ca3ffa81d2e49c0a9487f816f) - [SetLayerSize](#ab58e66b0676b1baa1662c175d43bf219) - [SetLayerVisible](#aaa5bf7f98e8dc47510a4f26fb38094b6) - [SetLayerZorder](#aa3803c2a6395651d1538ffb62d29733d) - [SetTransformMode](#a707a6ae5144ee329110822dd8301cb22) - [SnapShot](#a751377d6d1877cd9e878208b94339407) - [WaitForVBlank](#a62471eb83a24d0a84dabd53018666336) ## **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) |
|
GetDisplayInfo )(uint32_t devId, DisplayInfo *dispInfo) |
|
OpenLayer )(uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId) |
|
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) |
|
GetLayerVisibleState )(uint32_t devId, uint32_t layerId, bool *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) |
|
SetLayerZorder )(uint32_t devId, uint32_t layerId, uint32_t zorder) |
|
GetLayerZorder )(uint32_t devId, uint32_t layerId, uint32_t *zorder) |
|
SetLayerPreMulti )(uint32_t devId, uint32_t layerId, bool preMul) |
|
GetLayerPreMulti )(uint32_t devId, uint32_t layerId, bool *preMul) |
|
SetLayerAlpha )(uint32_t devId, uint32_t layerid, LayerAlpha *alpha) |
|
GetLayerAlpha )(uint32_t devId, uint32_t layerId, LayerAlpha *alpha) |
|
SetLayerColorKey )(uint32_t devId, uint32_t layerId, bool enable, uint32_t key) |
|
GetLayerColorKey )(uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key) |
|
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) |
|
SetTransformMode )(uint32_t devId, uint32_t layerId, TransformType type) |
|
SetLayerCompression )(uint32_t devId, uint32_t layerId, int32_t compType) |
|
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) |
|
GetLayerBuffer )(uint32_t devId, uint32_t layerId, LayerBuffer *buffer) |
|
Flush )(uint32_t devId, uint32_t layerId, LayerBuffer *buffer) |
|
WaitForVBlank )(uint32_t devId, uint32_t layerId) |
|
SnapShot )(uint32_t devId, LayerBuffer *buffer) |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |