HISE Docs

Development Settings

Compiler

Hise Path

This is the path to the source code of HISE. It must be the root folder of the repository (so that the folders hi_core , hi_modules etc. are immediate child folders.
This will be used for the compilation of the exported plugins and also contains all necessary SDKs (ASIO, VST, etc).

Always make sure you are using the exact same source code that was used to build HISE or there will be unpredicatble issues.

Visual Studio Version

Set the VS version that you've installed. Make sure you always use the latest one, since I need to regularly deprecate the oldest version

Use IPP

If enabled, HISE uses the FFT routines from the Intel Performance Primitive library (which can be downloaded for free) in order to speed up the convolution reverb

If you use the convolution reverb in your project, this is almost mandatory, but there are a few other places that benefit from having this library

Legacy CPUSupport

If enabled, then all SSE instructions are replaced by their native implementation. This can be used to compile a version that runs on legacy CPU models.

Rebuild Pool Files

If enabled, the pool files for SampleMaps, AudioFiles and Images are deleted and rebuild everytime you export a plugin.You can turn this off in order to speed up compilation times, however be aware that in this case you need to delete them manuallywhenever you change the referenced data in any way or it will use the deprecated cached files.

Support32 Bit Mac OS

If enabled (which is still the default), the compiler will build both 32bit and 64bit versions as universal binary on macOS. However since 32bit binaries are deprecated in the most recent versions of macOS / XCode, you can tell the exporter to just generate 64bit binaries by disabling this flag. If you see this error messag in the compile terminal:

error: The i386 architecture is deprecated. You should update your ARCHS build setting to remove the i386 architecture.

Just disable this flag and try again.

Custom Node Path

This is the path to the directory where the additional nodes are stored. If you want to use this feature, recompile HISE with the HI_ENABLE_CUSTOM_NODES flag.

Faust Path

Set the path to your Faust installation here. It will be used to look up the standard faust libraries on platforms which don't have a default path. There should be at least the following directories inside: "share", "lib", "include"

Faust External Editor

If enabled, the edit button in the faust node will launch an external editor for editing the faust source files. If disabled, it will use a FaustCodeEditor floating tile

Enable Loris

If you want to use the Loris toolkit in HISE, you need to enable this setting and download and copy the Loris DLL to the expected location

The repository can be found here: https://github.com/christophhart/loris-tools/

Default Project Folder

This folder will be selected as default root folder when loading or creating new projects.

You can set it to the root folder of all your HISE work and it will speed up loading / creating new projects

Scripting

Enable Callstack

This enables a stacktrace that shows the order of function calls that lead to the error (or breakpoint).

Example:

Interface: Breakpoint 1 was hit 
:  someFunction() - Line 5, column 18
:  onNoteOn() - Line 3, column 2

A breakpoint was set on the function someFunction You can see in the stacktrace that it was called in the onNoteOn callback.
Double clicking on the line in the console jumps to each location.

Enable Optimizations

Enables some compiler optimizations like constant folding or dead code removal for the HiseScript compiler

This setting is baked into a plugin when you compile it

Global Script Path

There is a folder that can be used to store global script files like additional API functions or generic UI Component definitions.By default, this folder is stored in the application data folder, but you can choose to redirect it to another location, which may be useful if you want to put it under source control.You can include scripts that are stored in this location by using the {GLOBAL_SCRIPT_FOLDER} wildcard:javascript// Includes 'File.js'include("{GLOBAL_SCRIPT_FOLDER}File.js");

Compile Timeout

Sets the timeout for the compilation of a script in seconds . Whenever the compilation takes longer, it will abort and show a error message.This prevents hanging if you accidentally create endless loops like this:

while(true)
 x++;

Code Font Size

Changes the default font size for the console, all code editors and the script watch table

You can temporarily change the font size for individual elements using Cmd+Scrollwheel, however this will not be persistent.

Enable Debug Mode

This enables the debug logger which creates a log file containing performance issues and system specifications.It's the same functionality as found in the compiled plugins.

Save Connected Files On Compile

If this is enabled, it will save a connected script file everytime the script is compiled. By default this is disabled, but if you want to apply changes to a connected script file, you will have to enable this setting

Enable Mouse Positioning

Sets the default value of whether the interface designer should allow dragging UI components with the mouse

This was always enabled, but on larger projects it's easy to accidentally drag UI elements when you really just wanted to select them so this gives you the option to remove the dragging.

Note that you can always choose to enable / disable dragging in the interface designer menu bar, and this only sets the default value. It's still enabled by default so the HISE forum doesn't get swamped with bug reports that the interface designer stopped working...

Warn If Undefined Parameters

If enabled, it will print a warning with a callstack if you try to call a function
on a dynamic object reference with an undefined function.

This only works if you haven't set HISE_WARN_UNDEFINED_PARAMETER_CALLS to 0, then it will just abort execution and throw an error

Other

Use Open GL

Enable this in order to use OpenGL for the UI rendering of the HISE app. This might drastically accelerate the UI performance, so if you have a laggy UI in HISE, try this option

Be aware that this does not affect whether your compiled project uses OpenGL (as this can be defined separately).

Global Sample Path

If you want to redirect all sample locations to a global sample path (eg. on a dedicated hard drive or the Dropbox folder), you can set it here.Then you can just put a redirection file using the {GLOBAL_SAMPLE_FOLDER} wildcard into each sample folder that you want to redirect

Enable Autosave

The autosave function will store up to 5 archive files called AutosaveXXX.hip in the archive folder of the project.In a rare and almost never occuring event of a crash, this might be your saviour...

Autosave Interval

The interval for the autosaver in minutes. This must be a number between 1 and 30 .

Audio Thread Guard Enabled

Watches for illegal calls in the audio thread. Use this during script development to catch allocations etc.

External Editor Path

You can specifiy the executable of an audio editor here and then use the button in the sample editor to open the currently selected files in the editor

You can use any editor that accepts filenames as command-line argument

Auto Show Workspace

If this is activated, clicking on a workspace icon (or loading a new patch) will ensure that the workspace is visible (so if it's folded, it will be unfolded.

Disable this setting if you are using a custom workspace environment with a second window.

Enable Shader Line Numbers

Enables proper support for line numbers when editing GLSL shader files. This injects a #line preprocessor before your code so that the line numbers will be displayed correctly.

Old graphic cards (eg. the integrated Intel HD ones) do not support this, so if you get a weird GLSL compile error, untick this line.

Show Welcome Screen

If enabled, then HISE will show a welcome screen at startup.

Global Hise Scale Factor

This changes the global scale factor for all UI elements in HISE. Beware that this might result in a few glitches under certain conditions so if you experience some UI funkiness, revert it back to 100%.

Note that this setting cannot be used in combination with the OpenGL renderer.

Documentation

Doc Repository

The folder of the hise_documentation repository. If you want to contribute to the documentation you can setup this folder.Otherwise it will use the cached version that was downloaded from the HISE doc server

Refresh On Startup

If enabled, HISE will download the latest documentation files from the server when you start HISE. It needs an internet connection for thisIt will download two files, Content.dat and Images.dat , which contain a compressed version of the HISE documentation