COP2_Common.h File Reference

#include <OP/OP_DataTypes.h>

Include dependency graph for COP2_Common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	cop2LockInfo

Macros
#define	COP2_MASK_PAGE_NAME   "Mask"
#define	COP2_GEN_MASK_COUNT   4
#define	COP2_GEN_IMAGE_PAGE   "Image"
#define	COP2_GEN_IMAGE_COUNT   16
#define	COP2_GEN_SEQUENCE_PAGE   "Sequence"
#define	COP2_GEN_SEQUENCE_COUNT   8
#define	COP2_MULTI_MERGE_PAGE   "Merge"
#define	COP2_MULTI_MERGE_COUNT   5
#define	COP2_FRAME_PAGE_NAME   "Frame Scope"
#define	TOOL_PARM   PRM_Template::PRM_EXPORT_TBX
#define	POPUP_PARM   PRM_Template::PRM_EXPORT_MAX
#define	COP2_EMPTY_SWITCHER(name)
#define	COP2_SWITCHER(count, name)
#define	COP2_SWITCHER2(count1, name1, count2, name2)
#define	COP2_SWITCHER3(count1, name1, count2, name2, count3, name3)
#define	COP2_SWITCHER4(count1, name1, count2, name2, count3, name3, count4, name4)
#define	COP2_SWITCHER5(count1, name1, count2, name2, count3, name3, count4, name4, count5, name5)
#define	COP2_GENERATOR_SWITCHER(count, name)
#define	COP2_GENERATOR_SWITCHER2(count1, name1, count2, name2)
#define	COP2_GENERATOR_SWITCHER3(count1, name1, count2, name2, count3, name3)
#define	COP2_MULTI_SWITCHER(count, name)
#define	COP2_MULTI_SWITCHER2(count1, name1, count2, name2)
#define	COP2_MULTI_SWITCHER3(count1, name1, count2, name2, count3, name3)
#define	COP2_PIXEL_EXTRAS   11
#define	COP2_PIXEL_FIRST_EXTRAS   2
#define	COP2_PIXEL_FRAME_EXTRAS   9
#define	COP2_PIXEL_SWITCHER(count, name)
#define	COP2_PIXEL_SWITCHER2(count1, name1, count2, name2)
#define	COP2_MASK_EXTRAS   (COP2_PIXEL_FIRST_EXTRAS+5)
#define	COP2_MASK_SWITCHER(count, name)
#define	COP2_MASK_SWITCHER2(count1, name1, count2, name2)
#define	COP2_MASK_SWITCHER3(count1, name1, count2, name2, count3, name3)
#define	COP2_PIXEL_OP_EXTRAS   2
#define	COP2_PIXEL_OP_SWITCHER(count, name)
#define	COP2_PIXEL_OP_SWITCHER2(count1, name1, count2, name2)
#define	DEFAULT_COLOR_NAME   "C"
#define	DEFAULT_RED_NAME   "R"
#define	DEFAULT_GREEN_NAME   "G"
#define	DEFAULT_BLUE_NAME   "B"
#define	DEFAULT_ALPHA_NAME   "A"
#define	DEFAULT_LUMINANCE_NAME   "Y"
#define	DEFAULT_DEPTH_NAME   "Z"
#define	DEFAULT_STENCIL_NAME   "S"
#define	IMAGE_UNIT_UV   0
#define	IMAGE_UNIT_PIXEL   1
#define	PLANE_MERGE_ALL   0
#define	PLANE_MERGE_COMMON   1
#define	PLANE_MERGE_FIRST   2
#define	PLANE_DEPTH_PROMOTE   0
#define	PLANE_DEPTH_DEMOTE   1
#define	PLANE_DEPTH_FIRST   2
#define	PLANE_DEPTH_MISMATCH_ERROR   3
#define	SEQUENCE_RANGE_TRIM_FIRST   0
#define	SEQUENCE_RANGE_SHIFT_FIRST   1
#define	SEQUENCE_RANGE_EXTEND_MAX   2
#define	SEQUENCE_RANGE_TRIM_MIN   3
#define	SEQUENCE_RATE_FIRST   0
#define	SEQUENCE_RATE_HIGHEST   1
#define	SEQUENCE_RATE_LOWEST   2
#define	SEQUENCE_RATE_MISMATCH_ERROR   3
#define	SEQUENCE_FRAME_NEAREST   0
#define	SEQUENCE_FRAME_PREVIOUS   1
#define	SEQUENCE_FRAME_NEXT   2
#define	ICON_PREVIEW_RGB   0
#define	ICON_PREVIEW_ALPHA   1
#define	ICON_PREVIEW_DEPTH   2
#define	ICON_PREVIEW_LUM   3
#define	COP2_MULTITHREADED   0
#define	COP2_SINGLE_THREAD   1
#define	COP2_EXCLUSIVE_THREAD   2
#define	COP2_PARM_NONVOLITILE   0
#define	COP2_PARM_IMAGE   1
#define	COP2_PARM_TIMING   2
#define	COP2_PARM_ALL_VOLITILE   3
#define	SHIFT_ALIGN_START_START   0
#define	SHIFT_ALIGN_END_END   1
#define	SHIFT_ALIGN_END_START   2
#define	SHIFT_ALIGN_START_END   3
#define	SHIFT_REL_TO_START   0
#define	SHIFT_ABS_START   1
#define	SHIFT_ABS_END   2
#define	TRIM_REL   0
#define	TRIM_ABS   1
#define	TRIM_SINGLE   2
#define	TRIM_SINGLE_START   3
#define	TRIM_SINGLE_END   4

Enumerations
enum	COP2_OpColorType { COP2_COLOR_GENERATOR, COP2_COLOR_TIMING, COP2_COLOR_PIXELOP, COP2_COLOR_VEX }
enum	COP2_ThreadPref { COP2_THREAD_NO_PREF = 0, COP2_THREAD_SINGLE = 0x1, COP2_THREAD_MULTI = 0x2 }
enum	COP2_ColorComponent {   COP2_RED, COP2_GREEN, COP2_BLUE, COP2_ALPHA,   COP2_HUE, COP2_SATURATION, COP2_VALUE, COP2_LUMINANCE,   COP2_NUM_COLOR_COMPONENTS }
enum	COP2_UIChangeType { COP2_UICHANGE_DISK_CACHE = OP_UICHANGE_OPTYPE_COP2 }

Macro Definition Documentation

#define COP2_EMPTY_SWITCHER

(

name

)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(0,name), }

Definition at line 29 of file COP2_Common.h.

#define COP2_EXCLUSIVE_THREAD   2

Definition at line 216 of file COP2_Common.h.

#define COP2_FRAME_PAGE_NAME   "Frame Scope"

Definition at line 24 of file COP2_Common.h.

#define COP2_GEN_IMAGE_COUNT   16

Definition at line 19 of file COP2_Common.h.

#define COP2_GEN_IMAGE_PAGE   "Image"

Definition at line 18 of file COP2_Common.h.

#define COP2_GEN_MASK_COUNT   4

Definition at line 17 of file COP2_Common.h.

#define COP2_GEN_SEQUENCE_COUNT   8

Definition at line 21 of file COP2_Common.h.

#define COP2_GEN_SEQUENCE_PAGE   "Sequence"

Definition at line 20 of file COP2_Common.h.

#define COP2_GENERATOR_SWITCHER	(		count,
			name
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count, name),                       \
                PRM_Default(COP2_GEN_MASK_COUNT, COP2_MASK_PAGE_NAME), \
                PRM_Default(COP2_GEN_IMAGE_COUNT, COP2_GEN_IMAGE_PAGE), \
                PRM_Default(COP2_GEN_SEQUENCE_COUNT, COP2_GEN_SEQUENCE_PAGE) }

Definition at line 65 of file COP2_Common.h.

#define COP2_GENERATOR_SWITCHER2	(		count1,
			name1,
			count2,
			name2
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(COP2_GEN_MASK_COUNT, COP2_MASK_PAGE_NAME), \
                PRM_Default(COP2_GEN_IMAGE_COUNT, COP2_GEN_IMAGE_PAGE), \
                PRM_Default(COP2_GEN_SEQUENCE_COUNT, COP2_GEN_SEQUENCE_PAGE) }

Definition at line 72 of file COP2_Common.h.

#define COP2_GENERATOR_SWITCHER3	(		count1,
			name1,
			count2,
			name2,
			count3,
			name3
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(count3, name3),                     \
                PRM_Default(COP2_GEN_MASK_COUNT, COP2_MASK_PAGE_NAME), \
                PRM_Default(COP2_GEN_IMAGE_COUNT, COP2_GEN_IMAGE_PAGE), \
                PRM_Default(COP2_GEN_SEQUENCE_COUNT, COP2_GEN_SEQUENCE_PAGE) }

Definition at line 80 of file COP2_Common.h.

#define COP2_MASK_EXTRAS   (COP2_PIXEL_FIRST_EXTRAS+5)

Definition at line 126 of file COP2_Common.h.

#define COP2_MASK_PAGE_NAME   "Mask"

Definition at line 16 of file COP2_Common.h.

#define COP2_MASK_SWITCHER	(		count,
			name
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count, name),       \
                PRM_Default(COP2_MASK_EXTRAS, COP2_MASK_PAGE_NAME),   \
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Examples:

COP2/COP2_FullImageFilter.C, and COP2/COP2_SampleFilter.C.

Definition at line 128 of file COP2_Common.h.

#define COP2_MASK_SWITCHER2	(		count1,
			name1,
			count2,
			name2
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),     \
                PRM_Default(count2, name2),     \
                PRM_Default(COP2_MASK_EXTRAS, COP2_MASK_PAGE_NAME),   \
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Definition at line 134 of file COP2_Common.h.

#define COP2_MASK_SWITCHER3	(		count1,
			name1,
			count2,
			name2,
			count3,
			name3
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),     \
                PRM_Default(count2, name2),     \
                PRM_Default(count3, name3),     \
                PRM_Default(COP2_MASK_EXTRAS, COP2_MASK_PAGE_NAME),   \
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Definition at line 141 of file COP2_Common.h.

#define COP2_MULTI_MERGE_COUNT   5

Definition at line 23 of file COP2_Common.h.

#define COP2_MULTI_MERGE_PAGE   "Merge"

Definition at line 22 of file COP2_Common.h.

#define COP2_MULTI_SWITCHER	(		count,
			name
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count, name),                       \
                PRM_Default(COP2_MULTI_MERGE_COUNT, COP2_MULTI_MERGE_PAGE) }

Definition at line 90 of file COP2_Common.h.

#define COP2_MULTI_SWITCHER2	(		count1,
			name1,
			count2,
			name2
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(COP2_MULTI_MERGE_COUNT, COP2_MULTI_MERGE_PAGE) }

Definition at line 95 of file COP2_Common.h.

#define COP2_MULTI_SWITCHER3	(		count1,
			name1,
			count2,
			name2,
			count3,
			name3
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(count3, name3),                     \
                PRM_Default(COP2_MULTI_MERGE_COUNT, COP2_MULTI_MERGE_PAGE) }

Definition at line 102 of file COP2_Common.h.

#define COP2_MULTITHREADED   0

Definition at line 214 of file COP2_Common.h.

#define COP2_PARM_ALL_VOLITILE   3

Definition at line 222 of file COP2_Common.h.

#define COP2_PARM_IMAGE   1

Definition at line 220 of file COP2_Common.h.

#define COP2_PARM_NONVOLITILE   0

Definition at line 219 of file COP2_Common.h.

#define COP2_PARM_TIMING   2

Definition at line 221 of file COP2_Common.h.

#define COP2_PIXEL_EXTRAS   11

Definition at line 110 of file COP2_Common.h.

#define COP2_PIXEL_FIRST_EXTRAS   2

Definition at line 111 of file COP2_Common.h.

#define COP2_PIXEL_FRAME_EXTRAS   9

Definition at line 112 of file COP2_Common.h.

#define COP2_PIXEL_OP_EXTRAS   2

Definition at line 150 of file COP2_Common.h.

#define COP2_PIXEL_OP_SWITCHER	(		count,
			name
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count+COP2_PIXEL_OP_EXTRAS, name),  \
                PRM_Default(COP2_MASK_EXTRAS, COP2_MASK_PAGE_NAME),   \
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Definition at line 152 of file COP2_Common.h.

#define COP2_PIXEL_OP_SWITCHER2	(		count1,
			name1,
			count2,
			name2
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2+COP2_PIXEL_OP_EXTRAS, name2),        \
                PRM_Default(COP2_MASK_EXTRAS, COP2_MASK_PAGE_NAME),   \
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Definition at line 158 of file COP2_Common.h.

#define COP2_PIXEL_SWITCHER	(		count,
			name
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count+COP2_PIXEL_FIRST_EXTRAS, name),\
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Definition at line 114 of file COP2_Common.h.

#define COP2_PIXEL_SWITCHER2	(		count1,
			name1,
			count2,
			name2
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2+COP2_PIXEL_FIRST_EXTRAS, name2),\
                PRM_Default(COP2_PIXEL_FRAME_EXTRAS, COP2_FRAME_PAGE_NAME) }

Definition at line 119 of file COP2_Common.h.

#define COP2_SINGLE_THREAD   1

Definition at line 215 of file COP2_Common.h.

#define COP2_SWITCHER	(		count,
			name
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count, name) }

Definition at line 33 of file COP2_Common.h.

#define COP2_SWITCHER2	(		count1,
			name1,
			count2,
			name2
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2) }

Definition at line 37 of file COP2_Common.h.

#define COP2_SWITCHER3	(		count1,
			name1,
			count2,
			name2,
			count3,
			name3
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(count3, name3) }

Definition at line 42 of file COP2_Common.h.

#define COP2_SWITCHER4	(		count1,
			name1,
			count2,
			name2,
			count3,
			name3,
			count4,
			name4
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(count3, name3),                     \
                PRM_Default(count4, name4) }

Definition at line 48 of file COP2_Common.h.

#define COP2_SWITCHER5	(		count1,
			name1,
			count2,
			name2,
			count3,
			name3,
			count4,
			name4,
			count5,
			name5
	)

Value:

static PRM_Default switcher[] = {                       \
                PRM_Default(count1, name1),                     \
                PRM_Default(count2, name2),                     \
                PRM_Default(count3, name3),                     \
                PRM_Default(count4, name4),                     \
                PRM_Default(count5, name5) }

Definition at line 55 of file COP2_Common.h.

#define DEFAULT_ALPHA_NAME   "A"

Definition at line 170 of file COP2_Common.h.

#define DEFAULT_BLUE_NAME   "B"

Definition at line 168 of file COP2_Common.h.

#define DEFAULT_COLOR_NAME   "C"

Definition at line 165 of file COP2_Common.h.

#define DEFAULT_DEPTH_NAME   "Z"

Definition at line 172 of file COP2_Common.h.

#define DEFAULT_GREEN_NAME   "G"

Definition at line 167 of file COP2_Common.h.

#define DEFAULT_LUMINANCE_NAME   "Y"

Definition at line 171 of file COP2_Common.h.

#define DEFAULT_RED_NAME   "R"

Definition at line 166 of file COP2_Common.h.

#define DEFAULT_STENCIL_NAME   "S"

Definition at line 173 of file COP2_Common.h.

#define ICON_PREVIEW_ALPHA   1

Definition at line 209 of file COP2_Common.h.

#define ICON_PREVIEW_DEPTH   2

Definition at line 210 of file COP2_Common.h.

#define ICON_PREVIEW_LUM   3

Definition at line 211 of file COP2_Common.h.

#define ICON_PREVIEW_RGB   0

Definition at line 208 of file COP2_Common.h.

#define IMAGE_UNIT_PIXEL   1

Definition at line 177 of file COP2_Common.h.

#define IMAGE_UNIT_UV   0

Definition at line 176 of file COP2_Common.h.

#define PLANE_DEPTH_DEMOTE   1

Definition at line 186 of file COP2_Common.h.

#define PLANE_DEPTH_FIRST   2

Definition at line 187 of file COP2_Common.h.

#define PLANE_DEPTH_MISMATCH_ERROR   3

Definition at line 188 of file COP2_Common.h.

#define PLANE_DEPTH_PROMOTE   0

Definition at line 185 of file COP2_Common.h.

#define PLANE_MERGE_ALL   0

Definition at line 180 of file COP2_Common.h.

#define PLANE_MERGE_COMMON   1

Definition at line 181 of file COP2_Common.h.

#define PLANE_MERGE_FIRST   2

Definition at line 182 of file COP2_Common.h.

#define POPUP_PARM   PRM_Template::PRM_EXPORT_MAX

Examples:

COP2/COP2_MultiInputWipe.C.

Definition at line 27 of file COP2_Common.h.

#define SEQUENCE_FRAME_NEAREST   0

Definition at line 203 of file COP2_Common.h.

#define SEQUENCE_FRAME_NEXT   2

Definition at line 205 of file COP2_Common.h.

#define SEQUENCE_FRAME_PREVIOUS   1

Definition at line 204 of file COP2_Common.h.

#define SEQUENCE_RANGE_EXTEND_MAX   2

Definition at line 193 of file COP2_Common.h.

#define SEQUENCE_RANGE_SHIFT_FIRST   1

Definition at line 192 of file COP2_Common.h.

#define SEQUENCE_RANGE_TRIM_FIRST   0

Definition at line 191 of file COP2_Common.h.

#define SEQUENCE_RANGE_TRIM_MIN   3

Definition at line 194 of file COP2_Common.h.

#define SEQUENCE_RATE_FIRST   0

Definition at line 197 of file COP2_Common.h.

#define SEQUENCE_RATE_HIGHEST   1

Definition at line 198 of file COP2_Common.h.

#define SEQUENCE_RATE_LOWEST   2

Definition at line 199 of file COP2_Common.h.

#define SEQUENCE_RATE_MISMATCH_ERROR   3

Definition at line 200 of file COP2_Common.h.

#define SHIFT_ABS_END   2

Definition at line 232 of file COP2_Common.h.

#define SHIFT_ABS_START   1

Definition at line 231 of file COP2_Common.h.

#define SHIFT_ALIGN_END_END   1

Definition at line 226 of file COP2_Common.h.

#define SHIFT_ALIGN_END_START   2

Definition at line 227 of file COP2_Common.h.

#define SHIFT_ALIGN_START_END   3

Definition at line 228 of file COP2_Common.h.

#define SHIFT_ALIGN_START_START   0

Definition at line 225 of file COP2_Common.h.

#define SHIFT_REL_TO_START   0

Definition at line 230 of file COP2_Common.h.

#define TOOL_PARM   PRM_Template::PRM_EXPORT_TBX

Examples:

COP2/COP2_FullImageFilter.C, COP2/COP2_MultiInputWipe.C, COP2/COP2_PixelAdd.C, COP2/COP2_SampleFilter.C, and COP2/COP2_SampleGenerator.C.

Definition at line 26 of file COP2_Common.h.

#define TRIM_ABS   1

Definition at line 236 of file COP2_Common.h.

#define TRIM_REL   0

Definition at line 235 of file COP2_Common.h.

#define TRIM_SINGLE   2

Definition at line 237 of file COP2_Common.h.

#define TRIM_SINGLE_END   4

Definition at line 239 of file COP2_Common.h.

#define TRIM_SINGLE_START   3

Definition at line 238 of file COP2_Common.h.

Enumeration Type Documentation

enum COP2_ColorComponent

Enumerator
COP2_RED
COP2_GREEN
COP2_BLUE
COP2_ALPHA
COP2_HUE
COP2_SATURATION
COP2_VALUE
COP2_LUMINANCE
COP2_NUM_COLOR_COMPONENTS

Definition at line 256 of file COP2_Common.h.

enum COP2_OpColorType

Enumerator
COP2_COLOR_GENERATOR
COP2_COLOR_TIMING
COP2_COLOR_PIXELOP
COP2_COLOR_VEX

Definition at line 242 of file COP2_Common.h.

enum COP2_ThreadPref

Enumerator
COP2_THREAD_NO_PREF
COP2_THREAD_SINGLE
COP2_THREAD_MULTI

Definition at line 249 of file COP2_Common.h.

enum COP2_UIChangeType

Enumerator
COP2_UICHANGE_DISK_CACHE

Definition at line 268 of file COP2_Common.h.