Developer

API Reference

IWidget_SetBGImageTiledBorder()

Brew Release
Brew MP 1.0.2
See Also
Border Background Events IWidget_SetBGImageTiledBorder BGImageTiledBorder
Description

This routine is used to set the background image tiled border dimensions. These dimensions allow you to specify what portions of the full image represent a given section of the tiled image of the tiled image.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object.
  • left
    []:
    [in] The value of the left BG image tiled border distance.
  • top
    []:
    [in] The value of the top BG image tiled border distance.
  • right
    []:
    [in] The value of the right BG image tiled border distance.
  • bottom
    []:
    [in] The value of the bottom BG image tiled border distance.
Interface
Prototype
   IWidget_SetBGImageTiledBorder(IWidget *pif, uint16 left, uint16 top,
                                 uint16 right, uint16 bottom);
Return
   AEE_SUCCESS - If the widget is able to set the background image border distances.
   AEE_EFAILED - If the widget failed to set the background image border distances.
Side Effect
None
Comment

All values are specified such that the offset given will be with respect to their given side and increase inwards such that a value of zero would represent the far edge and a value equal to half the total size of the image in a direction would be the center of the widget.
These four dimensions will then create up to 9 distinct regions in the tiled image. By setting one or more of the parameters to zero, you can change the tiling based on your needs. For example, if you specify that both the left and right regions have a size of 0 pixels, you will end up with only 3 regions: a top, middle, and bottom region.
   |--------------------------------------------------|
   |        |             ^                 |         |
   |        |             |                 |         |
   |   1    |            top      2         |    3    |
   |        |             |                 |         |
   |        |             v                 |         |
   |--------|-------------------------------|---------|
   |        |                               |         |
   |        |                               |         |
   |<-left->|             5                 |<-right->|
   |        |                               |         |
   |   4    |                               |    6    |
   |--------|-------------------------------|---------|
   |        |             ^                 |         |
   |        |             |                 |         |
   |   7    |       8   bottom              |   9     |
   |        |             |                 |         |
   |        |             v                 |         |
   |--------------------------------------------------|
  • Follow