Developer

API Reference

IWidget_SetUnionThreshold()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_GetUnionThreshold()
- IWidget_SetUnionMinArea()
- IWidget_SetMaxDraws()
- IWidget Interface
Description
This function is used set 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 border 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.
  • nThreshold
    [in]:
    Value to set to the property
Interface
Prototype
   AEEResult IWidget_SetUnionThreshold(IWidget *pif, uint8 nThreshold);
Return
   AEE_SUCCESS   --  The value was set successfully
   AEE_EFAILED   --  An unspecified error has occured
Side Effect
None
Comment
Threshold must be in the following range: 0 <= Threshold <= 100.
  • Follow