Segment_Interesting
Functions | |
HC_EXTERNAL HIC_API bool | HIC_Check_Segment_Interesting (HIC_Rendition const *nr, HIC_Segment_Info const *si) |
HC_EXTERNAL HIC_API void | HIC_Set_Segment_Interesting (HIC_Rendition const *nr, HIC_Segment_Info const *si) |
HC_EXTERNAL HIC_API void | HIC_UnSet_Segment_Interesting (HIC_Rendition const *nr, HIC_Segment_Info const *si) |
Detailed Description
Function Documentation
◆ HIC_Check_Segment_Interesting()
HC_EXTERNAL HIC_API bool HIC_Check_Segment_Interesting | ( | HIC_Rendition const * | nr, |
HIC_Segment_Info const * | si | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. si A pointer to a const HIC_Segment_Info.
- Returns
- A boolean, true if segment is interesting, otherwise false.
This function returns a boolean, true if segment is interesting, false if segment is not interesting.
◆ HIC_Set_Segment_Interesting()
HC_EXTERNAL HIC_API void HIC_Set_Segment_Interesting | ( | HIC_Rendition const * | nr, |
HIC_Segment_Info const * | si | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. si A pointer to a const HIC_Segment_Info.
This function sets a segment to interesting.
◆ HIC_UnSet_Segment_Interesting()
HC_EXTERNAL HIC_API void HIC_UnSet_Segment_Interesting | ( | HIC_Rendition const * | nr, |
HIC_Segment_Info const * | si | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. si A pointer to a const HIC_Segment_Info.
This function sets a segment to not interesting.