HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
IMG_Tags.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: IMG_Tags.h
7  *
8  * COMMENTS: Contains a lists of known global and plane tags for
9  * IMG_TileDevice.
10  */
11 
12 #ifndef __IMG_Tags__
13 #define __IMG_Tags__
14 
15 #include "IMG_API.h"
16 #include <UT/UT_StringHolder.h>
17 
18 /// An enum of common tags for communicating with image tile devices (see
19 /// IMG_TileDevice::writeCustomTag().
21 {
23  IMG_TAG_SOURCE_NAME, // "sourcename" <name>
24  IMG_TAG_PROGRESS, // "progress" <percentage>
25  IMG_TAG_PROGRESS_MSG, // "progressmessage" <str>
26  IMG_TAG_PROGRESS_ACTION, // "progressaction" <str>
27  IMG_TAG_STATUS_MSG, // "statusmessage" <str>
28  IMG_TAG_S3D_LEFT_PLANE, // "s3drightplane" <plane_name>
29  IMG_TAG_S3D_RIGHT_PLANE, // "s3dleftplane" <plane_name>
30  IMG_TAG_RENDER_MODE, // "rendermode" <[new-]append|[new-]replace>
31  IMG_TAG_RENDER_TIME, // "rendertime" <final_time_str>
32  IMG_TAG_ELAPSED_TIME, // "elapsedtime" <so_far_time_str>
33  IMG_TAG_PEAK_MEM_USAGE, // "peakmemusage" <peak_mem_usage>
34  IMG_TAG_TILE_BEGIN, // "tilebegin" <tile ID> <x0> <x1> <y0> <y1>
35  // <red> <green> <blue> <alpha>
36  IMG_TAG_TILE_DONE, // "tiledone" <tile ID>
37  IMG_TAG_CURRENT_FRAME, // "currentframe" <frame_no>
38  IMG_TAG_FRAME_RANGE, // "framerange" <start> <end>
39  IMG_TAG_FRAME_RANGE_OLD, // "frange" <start> <end>
40  IMG_TAG_MISSING_MODE, // "missingmode" <black|prev|next|closest>
41  IMG_TAG_AUDIO, // "audio" <file> [<frame_offset> [...]]
42  IMG_TAG_BACKGROUND, // "background" <file>
43  IMG_TAG_FLIPBOOK, // "flipbook"
44  IMG_TAG_HOUDINI_PORT, // "houdiniportnum" <port_no>
45  IMG_TAG_BLOCK_EDIT, // "blockedit"
46  IMG_TAG_BLOCK_CHANNELS, // "blockchannels"
47  IMG_TAG_CROP_WINDOW, // "cropwindow" <x> <y> <w> <h>
48  IMG_TAG_EDGE_STREAK, // "edgestreak"
49  IMG_TAG_ASPECT, // "aspect" <aspect>
50  IMG_TAG_PIXEL_ASPECT, // "pixelaspect" <aspect>
51  IMG_TAG_BLACK_POINT, // "blackpoint" <value>
52  IMG_TAG_WHITE_POINT, // "whitepoint" <value>
53  IMG_TAG_GAMMA, // "gamma" <gamma_exp>
54  IMG_TAG_LUT, // "LUT" <lut_name>
55  IMG_TAG_COLOR_SPACE, // "colorspace" <csname> <gammaval>
56 
57  IMG_TAG_EXR_DATA_WINDOW, // "exrdatawindow" <padding> <threshold> <planes>
58 
59  IMG_TAG_PRIORITY_CIRCLE, // "prioritycircle" <centrex> <centrey> <radius>
60 
61  IMG_TAG_STYLE_SHEET, // "stylesheets" [<style sheets> [...]]
62  IMG_TAG_ENV_VARIABLE, // "envvar" var value
63  IMG_TAG_DENOISE_PLANE, // "denoiseplane" <denoisername> <plane_name> [...]
64 
65  IMG_TAG_KNOWN_TAGS // Number of known tags
66 };
67 
68 /// This will a unique identifier for the given token. If it's a known token,
69 /// it will be one of the enums above. If it's a custom tag, it will be >=
70 /// IMG_TAG_KNOWN_TAGS.
71 IMG_API extern int IMGtagId(const char *token);
72 
73 /// Return the string associated with a given ID. The string will be
74 /// "<invalid>" if the tag-id is unknown.
75 IMG_API extern UT_StringHolder IMGtagName(int id);
76 
77 #endif // __IMG_Tags__
IMG_API int IMGtagId(const char *token)
#define IMG_API
Definition: IMG_API.h:10
IMG_API UT_StringHolder IMGtagName(int id)
IMG_TagType
Definition: IMG_Tags.h:20