/[svn]/linuxsampler/trunk/src/scriptvm/ScriptVM.h
ViewVC logotype

Diff of /linuxsampler/trunk/src/scriptvm/ScriptVM.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2947 by schoenebeck, Thu Jul 14 00:22:26 2016 UTC revision 2948 by schoenebeck, Fri Jul 15 15:29:04 2016 UTC
# Line 194  namespace LinuxSampler { Line 194  namespace LinuxSampler {
194          std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;          std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;
195    
196          /**          /**
197           * Returns all built-in constant integer script variables, which can           * Returns all built-in constant integer script variables, which are
198           * only be read, but not be altered by scripts. This method returns a           * constant and their final data is already available at parser time
199           * STL map, where the map's key is the variable name and the map's value           * and won't change during runtime. Providing your built-in constants
200           * is the native pointer to the actual built-in constant variable.           * this way may lead to performance benefits compared to using other
201             * ways of providing built-in variables, because the script parser
202             * can perform optimizations when the script is refering to such
203             * constants.
204             *
205             * This type of built-in variable can only be read, but not be altered
206             * by scripts. This method returns a STL map, where the map's key is
207             * the variable name and the map's value is the final constant data.
208           *           *
209           * This method is re-implemented by deriving classes to add more use           * This method is re-implemented by deriving classes to add more use
210           * case specific built-in constant integers.           * case specific built-in constant integers.
211           *           *
212           * @b Note: the term "constant" is a bit misleading here, since           * @b Note: In case your built-in variable should be read-only but its
213           * built-in constant integer variables may indeed change, i.e. for           * value is not already available at parser time (i.e. because its
214           * built-in constant integers which i.e. reflect some kind of status of           * value may change at runtime), then you should add it to
215           * the sampler. So rather see them as "read only" variables, not as           * builtInIntVariables() instead and use the macro
216           * being actually consistent in time.           * DECLARE_VMINT_READONLY() to define the variable for read-only
217             * access by scripts.
218           */           */
219          std::map<String,int> builtInConstIntVariables() OVERRIDE;          std::map<String,int> builtInConstIntVariables() OVERRIDE;
220    
Legend:
Removed from v.2947  
changed lines
  Added in v.2948
  ViewVC Help
Powered by ViewVC