HDK
|
Describes the format and layout of a single plane in an image The plane specifies the format and name of a single image plane in a deep raster image. IMG_Stat contains a list of planes found in the image. Non-deep raster formats only contain one plane. More...
#include <IMG_Plane.h>
Friends | |
class | IMG_Stat |
Describes the format and layout of a single plane in an image The plane specifies the format and name of a single image plane in a deep raster image. IMG_Stat contains a list of planes found in the image. Non-deep raster formats only contain one plane.
Definition at line 45 of file IMG_Plane.h.
IMG_Plane::IMG_Plane | ( | ) |
Planes are generally not created by the user, but by IMG_Stat::addPlane()
Planes are generally not created by the user, but by IMG_Stat::addPlane()
IMG_Plane::IMG_Plane | ( | const char * | name, |
IMG_DataType | dt, | ||
IMG_ColorModel | cm, | ||
int | index | ||
) |
Planes are generally not created by the user, but by IMG_Stat::addPlane()
void IMG_Plane::dump | ( | ) | const |
void IMG_Plane::dump | ( | UT_JSONWriter & | w | ) | const |
Specifies black/white points for integer formats (not supported for FP) always set the data type before setting the BW points. The black and white points must be within the range of the intger data format (ie, 8b - 0-255).
IMG_ColorModel IMG_Plane::getColorModel | ( | ) | const |
color model of the pixel, which specifies the components per pixel. (SINGLE_CHAN, RGB, RGBA)
PXL_ColorSpace IMG_Plane::getColorSpace | ( | ) | const |
colorspace of the image data in the plane. This helps determine how to display the image data. If PXL_CS_UNKNOWN is returned, the format's colorspace will be used instead. 'gamma' is only needed for PXL_CS_CUSTOM_GAMMA.
fpreal IMG_Plane::getColorSpaceGamma | ( | ) | const |
colorspace of the image data in the plane. This helps determine how to display the image data. If PXL_CS_UNKNOWN is returned, the format's colorspace will be used instead. 'gamma' is only needed for PXL_CS_CUSTOM_GAMMA.
|
inline |
Returns the number of components this plane consists of.
Definition at line 131 of file IMG_Plane.h.
Returns the name of the individual component of a pixel (r,g,b,a, x,y,z)
IMG_DataType IMG_Plane::getDataType | ( | ) | const |
data format of the individual pixel components (8bit - FP)
int64 IMG_Plane::getMemoryUsage | ( | bool | inclusive | ) | const |
Returns the amount of memory owned by this IMG_Plane object.
const char* IMG_Plane::getName | ( | ) | const |
plane name - must be unique in the list of planes found in IMG_Stat
int IMG_Plane::getPixelSize | ( | ) | const |
the size of a single pixel, in bytes, including the data format and the color model.
|
inline |
This is the index of this plane, in the list of planes found in IMG_Stat (0 to getNumPlanes()-1).
Definition at line 128 of file IMG_Plane.h.
IMG_TypeInfo IMG_Plane::getTypeInfo | ( | ) | const |
type info of the data contained in the plane. This is purely an advisory indicator on how the data should be handled. Note that this can affect the colorspace of the plane if not COLOR.
bool IMG_Plane::hasBlackWhitePoints | ( | ) | const |
Specifies black/white points for integer formats (not supported for FP) always set the data type before setting the BW points. The black and white points must be within the range of the intger data format (ie, 8b - 0-255).
Specifies black/white points for integer formats (not supported for FP) always set the data type before setting the BW points. The black and white points must be within the range of the intger data format (ie, 8b - 0-255).
void IMG_Plane::setColorModel | ( | IMG_ColorModel | cm | ) |
color model of the pixel, which specifies the components per pixel. (SINGLE_CHAN, RGB, RGBA)
void IMG_Plane::setColorSpace | ( | PXL_ColorSpace | cs, |
fpreal | gamma = 0.0 |
||
) |
colorspace of the image data in the plane. This helps determine how to display the image data. If PXL_CS_UNKNOWN is returned, the format's colorspace will be used instead. 'gamma' is only needed for PXL_CS_CUSTOM_GAMMA.
Sets the individual component name(s) (default: r,g,b,a). Always call after setColorModel().
void IMG_Plane::setComponentNames | ( | const char * | c1, |
const char * | c2 = 0 , |
||
const char * | c3 = 0 , |
||
const char * | c4 = 0 |
||
) |
Sets the individual component name(s) (default: r,g,b,a). Always call after setColorModel().
void IMG_Plane::setDataType | ( | IMG_DataType | dt | ) |
data format of the individual pixel components (8bit - FP)
plane name - must be unique in the list of planes found in IMG_Stat
void IMG_Plane::setTypeInfo | ( | IMG_TypeInfo | ti | ) |
type info of the data contained in the plane. This is purely an advisory indicator on how the data should be handled. Note that this can affect the colorspace of the plane if not COLOR.
Definition at line 157 of file IMG_Plane.h.