Regions
Functions | |
HC_EXTERNAL HIC_API bool | HIC_Can_Save_And_Restore_Regions (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API void | HIC_Create_Region (HIC_Rendition const *nr, HIC_Int_Rectangle const *area, void **image_buffer, void **z_buffer) |
HC_EXTERNAL HIC_API void | HIC_Destroy_Region (HIC_Rendition const *nr, void *image_buffer, void *z_buffer) |
HC_EXTERNAL HIC_API void | HIC_Restore_Region (HIC_Rendition const *nr, HIC_Int_Rectangle const *area, void *image_buffer, void *z_buffer) |
HC_EXTERNAL HIC_API void | HIC_Save_Region (HIC_Rendition const *nr, HIC_Int_Rectangle const *area, void *image_buffer, void *z_buffer) |
Detailed Description
Function Documentation
◆ HIC_Can_Save_And_Restore_Regions()
HC_EXTERNAL HIC_API bool HIC_Can_Save_And_Restore_Regions | ( | HIC_Rendition const * | nr | ) |
- Parameters
-
nr A pointer to a const HIC_Rendition.
- Returns
- A boolean.
This function returns a boolean which is true if you can save and restore regions and false if you cannot save and restore regions.
◆ HIC_Create_Region()
HC_EXTERNAL HIC_API void HIC_Create_Region | ( | HIC_Rendition const * | nr, |
HIC_Int_Rectangle const * | area, | ||
void ** | image_buffer, | ||
void ** | z_buffer | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. area A pointer to a const HIC_Int_Rectangle. image_buffer A pointer to a void pointer. z_buffer A pointer to a void pointer.
This function creates a region.
◆ HIC_Destroy_Region()
HC_EXTERNAL HIC_API void HIC_Destroy_Region | ( | HIC_Rendition const * | nr, |
void * | image_buffer, | ||
void * | z_buffer | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. image_buffer A void pointer. z_buffer A void pointer.
This function destroys a region.
◆ HIC_Restore_Region()
HC_EXTERNAL HIC_API void HIC_Restore_Region | ( | HIC_Rendition const * | nr, |
HIC_Int_Rectangle const * | area, | ||
void * | image_buffer, | ||
void * | z_buffer | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. area A pointer to a const HIC_Int_Rectangle. image_buffer A void pointer. z_buffer A void pointer.
This function restores a region.
◆ HIC_Save_Region()
HC_EXTERNAL HIC_API void HIC_Save_Region | ( | HIC_Rendition const * | nr, |
HIC_Int_Rectangle const * | area, | ||
void * | image_buffer, | ||
void * | z_buffer | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. area A pointer to a const HIC_Int_Rectangle. image_buffer A void pointer. z_buffer A void pointer.
This function saves a region.