Functions | |
HC_EXTERNAL HIC_API HIC_Point const * | HIC_Show_3D_Text_Position (HIC_Text const *t) |
HC_EXTERNAL HIC_API HIC_Integer32 | HIC_Show_Internal_Text_Color (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_KInfo_Height (HIC_Text_Karacter_Info const *iki) |
HC_EXTERNAL HIC_API HIC_Rendition const * | HIC_Show_KInfo_Net_Rendition (HIC_Text_Karacter_Info const *iki) |
HC_EXTERNAL HIC_API HIC_Point const * | HIC_Show_KInfo_Point (HIC_Text_Karacter_Info const *ki) |
HC_EXTERNAL HIC_API HIC_Point const * | HIC_Show_KInfo_Position (HIC_Text_Karacter_Info const *ki) |
HC_EXTERNAL HIC_API float | HIC_Show_KInfo_Width (HIC_Text_Karacter_Info const *iki) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Alignment (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API HIC_Vector const * | HIC_Show_Text_Baseline (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Char_Encoding (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Vector const * | HIC_Show_Text_Char_Horizontal (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Point const * | HIC_Show_Text_Char_Position (HIC_Rendition const *nr, HIC_Text_Info const *ti, int index) |
HC_EXTERNAL HIC_API HIC_Vector const * | HIC_Show_Text_Char_Vertical (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Char_Width (HIC_Rendition const *nr, HIC_Text_Info const *ti, int index) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Color_Alpha (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Color_Blue (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Color_Green (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Color_Red (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API int const * | HIC_Show_Text_Counts (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Final_Font_Size (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Font_Extra_Space (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API HIC_Size_Units | HIC_Show_Text_Font_Extra_Space_Units (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API void * | HIC_Show_Text_Font_ID (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Font_Index (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API const char * | HIC_Show_Text_Font_Name (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Font_Rotation (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Font_Size (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API HIC_Size_Units | HIC_Show_Text_Font_Size_Tol_Units (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Font_Size_Tolerance (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API HIC_Size_Units | HIC_Show_Text_Font_Size_Units (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Font_Slant (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Font_Transform (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API bool | HIC_Show_Text_Is_Outlined (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API int const * | HIC_Show_Text_KIndex (HIC_Rendition const *nr, HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Text_Karacter_Info const * | HIC_Show_Text_KInfo (HIC_Rendition const *nr, HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Text_Karacter_Info const * | HIC_Show_Text_KInfo_At_Index (HIC_Rendition const *nr, HIC_Text_Info const *ti, int index) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Length (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Line_Count (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API int | HIC_Show_Text_Line_Index (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Vector const * | HIC_Show_Text_Longest_Baseline (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Vector const * | HIC_Show_Text_Next_Line (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Vector const * | HIC_Show_Text_Path (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API HIC_Point const * | HIC_Show_Text_Position (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API HIC_Point const * | HIC_Show_Text_Reference (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API float | HIC_Show_Text_Spacing (HIC_Rendition const *inr) |
HC_EXTERNAL HIC_API const char * | HIC_Show_Text_Specified_Text (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API HIC_Karacter const * | HIC_Show_Text_String (HIC_Text_Info const *ti) |
HC_EXTERNAL HIC_API double | HIC_Show_Text_Width_Scale (HIC_Rendition const *nr) |
Detailed Description
Function Documentation
◆ HIC_Show_3D_Text_Position()
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_3D_Text_Position | ( | HIC_Text const * | t | ) |
- Parameters
-
t A pointer to a const HIC_Text.
- Returns
- A pointer to a const HIC_Point.
This function returns the text position that is stored in the graphics database.
◆ HIC_Show_Internal_Text_Color()
HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Text_Color | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A HIC_Integer32.
This function returns the internal representation of the text color.
◆ HIC_Show_KInfo_Height()
HC_EXTERNAL HIC_API float HIC_Show_KInfo_Height | ( | HIC_Text_Karacter_Info const * | iki | ) |
- Parameters
-
iki A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info height.
◆ HIC_Show_KInfo_Net_Rendition()
HC_EXTERNAL HIC_API HIC_Rendition const* HIC_Show_KInfo_Net_Rendition | ( | HIC_Text_Karacter_Info const * | iki | ) |
- Parameters
-
iki A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Rendition.
This function returns the Text_Karacter_Info net rendition.
◆ HIC_Show_KInfo_Point()
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_KInfo_Point | ( | HIC_Text_Karacter_Info const * | ki | ) |
- Parameters
-
ki A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info point.
◆ HIC_Show_KInfo_Position()
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_KInfo_Position | ( | HIC_Text_Karacter_Info const * | ki | ) |
- Parameters
-
ki A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info position.
◆ HIC_Show_KInfo_Width()
HC_EXTERNAL HIC_API float HIC_Show_KInfo_Width | ( | HIC_Text_Karacter_Info const * | iki | ) |
- Parameters
-
iki A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info width.
◆ HIC_Show_Text_Alignment()
HC_EXTERNAL HIC_API int HIC_Show_Text_Alignment | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- An int.
This function returns the text alignment as in int.
- See also
- HIC_Set_Text_Alignment
◆ HIC_Show_Text_Baseline()
HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Baseline | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Vector.
This function returns the text baseline.
◆ HIC_Show_Text_Char_Encoding()
HC_EXTERNAL HIC_API int HIC_Show_Text_Char_Encoding | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- An int.
This function returns the text char encoding as an int.
◆ HIC_Show_Text_Char_Horizontal()
HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Char_Horizontal | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Vector.
This function returns the text char horizontal.
◆ HIC_Show_Text_Char_Position()
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Text_Char_Position | ( | HIC_Rendition const * | nr, |
HIC_Text_Info const * | ti, | ||
int | index | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. ti A pointer to a const HIC_Text_Info. index An int.
- Returns
- A pointer to a const HIC_Point.
This function returns the text char position.
◆ HIC_Show_Text_Char_Vertical()
HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Char_Vertical | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Vector.
This function returns the text char vertical.
◆ HIC_Show_Text_Char_Width()
HC_EXTERNAL HIC_API float HIC_Show_Text_Char_Width | ( | HIC_Rendition const * | nr, |
HIC_Text_Info const * | ti, | ||
int | index | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. ti A pointer to a const HIC_Text_Info. index An int.
- Returns
- A float.
This function returns the text char width as a float value.
◆ HIC_Show_Text_Color_Alpha()
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Alpha | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the alpha component of the text color as a float value with a range 0 to 1.
◆ HIC_Show_Text_Color_Blue()
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Blue | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the blue component of the text color as a float value with a range 0 to 1.
◆ HIC_Show_Text_Color_Green()
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Green | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the green component of the text color as a float value with a range 0 to 1.
◆ HIC_Show_Text_Color_Red()
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Red | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the red component of the text color as a float value with a range 0 to 1.
◆ HIC_Show_Text_Counts()
HC_EXTERNAL HIC_API int const* HIC_Show_Text_Counts | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const int.
This function returns the text counts array.
◆ HIC_Show_Text_Final_Font_Size()
HC_EXTERNAL HIC_API float HIC_Show_Text_Final_Font_Size | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the final text font size as a float.
◆ HIC_Show_Text_Font_Extra_Space()
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Extra_Space | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the text font extra space as a float.
◆ HIC_Show_Text_Font_Extra_Space_Units()
HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Extra_Space_Units | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A HIC_Size_Units.
This function returns the text font extra space units.
◆ HIC_Show_Text_Font_ID()
HC_EXTERNAL HIC_API void* HIC_Show_Text_Font_ID | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- void pointer
This function returns the text font ID.
◆ HIC_Show_Text_Font_Index()
HC_EXTERNAL HIC_API int HIC_Show_Text_Font_Index | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- An int.
This function returns the text font index as an int.
◆ HIC_Show_Text_Font_Name()
HC_EXTERNAL HIC_API const char* HIC_Show_Text_Font_Name | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A pointer to a const char.
This function returns the text font name as a string.
◆ HIC_Show_Text_Font_Rotation()
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Rotation | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the text font rotation as a float.
◆ HIC_Show_Text_Font_Size()
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Size | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the text font size as a float.
◆ HIC_Show_Text_Font_Size_Tol_Units()
HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Size_Tol_Units | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A HIC_Size_Units.
This function returns the text font size tolerance units.
◆ HIC_Show_Text_Font_Size_Tolerance()
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Size_Tolerance | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the text font size tolerance as a float.
◆ HIC_Show_Text_Font_Size_Units()
HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Size_Units | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A HIC_Size_Units.
This function returns the text font size units.
◆ HIC_Show_Text_Font_Slant()
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Slant | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the text font slant as a float.
◆ HIC_Show_Text_Font_Transform()
HC_EXTERNAL HIC_API int HIC_Show_Text_Font_Transform | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- An int.
This function returns the text font transform as an int.
◆ HIC_Show_Text_Is_Outlined()
HC_EXTERNAL HIC_API bool HIC_Show_Text_Is_Outlined | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A bool.
This function returns true if the text is outlined.
◆ HIC_Show_Text_KIndex()
HC_EXTERNAL HIC_API int const* HIC_Show_Text_KIndex | ( | HIC_Rendition const * | nr, |
HIC_Text_Info const * | ti | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const int.
This function returns the int pointer owned by the HIC_Text_Info.
◆ HIC_Show_Text_KInfo()
HC_EXTERNAL HIC_API HIC_Text_Karacter_Info const* HIC_Show_Text_KInfo | ( | HIC_Rendition const * | nr, |
HIC_Text_Info const * | ti | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const Text_Karacter_Info.
This function returns the Text_Karacter_Info pointer owned by the HIC_Text_Info.
◆ HIC_Show_Text_KInfo_At_Index()
HC_EXTERNAL HIC_API HIC_Text_Karacter_Info const* HIC_Show_Text_KInfo_At_Index | ( | HIC_Rendition const * | nr, |
HIC_Text_Info const * | ti, | ||
int | index | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. ti A pointer to a const HIC_Text_Info. index Index into Karacter_Info array
- Returns
- A pointer to a const Text_Karacter_Info.
This function returns the Text_Karacter_Info pointer owned by the HIC_Text_Info.
◆ HIC_Show_Text_Length()
HC_EXTERNAL HIC_API int HIC_Show_Text_Length | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- An int.
This function returns the text length as an int representing the number of characters in the text string.
◆ HIC_Show_Text_Line_Count()
HC_EXTERNAL HIC_API int HIC_Show_Text_Line_Count | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- An int.
This function returns the text line count as an int.
◆ HIC_Show_Text_Line_Index()
HC_EXTERNAL HIC_API int HIC_Show_Text_Line_Index | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- An int.
This function returns the text line index as an int.
◆ HIC_Show_Text_Longest_Baseline()
HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Longest_Baseline | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Vector.
This function returns the text longest baseline.
◆ HIC_Show_Text_Next_Line()
HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Next_Line | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Vector.
This function returns the text next line vector.
◆ HIC_Show_Text_Path()
HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Path | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A pointer to a const HIC_Vector.
This function returns the text path.
◆ HIC_Show_Text_Position()
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Text_Position | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Point.
This function returns the text position.
◆ HIC_Show_Text_Reference()
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Text_Reference | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Point.
This function returns the text reference.
◆ HIC_Show_Text_Spacing()
HC_EXTERNAL HIC_API float HIC_Show_Text_Spacing | ( | HIC_Rendition const * | inr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A float.
This function returns the text spacing as a float.
◆ HIC_Show_Text_Specified_Text()
HC_EXTERNAL HIC_API const char* HIC_Show_Text_Specified_Text | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A const char *.
This function returns the text specified text.
◆ HIC_Show_Text_String()
HC_EXTERNAL HIC_API HIC_Karacter const* HIC_Show_Text_String | ( | HIC_Text_Info const * | ti | ) |
- Parameters
-
ti A pointer to a const HIC_Text_Info.
- Returns
- A pointer to a const HIC_Karacter.
This function returns the text string.
◆ HIC_Show_Text_Width_Scale()
HC_EXTERNAL HIC_API double HIC_Show_Text_Width_Scale | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
inr A pointer to a const HIC_Rendition.
- Returns
- A double.
This function returns the text width scale.