MeiCam SDK For iOS  3.14.0
NvsEffectDescription.h
Go to the documentation of this file.
1 //================================================================================
2 //
3 // (c) Copyright Meishe Co. Ltd, 2016. All rights reserved.
4 //
5 // This code and information is provided "as is" without warranty of any kind,
6 // either expressed or implied, including but not limited to the implied
7 // warranties of merchantability and/or fitness for a particular purpose.
8 //
9 //--------------------------------------------------------------------------------
10 // Birth Date: Sep 7. 2019
11 // Author: Meishe video team
12 //================================================================================
13 
14 #pragma once
15 
16 #import <Foundation/Foundation.h>
17 #import "NvsEffectCommonDef.h"
18 
27 #define NVS_PARAM_TYPE_INT @"INT"
29 #define NVS_PARAM_TYPE_FLOAT @"FLOAT"
30 #define NVS_PARAM_TYPE_BOOL @"BOOL"
31 #define NVS_PARAM_TYPE_MENU @"MENU"
32 #define NVS_PARAM_TYPE_STRING @"STRING"
33 #define NVS_PARAM_TYPE_COLOR @"COLOR"
34 #define NVS_PARAM_TYPE_POSITION2D @"POSITION2D"
35 #define NVS_PARAM_TYPE_POSITION3D @"POSITION3D"
36 #define NVS_PARAM_TYPE_ARBITRARY @"ARBITRARY"
37 
38 
40 #define NVS_PARAM_NAME @"paramName"
41 
42 
48 #define NVS_PARAM_TYPE @"paramType"
49 
57 #define NVS_PARAM_INT_DEF_VAL @"intDefVal"
59 #define NVS_PARAM_INT_MIN_VAL @"intMinVal"
60 #define NVS_PARAM_INT_MAX_VAL @"intMaxVal"
61 
69 #define NVS_PARAM_FLOAT_DEF_VAL @"floatDefVal"
71 #define NVS_PARAM_FLOAT_MIN_VAL @"floatMinVal"
72 #define NVS_PARAM_FLOAT_MAX_VAL @"floatMaxVal"
73 
81 #define NVS_PARAM_BOOL_DEF_VAL @"boolDefVal"
82 
89 #define NVS_PARAM_COLOR_DEF_R @"colorDefR"
91 #define NVS_PARAM_COLOR_DEF_G @"colorDefG"
92 #define NVS_PARAM_COLOR_DEF_B @"colorDefB"
93 #define NVS_PARAM_COLOR_DEF_A @"colorDefA"
94 
102 #define NVS_PARAM_POSITION2D_DEF_X @"position2DDefX"
104 #define NVS_PARAM_POSITION2D_DEF_Y @"position2DDefY"
105 
113 #define NVS_PARAM_POSITION3D_DEF_X @"position3DDefX"
115 #define NVS_PARAM_POSITION3D_DEF_Y @"position3DDefY"
116 #define NVS_PARAM_POSITION3D_DEF_Z @"position3DDefZ"
117 
126 #define NVS_PARAM_STRING_TYPE @"stringType"
127 
135 #define NVS_PARAM_STRING_DEF @"stringDef"
136 
144 #define NVS_PARAM_MENU_DEF_VAL @"menuDefVal"
145 
153 #define NVS_PARAM_MENU_ARRAY @"menuArray"
154 
161 typedef enum
162 {
170 
183 NVS_EXPORT @interface NvsEffectDescription : NSObject
184 
185 @property (readonly) NSString *name;
186 
253 - (NSArray *)getAllParamsInfo;
254 
255 @end
NvsEffectDescription
Effect parameter description class in effect sdk.
Definition: NvsEffectDescription.h:184
NvsFxStringParamType_Label
@ NvsFxStringParamType_Label
Label.
Definition: NvsEffectDescription.h:168
NvsFxStringParamType_DirectoryPath
@ NvsFxStringParamType_DirectoryPath
Directory path.
Definition: NvsEffectDescription.h:167
NvsEffectDescription::name
NSString * name
Effect name.
Definition: NvsEffectDescription.h:185
NvsFxStringParamType_FilePath
@ NvsFxStringParamType_FilePath
File path.
Definition: NvsEffectDescription.h:166
NvsFxStringParamType_SingleLine
@ NvsFxStringParamType_SingleLine
Single line.
Definition: NvsEffectDescription.h:164
NvsFxStringParamType_Invalid
@ NvsFxStringParamType_Invalid
Invalid.
Definition: NvsEffectDescription.h:163
NVS_EXPORT
#define NVS_EXPORT
Definition: NvsCommonDef.h:20
NvsFxStringParamType
NvsFxStringParamType
Effect string parameter type.
Definition: NvsEffectDescription.h:162
NvsFxStringParamType_MultiLine
@ NvsFxStringParamType_MultiLine
Multiple line.
Definition: NvsEffectDescription.h:165
NvsEffectCommonDef.h
-[NvsEffectDescription getAllParamsInfo]
NSArray * getAllParamsInfo()
Gets all the effect parameter information.