NvsEffectDescription.h File Reference

#import <Foundation/Foundation.h>
#import "NvsEffectCommonDef.h"

Go to the source code of this file.

Classes
class	NvsEffectDescription
	Effect parameter description class in effect sdk. More...

Macros
#define	NVS_PARAM_NAME   @"paramName"
	Effect parameter name. More...
#define	NVS_PARAM_TYPE   @"paramType"
	Special effect parameter type More...
effect parameter type
#define	NVS_PARAM_TYPE_INT   @"INT"
	int type More...
#define	NVS_PARAM_TYPE_FLOAT   @"FLOAT"
	float type More...
#define	NVS_PARAM_TYPE_BOOL   @"BOOL"
	bool type More...
#define	NVS_PARAM_TYPE_MENU   @"MENU"
	menu type More...
#define	NVS_PARAM_TYPE_STRING   @"STRING"
	string type More...
#define	NVS_PARAM_TYPE_COLOR   @"COLOR"
	color type More...
#define	NVS_PARAM_TYPE_POSITION2D   @"POSITION2D"
	2D coordinates type More...
#define	NVS_PARAM_TYPE_POSITION3D   @"POSITION3D"
	3D coordinates type More...
#define	NVS_PARAM_TYPE_ARBITRARY   @"ARBITRARY"
	custom arbitrary data type More...
The default value and value range of the effect parameter of integer type
#define	NVS_PARAM_INT_DEF_VAL   @"intDefVal"
#define	NVS_PARAM_INT_MIN_VAL   @"intMinVal"
#define	NVS_PARAM_INT_MAX_VAL   @"intMaxVal"
The effect's float type parameter default value and value range
#define	NVS_PARAM_FLOAT_DEF_VAL   @"floatDefVal"
#define	NVS_PARAM_FLOAT_MIN_VAL   @"floatMinVal"
#define	NVS_PARAM_FLOAT_MAX_VAL   @"floatMaxVal"
The effect's default boolean type parameter value
#define	NVS_PARAM_BOOL_DEF_VAL   @"boolDefVal"
The effect's color type parameter value
#define	NVS_PARAM_COLOR_DEF_R   @"colorDefR"
#define	NVS_PARAM_COLOR_DEF_G   @"colorDefG"
#define	NVS_PARAM_COLOR_DEF_B   @"colorDefB"
#define	NVS_PARAM_COLOR_DEF_A   @"colorDefA"
The effect's 2D coordinates type default value
#define	NVS_PARAM_POSITION2D_DEF_X   @"position2DDefX"
#define	NVS_PARAM_POSITION2D_DEF_Y   @"position2DDefY"
The effect's 3D coordinates type default value
#define	NVS_PARAM_POSITION3D_DEF_X   @"position3DDefX"
#define	NVS_PARAM_POSITION3D_DEF_Y   @"position3DDefY"
#define	NVS_PARAM_POSITION3D_DEF_Z   @"position3DDefZ"
Effect string parameter type,please refer to @ref NvsFxStringParamType "NvsFxStringParamType"。
#define	NVS_PARAM_STRING_TYPE   @"stringType"
Effect string parameter default value.
#define	NVS_PARAM_STRING_DEF   @"stringDef"
Effect menu parameter default value.
#define	NVS_PARAM_MENU_DEF_VAL   @"menuDefVal"

Effect menu parameter array.
#define	NVS_PARAM_MENU_ARRAY   @"menuArray"
enum	NvsFxStringParamType {   NvsFxStringParamType_Invalid = -1, NvsFxStringParamType_SingleLine = 0, NvsFxStringParamType_MultiLine, NvsFxStringParamType_FilePath,   NvsFxStringParamType_DirectoryPath, NvsFxStringParamType_Label }
	Effect string parameter type. More...

Macro Definition Documentation

NVS_PARAM_BOOL_DEF_VAL

#define NVS_PARAM_BOOL_DEF_VAL   @"boolDefVal"

NVS_PARAM_COLOR_DEF_A

#define NVS_PARAM_COLOR_DEF_A   @"colorDefA"

NVS_PARAM_COLOR_DEF_B

#define NVS_PARAM_COLOR_DEF_B   @"colorDefB"

NVS_PARAM_COLOR_DEF_G

#define NVS_PARAM_COLOR_DEF_G   @"colorDefG"

NVS_PARAM_COLOR_DEF_R

#define NVS_PARAM_COLOR_DEF_R   @"colorDefR"

NVS_PARAM_FLOAT_DEF_VAL

#define NVS_PARAM_FLOAT_DEF_VAL   @"floatDefVal"

NVS_PARAM_FLOAT_MAX_VAL

#define NVS_PARAM_FLOAT_MAX_VAL   @"floatMaxVal"

NVS_PARAM_FLOAT_MIN_VAL

#define NVS_PARAM_FLOAT_MIN_VAL   @"floatMinVal"

NVS_PARAM_INT_DEF_VAL

#define NVS_PARAM_INT_DEF_VAL   @"intDefVal"

NVS_PARAM_INT_MAX_VAL

#define NVS_PARAM_INT_MAX_VAL   @"intMaxVal"

NVS_PARAM_INT_MIN_VAL

#define NVS_PARAM_INT_MIN_VAL   @"intMinVal"

NVS_PARAM_MENU_ARRAY

#define NVS_PARAM_MENU_ARRAY   @"menuArray"

NVS_PARAM_MENU_DEF_VAL

#define NVS_PARAM_MENU_DEF_VAL   @"menuDefVal"

NVS_PARAM_NAME

#define NVS_PARAM_NAME   @"paramName"

Effect parameter name.

NVS_PARAM_POSITION2D_DEF_X

#define NVS_PARAM_POSITION2D_DEF_X   @"position2DDefX"

NVS_PARAM_POSITION2D_DEF_Y

#define NVS_PARAM_POSITION2D_DEF_Y   @"position2DDefY"

NVS_PARAM_POSITION3D_DEF_X

#define NVS_PARAM_POSITION3D_DEF_X   @"position3DDefX"

NVS_PARAM_POSITION3D_DEF_Y

#define NVS_PARAM_POSITION3D_DEF_Y   @"position3DDefY"

NVS_PARAM_POSITION3D_DEF_Z

#define NVS_PARAM_POSITION3D_DEF_Z   @"position3DDefZ"

NVS_PARAM_STRING_DEF

#define NVS_PARAM_STRING_DEF   @"stringDef"

NVS_PARAM_STRING_TYPE

#define NVS_PARAM_STRING_TYPE   @"stringType"

NVS_PARAM_TYPE

#define NVS_PARAM_TYPE   @"paramType"

Special effect parameter type

NVS_PARAM_TYPE_ARBITRARY

#define NVS_PARAM_TYPE_ARBITRARY   @"ARBITRARY"

custom arbitrary data type

NVS_PARAM_TYPE_BOOL

#define NVS_PARAM_TYPE_BOOL   @"BOOL"

bool type

NVS_PARAM_TYPE_COLOR

#define NVS_PARAM_TYPE_COLOR   @"COLOR"

color type

NVS_PARAM_TYPE_FLOAT

#define NVS_PARAM_TYPE_FLOAT   @"FLOAT"

float type

NVS_PARAM_TYPE_INT

#define NVS_PARAM_TYPE_INT   @"INT"

int type

NVS_PARAM_TYPE_MENU

#define NVS_PARAM_TYPE_MENU   @"MENU"

menu type

NVS_PARAM_TYPE_POSITION2D

#define NVS_PARAM_TYPE_POSITION2D   @"POSITION2D"

2D coordinates type

NVS_PARAM_TYPE_POSITION3D

#define NVS_PARAM_TYPE_POSITION3D   @"POSITION3D"

3D coordinates type

NVS_PARAM_TYPE_STRING

#define NVS_PARAM_TYPE_STRING   @"STRING"

string type

Enumeration Type Documentation

NvsFxStringParamType

enum NvsFxStringParamType

Effect string parameter type.

Enumerator
NvsFxStringParamType_Invalid	Invalid.
NvsFxStringParamType_SingleLine	Single line.
NvsFxStringParamType_MultiLine	Multiple line.
NvsFxStringParamType_FilePath	File path.
NvsFxStringParamType_DirectoryPath	Directory path.
NvsFxStringParamType_Label	Label.