Houdini Engine 6.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
HAPI_ImageInfo Struct Reference

Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo() More...

#include <HAPI_Common.h>

Public Attributes

HAPI_StringHandle imageFileFormatNameSH
int xRes
int yRes
HAPI_ImageDataFormat dataFormat
HAPI_Bool interleaved
HAPI_ImagePacking packing
 ex: true = RGBRGBRGB, false = RRRGGGBBB More...
double gamma

Detailed Description

Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo()

Definition at line 1769 of file HAPI_Common.h.

Member Data Documentation

HAPI_ImageDataFormat HAPI_ImageInfo::dataFormat

Definition at line 1784 of file HAPI_Common.h.

double HAPI_ImageInfo::gamma

Adjust the gamma of the image. For anything less than HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.

Definition at line 1791 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ImageInfo::imageFileFormatNameSH

Unlike the other members of this struct changing imageFileFormatNameSH and giving this struct back to HAPI_SetImageInfo() nothing will happen. Use this member variable to derive which image file format will be used by the HAPI_ExtractImageToFile() and HAPI_ExtractImageToMemory() functions if called with image_file_format_name set to NULL. This way, you can decide whether to ask for a file format conversion (slower) or not (faster). (Read-only)

Definition at line 1779 of file HAPI_Common.h.

HAPI_Bool HAPI_ImageInfo::interleaved

Definition at line 1786 of file HAPI_Common.h.

HAPI_ImagePacking HAPI_ImageInfo::packing

ex: true = RGBRGBRGB, false = RRRGGGBBB

Definition at line 1787 of file HAPI_Common.h.

int HAPI_ImageInfo::xRes

Definition at line 1781 of file HAPI_Common.h.

int HAPI_ImageInfo::yRes

Definition at line 1782 of file HAPI_Common.h.

The documentation for this struct was generated from the following file: