Snapshot
Functions | |
HC_EXTERNAL HIC_API bool | HIC_Can_Snapshot (HIC_Rendition const *nr) |
HC_EXTERNAL HIC_API HC_POINTER_SIZED_INT | HIC_Driver_Snapshot_Depth_Texture (HIC_Rendition const *nr, HC_POINTER_SIZED_INT id) |
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 bool | HIC_Snapshot (HIC_Rendition const *nr, int width, int height, unsigned char *data) |
Detailed Description
Function Documentation
◆ HIC_Can_Snapshot()
HC_EXTERNAL HIC_API bool HIC_Can_Snapshot | ( | 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 the driver supports snapshotting and false otherwise.
◆ HIC_Snapshot()
HC_EXTERNAL HIC_API bool HIC_Snapshot | ( | HIC_Rendition const * | nr, |
int | width, | ||
int | height, | ||
unsigned char * | data | ||
) |
- Parameters
-
nr A pointer to a const HIC_Rendition. width An int. height An int. data A 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.