Getting started with Gaffer: Difference between revisions

From Gaffer Wiki
Jump to navigation Jump to search
(Created page with "== Installing Gaffer == === Downloading a release === The latest release is available to download from [https://www.gafferhq.org/download gafferhq.org]. Previous releases can be downloaded from the GitHub [https://github.com/GafferHQ/gaffer/releases releases] page. === Installation === Each Gaffer release is a standalone archive that just requires extraction to the location you wish to run Gaffer from. See the {{GafferDocumentationLink|GettingStarted/InstallingGaffer/...")
 
mNo edit summary
Line 6: Line 6:
=== Installation ===
=== Installation ===
Each Gaffer release is a standalone archive that just requires extraction to the location you wish to run Gaffer from. See the {{GafferDocumentationLink|GettingStarted/InstallingGaffer/index.html|documentation}} for more information.
Each Gaffer release is a standalone archive that just requires extraction to the location you wish to run Gaffer from. See the {{GafferDocumentationLink|GettingStarted/InstallingGaffer/index.html|documentation}} for more information.
On Windows, the [https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 Microsoft Visual C++ Redistributable] must be installed. If you see errors related to missing VCRUNTIME files such as VCRUNTIME140.dll, the redestributable will need to be downloaded and installed before Gaffer can be launched.


=== 3rd party installers ===
=== 3rd party installers ===
Line 27: Line 29:
=== 3Delight ===
=== 3Delight ===
To configure Gaffer to use 3Delight, the <code>DELIGHT</code> environment variable must point to the root directory of the 3Delight release to use. See the Gaffer {{GafferDocumentationLink|GettingStarted/ConfiguringGafferForThirdPartyTools/index.html#configuring-gaffer-for-3delight|documentation}} for more information.
To configure Gaffer to use 3Delight, the <code>DELIGHT</code> environment variable must point to the root directory of the 3Delight release to use. See the Gaffer {{GafferDocumentationLink|GettingStarted/ConfiguringGafferForThirdPartyTools/index.html#configuring-gaffer-for-3delight|documentation}} for more information.
== Running Gaffer ==
=== GUI Mode ===
=== Command line execution ===
To

Revision as of 00:15, 3 November 2024

Installing Gaffer

Downloading a release

The latest release is available to download from gafferhq.org. Previous releases can be downloaded from the GitHub releases page.

Installation

Each Gaffer release is a standalone archive that just requires extraction to the location you wish to run Gaffer from. See the documentation for more information.

On Windows, the Microsoft Visual C++ Redistributable must be installed. If you see errors related to missing VCRUNTIME files such as VCRUNTIME140.dll, the redestributable will need to be downloaded and installed before Gaffer can be launched.

3rd party installers

Brian Hanke maintains a Windows installer that downloads and extracts Gaffer releases. It can be downloaded from GitHub.

Configuring renderers

Cycles

Gaffer comes pre-installed with Cycles, so no additional configuration is required.

To disable Cycles, set the GAFFERCYCLES_HIDE_UI environment variable to 1.

Arnold

Gaffer currently supports both Arnold 7.2.x.x & 7.3.x.x releases. Earlier versions of Arnold are no longer compatible.

Note that Gaffer requires an Arnold SDK release to be installed - a MtoA, HtoA, KtoA etc release will not work.

To configure Gaffer to use Arnold, the ARNOLD_ROOT environment variable must point to the root directory of the Arnold release to use. See the Gaffer documentation for more information.

3Delight

To configure Gaffer to use 3Delight, the DELIGHT environment variable must point to the root directory of the 3Delight release to use. See the Gaffer documentation for more information.

Running Gaffer

GUI Mode

Command line execution

To