Getting started with Gaffer: Difference between revisions
mNo edit summary |
m (→Arnold) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Intro to Gaffer == | |||
{{#ev:vimeo|739829903}} | |||
== Installing Gaffer == | == Installing Gaffer == | ||
| Line 6: | Line 10: | ||
=== 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. | ||
==== Windows ==== | |||
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. | 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. | ||
| Line 21: | Line 27: | ||
=== Arnold === | === Arnold === | ||
Gaffer currently supports | Gaffer currently supports Arnold <code>7.2.x.x,</code> <code>7.3.x.x</code> and <code>7.4.x.x</code> releases. Earlier versions of Arnold are no longer compatible. | ||
{{ info | Note that Gaffer requires an Arnold SDK release to be installed - a MtoA, HtoA, KtoA etc release will not work. }} | {{ info | Note that Gaffer requires an Arnold SDK release to be installed - a MtoA, HtoA, KtoA etc release will not work. }} | ||
| Line 29: | Line 35: | ||
=== 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. | ||
=== RenderMan === | |||
RenderMan support is in active development and can be tested in current Gaffer 1.5 releases by: | |||
* Setting the <code>RMANTREE</code> environment variable to point to the root directory of a RenderMan Pro Server 26.3 installation | |||
* Setting the <code>GAFFERRENDERMAN_FEATURE_PREVIEW</code> environment variable to a value of <code>1</code> | |||
== Running Gaffer == | == Running Gaffer == | ||
| Line 34: | Line 46: | ||
=== GUI Mode === | === GUI Mode === | ||
Gaffer is launched via a wrapper script found in the <code>bin</code> directory, this wrapper is named <code>gaffer</code> on Linux and <code>gaffer.cmd</code> on Windows | |||
==== Linux ==== | |||
{{ info | <code>/opt/gaffer-{{latestGafferVersion}}-linux-gcc11/bin/gaffer</code> }} | |||
==== Windows ==== | |||
{{ info | <code>C:/software/gaffer-{{latestGafferVersion}}-windows/bin/gaffer.cmd</code> }} | |||
=== Command line execution === | === Command line execution === | ||
Gaffer scripts can be executed on the command line via the {{GafferDocumentationLink|Reference/CommandLineReference/execute.html|execute}} app, or dispatched locally or to a render farm via the {{GafferDocumentationLink|Reference/CommandLineReference/dispatch.html|dispatch}} app. | |||
=== Additional utilities === | |||
A Gaffer release includes a number of additional utility applications in the <code>bin</code> directory, such as [https://openusd.org/release/toolset.html#usdview usdview], [https://openimageio.readthedocs.io/en/stable/oiiotool.html oiiotool] and [http://www.alembic.io abcecho]. These tools can be run via the {{GafferDocumentationLink|Reference/CommandLineReference/env.html|env}} app. | |||
{{ info | <code>/opt/gaffer-{{latestGafferVersion}}-linux-gcc11/bin/gaffer env usdview /path/to/file.usda</code> }} | |||
{{ info | <code>/opt/gaffer-{{latestGafferVersion}}-linux-gcc11/bin/gaffer env oiiotool /path/to/image.exr</code> }} | |||
{{ info | <code>/opt/gaffer-{{latestGafferVersion}}-linux-gcc11/bin/gaffer env abcecho /path/to/file.abc</code> }} | |||
Latest revision as of 22:26, 16 April 2025
Intro to Gaffer
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.
Windows
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_UIenvironment variable to1.
Arnold
Gaffer currently supports Arnold 7.2.x.x, 7.3.x.x and 7.4.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.
RenderMan
RenderMan support is in active development and can be tested in current Gaffer 1.5 releases by:
- Setting the
RMANTREEenvironment variable to point to the root directory of a RenderMan Pro Server 26.3 installation - Setting the
GAFFERRENDERMAN_FEATURE_PREVIEWenvironment variable to a value of1
Running Gaffer
GUI Mode
Gaffer is launched via a wrapper script found in the bin directory, this wrapper is named gaffer on Linux and gaffer.cmd on Windows
Linux
/opt/gaffer-1.5.11.0-linux-gcc11/bin/gaffer
Windows
C:/software/gaffer-1.5.11.0-windows/bin/gaffer.cmd
Command line execution
Gaffer scripts can be executed on the command line via the execute app, or dispatched locally or to a render farm via the dispatch app.
Additional utilities
A Gaffer release includes a number of additional utility applications in the bin directory, such as usdview, oiiotool and abcecho. These tools can be run via the env app.
/opt/gaffer-1.5.11.0-linux-gcc11/bin/gaffer env usdview /path/to/file.usda
/opt/gaffer-1.5.11.0-linux-gcc11/bin/gaffer env oiiotool /path/to/image.exr
/opt/gaffer-1.5.11.0-linux-gcc11/bin/gaffer env abcecho /path/to/file.abc