HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IMG_Tags.h File Reference
#include "IMG_API.h"
#include <UT/UT_StringHolder.h>
+ Include dependency graph for IMG_Tags.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  IMG_TagType {
  IMG_TAG_INVALID = -1, IMG_TAG_SOURCE_NAME, IMG_TAG_PROGRESS, IMG_TAG_PROGRESS_MSG,
  IMG_TAG_PROGRESS_ACTION, IMG_TAG_STATUS_MSG, IMG_TAG_S3D_LEFT_PLANE, IMG_TAG_S3D_RIGHT_PLANE,
  IMG_TAG_RENDER_MODE, IMG_TAG_RENDER_TIME, IMG_TAG_ELAPSED_TIME, IMG_TAG_PEAK_MEM_USAGE,
  IMG_TAG_TILE_BEGIN, IMG_TAG_TILE_DONE, IMG_TAG_CURRENT_FRAME, IMG_TAG_FRAME_RANGE,
  IMG_TAG_FRAME_RANGE_OLD, IMG_TAG_MISSING_MODE, IMG_TAG_AUDIO, IMG_TAG_BACKGROUND,
  IMG_TAG_FLIPBOOK, IMG_TAG_HOUDINI_PORT, IMG_TAG_BLOCK_EDIT, IMG_TAG_BLOCK_CHANNELS,
  IMG_TAG_CROP_WINDOW, IMG_TAG_EDGE_STREAK, IMG_TAG_ASPECT, IMG_TAG_PIXEL_ASPECT,
  IMG_TAG_BLACK_POINT, IMG_TAG_WHITE_POINT, IMG_TAG_GAMMA, IMG_TAG_LUT,
  IMG_TAG_COLOR_SPACE, IMG_TAG_EXR_DATA_WINDOW, IMG_TAG_PRIORITY_CIRCLE, IMG_TAG_STYLE_SHEET,
  IMG_TAG_ENV_VARIABLE, IMG_TAG_KNOWN_TAGS
}
 

Functions

IMG_API int IMGtagId (const char *token)
 
IMG_API UT_StringHolder IMGtagName (int id)
 

Enumeration Type Documentation

An enum of common tags for communicating with image tile devices (see IMG_TileDevice::writeCustomTag().

Enumerator
IMG_TAG_INVALID 
IMG_TAG_SOURCE_NAME 
IMG_TAG_PROGRESS 
IMG_TAG_PROGRESS_MSG 
IMG_TAG_PROGRESS_ACTION 
IMG_TAG_STATUS_MSG 
IMG_TAG_S3D_LEFT_PLANE 
IMG_TAG_S3D_RIGHT_PLANE 
IMG_TAG_RENDER_MODE 
IMG_TAG_RENDER_TIME 
IMG_TAG_ELAPSED_TIME 
IMG_TAG_PEAK_MEM_USAGE 
IMG_TAG_TILE_BEGIN 
IMG_TAG_TILE_DONE 
IMG_TAG_CURRENT_FRAME 
IMG_TAG_FRAME_RANGE 
IMG_TAG_FRAME_RANGE_OLD 
IMG_TAG_MISSING_MODE 
IMG_TAG_AUDIO 
IMG_TAG_BACKGROUND 
IMG_TAG_FLIPBOOK 
IMG_TAG_HOUDINI_PORT 
IMG_TAG_BLOCK_EDIT 
IMG_TAG_BLOCK_CHANNELS 
IMG_TAG_CROP_WINDOW 
IMG_TAG_EDGE_STREAK 
IMG_TAG_ASPECT 
IMG_TAG_PIXEL_ASPECT 
IMG_TAG_BLACK_POINT 
IMG_TAG_WHITE_POINT 
IMG_TAG_GAMMA 
IMG_TAG_LUT 
IMG_TAG_COLOR_SPACE 
IMG_TAG_EXR_DATA_WINDOW 
IMG_TAG_PRIORITY_CIRCLE 
IMG_TAG_STYLE_SHEET 
IMG_TAG_ENV_VARIABLE 
IMG_TAG_KNOWN_TAGS 

Definition at line 20 of file IMG_Tags.h.

Function Documentation

IMG_API int IMGtagId ( const char *  token)

This will a unique identifier for the given token. If it's a known token, it will be one of the enums above. If it's a custom tag, it will be >= IMG_TAG_KNOWN_TAGS.

IMG_API UT_StringHolder IMGtagName ( int  id)

Return the string associated with a given ID. The string will be "<invalid>" if the tag-id is unknown.