Developer

API Reference

IWidget_GetUnionThreshold()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_SetUnionThreshold()
- IWidget_GetUnionMinArea()
- IWidget_GetMaxDraws()
- IWidget Interface
Description
This function is used get the threshold percentage that is used to determine when two invalidation rectangles should be joined or kept separate. It will use the union if (Area of Rect1 + Area of Rect2) > (Threshold% x Area of Union) In other words, a smaller threshold encourages using the union of the rects, while a larger threshold will track each rectangles. For the extreme cases, a threshold of 0 will always use the union of the rects while a theshold of 100 will only use the union of the invalidate overlap.
Parameters
  • pif
    [in]:
    Pointer to the IWidget interface object.
  • pnThreshold
    [out]:
    Will hold the return value of the property
Interface
Prototype
   AEEResult IWidget_GetUnionThreshold(IWidget *pif, uint8 *pnThreshold);
Return
   AEE_SUCCESS      --  The value was retrieved successfully
   AEE_EFAILED      --  The value could not be retrieved.
Side Effect
None
Comment
Threshold must be in the following range: 0 <= Threshold <= 100.
  • Follow