Function Index Class Index

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)

Function Documentation

HC_EXTERNAL HIC_API bool HIC_Can_Save_And_Restore_Regions ( HIC_Rendition const *  nr)
Parameters:
nrA 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.

HC_EXTERNAL HIC_API void HIC_Create_Region ( HIC_Rendition const *  nr,
HIC_Int_Rectangle const *  area,
void **  image_buffer,
void **  z_buffer 
)
Parameters:
nrA pointer to a const HIC_Rendition.
areaA pointer to a const HIC_Int_Rectangle.
image_bufferA pointer to a void pointer.
z_bufferA pointer to a void pointer.

This function creates a region.

HC_EXTERNAL HIC_API void HIC_Destroy_Region ( HIC_Rendition const *  nr,
void *  image_buffer,
void *  z_buffer 
)
Parameters:
nrA pointer to a const HIC_Rendition.
image_bufferA void pointer.
z_bufferA void pointer.

This function destroys a 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:
nrA pointer to a const HIC_Rendition.
areaA pointer to a const HIC_Int_Rectangle.
image_bufferA void pointer.
z_bufferA void pointer.

This function restores a 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:
nrA pointer to a const HIC_Rendition.
areaA pointer to a const HIC_Int_Rectangle.
image_bufferA void pointer.
z_bufferA void pointer.

This function saves a region.