Functions
Snapshot

Functions

HC_EXTERNAL HIC_API bool HIC_Snapshot (HIC_Rendition const *nr, int width, int height, unsigned char *data)
 
HC_EXTERNAL HIC_API bool HIC_Can_Snapshot (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API
HC_POINTER_SIZED_INT 
HIC_Driver_Snapshot_Texture (HIC_Rendition const *nr, HC_POINTER_SIZED_INT id)
 
HC_EXTERNAL HIC_API
HC_POINTER_SIZED_INT 
HIC_Driver_Snapshot_Depth_Texture (HIC_Rendition const *nr, HC_POINTER_SIZED_INT id)
 

Detailed Description

Function Documentation

HC_EXTERNAL HIC_API bool HIC_Can_Snapshot ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A boolean.

This function returns a boolean which is true if the driver supports snapshotting and false otherwise.

HC_EXTERNAL HIC_API bool HIC_Snapshot ( HIC_Rendition const *  nr,
int  width,
int  height,
unsigned char *  data 
)
Parameters
nrA pointer to a const HIC_Rendition.
widthAn int.
heightAn int.
dataA pointer to an unsigned char.
Returns
A boolean, true if snapshot was taken, otherwise false.

This function takes a snapshot whose dimensions are the passed in width and height parameters.