Regions

Functions

int	HIC_Can_Save_And_Restore_Regions
void	HIC_Create_Region
void	HIC_Save_Region
void	HIC_Restore_Region
void	HIC_Destroy_Region

Detailed Description

group Regions

Function Documentation

int HIC_Can_Save_And_Restore_Regions(HIC_Rendition const *nr)

This function returns a boolean which is true if you can save and restore regions and false if you cannot save and restore regions.

Parameters:

nr – A pointer to a const HIC_Rendition.

Returns:

A boolean.

void HIC_Create_Region(HIC_Rendition const *nr, HIC_Int_Rectangle const *area, void **image_buffer, void **z_buffer)

This function creates a region.

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.

void HIC_Save_Region(HIC_Rendition const *nr, HIC_Int_Rectangle const *area, void *image_buffer, void *z_buffer)

This function saves a region.

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.

void HIC_Restore_Region(HIC_Rendition const *nr, HIC_Int_Rectangle const *area, void *image_buffer, void *z_buffer)

This function restores a region.

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.

void HIC_Destroy_Region(HIC_Rendition const *nr, void *image_buffer, void *z_buffer)

This function destroys a region.

Parameters:

• nr – A pointer to a const HIC_Rendition.

• image_buffer – A void pointer.

• z_buffer – A void pointer.