Getting started with Gaffer - Revision history

GafferBot: /* Configuring renderers */

2025-09-03T04:35:28Z

Configuring renderers

← Older revision		Revision as of 21:35, 2 September 2025
Line 37:		Line 37:

	=== RenderMan ===		=== RenderMan ===
	RenderMan support is in active development and can be used in current Gaffer 1.6 releases by:		RenderMan support is in active development and can be used in current Gaffer 1.6 releases by setting the <code>RMANTREE</code> environment variable to point to the root directory of a RenderMan Pro Server 26.3 installation. See the Gaffer {{GafferDocumentationLink\|GettingStarted/ConfiguringGafferForThirdPartyTools/index.html#configuring-gaffer-for-renderman\|documentation}} for more information.

	* Setting the <code>RMANTREE</code> environment variable to point to the root directory of a RenderMan Pro Server 26.3 installation

	== Running Gaffer ==		== Running Gaffer ==

GafferBot: /* RenderMan */

2025-09-03T04:33:13Z

RenderMan

← Older revision		Revision as of 21:33, 2 September 2025
Line 37:		Line 37:

	=== RenderMan ===		=== RenderMan ===
	RenderMan support is in active development and can be ~~tested~~ in current Gaffer 1.5 releases by:		RenderMan support is in active development and can be used in current Gaffer 1.6 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>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 ==

GafferBot: /* Arnold */

2025-09-03T04:32:47Z

Arnold

← Older revision		Revision as of 21:32, 2 September 2025
Line 27:		Line 27:

	=== Arnold ===		=== Arnold ===
	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.		Gaffer currently supports Arnold <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. }}

GafferBot: /* Arnold */

2025-04-17T05:26:59Z

Arnold

← Older revision		Revision as of 22:26, 16 April 2025
Line 27:		Line 27:

	=== Arnold ===		=== Arnold ===
	Gaffer currently supports ~~both~~ Arnold <code>7.2.x.x</code> & <code>7.3.x.x</code> releases. Earlier versions of Arnold are no longer compatible.		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 35:		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 ==

GafferBot at 07:43, 3 November 2024

2024-11-03T07:43:25Z

← Older revision		Revision as of 00:43, 3 November 2024
Line 1:		Line 1:
			== Intro to Gaffer ==

			{{#ev:vimeo\|739829903}}

	== Installing Gaffer ==		== Installing Gaffer ==

GafferBot: /* Additional utilities */

2024-11-03T07:41:05Z

Additional utilities

← Older revision		Revision as of 00:41, 3 November 2024
Line 52:		Line 52:
	=== Additional utilities ===		=== 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\|env}} app.		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 usdview /path/to/file.usda</code> }}

GafferBot: /* Running Gaffer */

2024-11-03T07:40:10Z

Running Gaffer

@@ Line 36: / Line 36: @@
 === GUI Mode ===
 === Command line execution ===
-To
+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.

GafferBot: /* Installing Gaffer */

2024-11-03T07:15:54Z

Installing Gaffer

← Older revision		Revision as of 00:15, 3 November 2024
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.

			==== 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.

GafferBot at 07:15, 3 November 2024

2024-11-03T07:15:09Z

@@ Line 6: / Line 6: @@
 === 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.
 === 3rd party installers ===
@@ Line 27: / Line 29: @@
 === 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.

GafferBot: 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/..."

2024-11-03T07:02:03Z

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/..."

New page

== 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/index.html|documentation}} for more information.

=== 3rd party installers ===

Brian Hanke maintains a Windows installer that downloads and extracts Gaffer releases. It can be downloaded from [https://github.com/BrianHanke/gaffer_windows_installer GitHub].

== Configuring renderers ==

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

{{ info | To disable Cycles, set the <code>GAFFERCYCLES_HIDE_UI</code> environment variable to <code>1</code>. }}

=== Arnold ===
Gaffer currently supports both Arnold <code>7.2.x.x</code> & <code>7.3.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. }}

To configure Gaffer to use Arnold, the <code>ARNOLD_ROOT</code> environment variable must point to the root directory of the Arnold release to use. See the Gaffer {{GafferDocumentationLink|GettingStarted/ConfiguringGafferForThirdPartyTools/index.html#configuring-gaffer-for-arnold|documentation}} for more information.

=== 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.