Table of contents

Supported versions

The plugin is deployed supporting several Katana builds versions. The available plugin versions are located in the Redshift main installation folder:

  • Windows: C:\ProgramData\Redshift\Plugins\Katana

  • Linux:  /usr/redshift/redshift4katana

The Redshift for Katana plugin should be used only with the proper Katana buildsThis is the list of the current released plugin versions:

  • Katana 2.5v4

  • Katana 2.6v1 (compatible with all the Katana 2.6 versions)

  • Katana 3.0v1 (compatible with all the Katana 3.0 and 3.1 versions)

Plugin installation

Linux

Run the .run file. After installation, Redshift and the Katana plugin will be installed in the /usr/redshift default folder. The Katana plugin will be in the subfolder redshift4katanaTo use Redshift with Katana, you'll need to edit the Katana launch script file to include the following lines, just before the katana launch exec line:

#render plugins
export LD_LIBRARY_PATH="/usr/redshift/bin:${LD_LIBRARY_PATH}"
export KATANA_RESOURCES=/usr/redshift/redshift4katana/katana2.5v4
export DEFAULT_RENDERER=Redshift

The above example shows an installation for Katana 2.5v4 in the default Redshift install location. Depending on your Katana version, please change the version number shown in KATANA_RESOURCES.

Windows

Run the exe file. After installation, Redshift and the Katana plugin will be installed in the C:\ProgramData\Redshift default folder. The Katana plugin will be in the subfolder Plugins\Katana.  Log files, your license file (if using a node-locked license) and the Redshift preferences file are also stored in C:\ProgramData\RedshiftTo use Redshift with Katana, you'll need to edit your Katana launch script .bat file to include the plugin configuration variables. Inside the plugin folder there is a standard script file (launchRedshift4Katana.bat ) that you can use as reference:

rem Redshift for Katana script

set "KATANA_VERSION=2.5v4"

set "KATANA_HOME=C:\Program Files\Katana%KATANA_VERSION%"
set "REDSHIFT_HOME=C:\ProgramData\Redshift\bin"
set "REDSHIFT4KATANA_HOME=C:\ProgramData\Redshift\Plugins\Katana\%KATANA_VERSION%"

set DEFAULT_RENDERER=Redshift
set "KATANA_TAGLINE=With Redshift 2.5"

set REDSHIFT_CACHE_BUDGET=
set REDSHIFT_CACHE_FOLDER=
set REDSHIFT_SELECTED_CUDA_DEVICES=

set "path=%REDSHIFT_HOME%;%path%"
set "KATANA_RESOURCES=%REDSHIFT4KATANA_HOME%"
"%KATANA_HOME%\bin\katanaBin.exe"

 

The above example shows an installation for Katana 2.5v4 in the default Redshift install location. Depending on your Katana version, please change the version number shown in KATANA_VERSION.

Environment Variables

The Katana plugin can get some configuration parameters from environment variables, that can be defined in the Katana launch script. The plugin supports these variables:

  • REDSHIFT_CACHE_BUDGET

    • Numeric variable to configure the texture cache max. size (in GB) 

  • REDSHIFT_CACHE_FOLDER

    • String variable to configure the cache folder path

  • REDSHIFT_SELECTED_CUDA_DEVICES

    • Binary variable to configure the GPUs rendering enable state. For example if the computer has four GPUs and you want to disable the first one for rendering, you can set this variable to 0111