1.1.4.0
User Documentation
Getting Started
Installing Gaffer
Launching Gaffer for the First Time
Tutorial: Assembling the Gaffer Bot
Setting Up the “gaffer” Command
Configuring Gaffer for Third-Party Tools
Working with the Node Graph
Box Node
Spreadsheet Node
Contexts
Performance Best Practices
Using the Performance Monitor
Tutorial: Using The OSLCode Node
Tutorial: Setting Up a Spreadsheet
Working with Scenes
Anatomy of a Scene
Anatomy of a Camera
Camera
Light Linking
Working with Images
Anatomy of an Image
Working with the Python Scripting API
The Python Editor
Tutorial: Node Graph Editing in Python
Tutorial: Querying a Scene
Tutorial: Startup Config 1; Custom Global Context Variables
Tutorial: Startup Config 2; Custom Bookmarks
Tutorial: Startup Config 3; Custom Node Menu Entries
Interface
Controls and Shortcuts
Supplemental Material
Reference
Node Reference
Gaffer
Animation
Backdrop
Box
BoxIn
BoxOut
ComputeNode
ContextQuery
ContextVariables
ContextVariables
DeleteContextVariables
DeleteContextVariables
DependencyNode
Dot
EditScope
Expression
Loop
Loop
NameSwitch
Node
Preferences
Random
RandomChoice
Reference
ScriptNode
Spreadsheet
SubGraph
Switch
Switch
TimeWarp
TimeWarp
GafferAppleseed
AppleseedAttributes
AppleseedLight
AppleseedOptions
AppleseedRender
AppleseedShaderAdaptor
AppleseedShaderBall
InteractiveAppleseedRender
GafferArnold
ArnoldAOVShader
ArnoldAtmosphere
ArnoldAttributes
ArnoldBackground
ArnoldCameraShaders
ArnoldColorManager
ArnoldDisplacement
ArnoldImager
ArnoldLight
ArnoldLightFilter
ArnoldMeshLight
ArnoldOptions
ArnoldRender
ArnoldShader
ArnoldShaderBall
ArnoldTextureBake
ArnoldVDB
InteractiveArnoldRender
GafferCycles
CyclesAttributes
CyclesBackground
CyclesLight
CyclesMeshLight
CyclesOptions
CyclesRender
CyclesShader
CyclesShaderBall
InteractiveCyclesRender
GafferDispatch
Dispatcher
FrameMask
LocalDispatcher
PythonCommand
SystemCommand
TaskContextProcessor
TaskContextVariables
TaskList
TaskNode
TaskSwitch
Wedge
GafferImage
Anaglyph
BleedFill
Blur
CDL
Catalogue
CatalogueSelect
Checkerboard
Clamp
CollectImages
ColorSpace
Constant
CopyChannels
CopyImageMetadata
CopyViews
CreateViews
Crop
DeepHoldout
DeepMerge
DeepRecolor
DeepSampleCounts
DeepSampler
DeepState
DeepTidy
DeepToFlat
DeleteChannels
DeleteImageMetadata
DeleteViews
Dilate
Display
DisplayTransform
Empty
Erode
FlatImageProcessor
FlatImageSource
FlatToDeep
FormatQuery
Grade
ImageMetadata
ImageNode
ImageProcessor
ImageReader
ImageSampler
ImageStats
ImageTransform
ImageWriter
LUT
LookTransform
Median
Merge
Mirror
Mix
Offset
OpenImageIOReader
Premultiply
Ramp
Rectangle
Resample
Resize
Saturation
SelectView
Shuffle
Text
VectorWarp
Unpremultiply
VectorWarp
GafferOSL
OSLCode
OSLImage
OSLLight
OSLObject
OSLShader
GafferScene
AimConstraint
AttributeQuery
AttributeTweaks
AttributeVisualiser
Attributes
BoundQuery
Camera
CameraTweaks
ClippingPlane
ClosestPointSampler
CollectPrimitiveVariables
CollectScenes
CollectTransforms
CoordinateSystem
CopyAttributes
CopyOptions
CopyPrimitiveVariables
Cryptomatte
Cube
CurveSampler
CustomAttributes
CustomOptions
DeleteAttributes
DeleteCurves
DeleteFaces
DeleteGlobals
DeleteObject
DeleteOptions
DeleteOutputs
DeletePoints
DeletePrimitiveVariables
DeleteSets
Duplicate
Encapsulate
ExistenceQuery
ExternalProcedural
Filter
FilterProcessor
FilterQuery
FilterResults
FilteredSceneProcessor
FreezeTransform
Grid
Group
Instancer
InteractiveRender
Isolate
LightToCamera
LocaliseAttributes
MapOffset
MapProjection
MergeScenes
MeshDistortion
MeshTangents
MeshToPoints
MeshType
MotionPath
ObjectToScene
OpenGLAttributes
OpenGLRender
OpenGLShader
OptionQuery
OptionTweaks
Options
Orientation
Outputs
Parameters
Parent
ParentConstraint
PathFilter
Plane
PointConstraint
PointsType
PrimitiveVariableExists
PrimitiveVariables
Prune
Rename
Render
ResamplePrimitiveVariables
ReverseWinding
SceneElementProcessor
SceneNode
SceneProcessor
SceneReader
SceneWriter
Seeds
Set
SetFilter
SetVisualiser
Shader
ShaderAssignment
ShaderBall
ShaderQuery
ShaderTweaks
ShuffleAttributes
ShufflePrimitiveVariables
Sphere
StandardAttributes
StandardOptions
SubTree
Text
Transform
TransformQuery
UDIMQuery
UVSampler
Unencapsulate
UnionFilter
Wireframe
GafferUSD
USDAttributes
USDLayerWriter
GafferVDB
LevelSetOffset
LevelSetToMesh
MeshToLevelSet
PointsGridToPoints
SphereLevelSet
Scripting Reference
Common Operations
String Substitution Syntax
Expressions
Set Expressions
Metadata
Command Line Reference
browser
cli
dispatch
env
execute
gui
license
python
screengrab
stats
test
view
Context Variables
Release Notes
1.1.4.0
1.1.3.0
1.1.2.0
1.1.1.0
1.1.0.0
1.0.6.3
1.0.6.2
1.0.6.1
1.0.6.0
1.0.5.1
1.0.5.0
1.0.4.0
1.0.3.0
1.0.2.1
1.0.2.0
1.0.1.0
1.0.0.0
0.61.14.7
0.61.14.6
0.61.14.5
0.61.14.4
0.61.14.3
0.61.14.2
0.61.14.1
0.61.14.0
0.61.13.1
0.61.13.0
0.61.12.0
0.61.11.0
0.61.10.0
0.61.9.0
0.61.8.0
0.61.7.0
0.61.6.0
0.61.5.0
0.61.4.0
0.61.3.0
0.61.2.0
0.61.1.1
0.61.1.0
0.61.0.0
0.60.12.2
0.60.12.1
0.60.12.0
0.60.11.0
0.60.10.0
0.60.9.0
0.60.8.0
0.60.7.1
0.60.7.0
0.60.6.1
0.60.6.0
0.60.5.0
0.60.4.0
0.60.3.0
0.60.2.1
0.60.2.0
0.60.1.0
0.60.0.0
0.59.9.5
0.59.9.4
0.59.9.3
0.59.9.2
0.59.9.1
0.59.9.0
0.59.8.0
0.59.7.0
0.59.6.0
0.59.5.0
0.59.4.0
0.59.3.0
0.59.2.0
0.59.1.0
0.59.0.0
0.58.6.7
0.58.6.6
0.58.6.5
0.58.6.4
0.58.6.3
0.58.6.2
0.58.6.1
0.58.6.0
0.58.5.2
0.58.5.1
0.58.5.0
0.58.4.0
0.58.3.2
0.58.3.1
0.58.3.0
0.58.2.0
0.58.1.0
0.58.0.1
0.58.0.0
0.57.7.6
0.57.7.5
0.57.7.4
0.57.7.3
0.57.7.2
0.57.7.1
0.57.7.0
0.57.6.0
0.57.5.0
0.57.4.1
0.57.4.0
0.57.3.0
0.57.2.0
0.57.1.0
0.57.0.0
0.56.2.6
0.56.2.5
0.56.2.4
0.56.2.3
0.56.2.2
0.56.2.1
0.56.2.0
0.56.1.0
0.56.0.0
0.55.5.2
0.55.5.1
0.55.5.0
0.55.4.1
0.55.4.0
0.55.3.0
0.55.2.1
0.55.2.0
0.55.1.0
0.55.0.0
0.54.2.7
0.54.2.6
0.54.2.5
0.54.2.4
0.54.2.3
0.54.2.2
0.54.2.1
0.54.2.0
0.54.1.0
0.54.0.1
0.54.0.0
0.53.6.3
0.53.6.2
0.53.6.0
0.53.5.0
0.53.4.0
0.53.3.0
0.53.2.0
0.53.1.1
0.53.1.0
0.53.0.0
0.52.3.5
0.52.3.4
0.52.3.3
0.52.3.2
0.52.3.1
0.52.3.0
0.52.2.0
0.52.1.0
0.52.0.0
0.51.0.0
0.50.0.0
0.49.1.0
0.49.0.1
0.49.0.0
0.48.1.0
0.48.0.0
0.47.0.0
0.46.1.0
0.46.0.0
0.45.3.0
0.45.2.0
0.45.1.0
0.45.0.0
0.44.0.0
0.43.0.0
0.42.0.0
0.41.0.0
0.40.0.0
0.34.0.0
0.33.3.0
0.33.2.0
0.33.1.0
0.33.0.0
0.32.0.0
0.31.0.0
0.30.2.0
0.30.1.0
0.30.0.0
0.29.0.0
0.28.3.0
0.28.2.1
0.28.2.0
0.28.1.0
0.28.0.1
0.28.0.0
0.27.1.0
0.27.0.1
0.27.0.0
0.26.0.0
0.25.1.0
0.25.0.0
0.24.1.0
0.24.0.0
0.23.2.0
0.23.1.0
0.23.0.1
0.23.0.0
0.22.0.0
0.21.0.0
0.20.0.0
0.19.0.0
0.18.0.0
0.17.0.0
0.16.0.4
0.16.0.3
0.16.0.2
0.16.0.1
0.16.0.0
0.15.0.0
0.14.0.0
0.13.1.0
0.13.0.0
0.12.1.0
0.12.0.0
0.11.0.0
0.10.1.0
0.10.0.0
0.9.0.0
0.8.2.0
0.8.1.0
0.8.0.0
0.7.0.0
0.6.0.0
0.5.0.1
0.5.0.0
0.4.0.0
0.3.0.0
0.2.1.0
0.2.0.0
0.1.1.0
0.1.0.0
0.101.0
0.100.0
0.99.0
0.98.0
0.97.0
0.96.0
0.95.0
0.94.0
0.93.0
0.92.1
0.92.0
0.91.0
0.90.0
0.89.0
0.88.1
0.88.0
0.87.1
0.87.0
0.86.0
0.85.1
0.85.0
0.84.0
0.83.0
0.82.0
0.81.0
0.80.0
0.79.0
0.78.0
0.77.0
0.76.0
0.75.0
0.74.0
0.73.0
0.72.2
0.72.1
0.72.0
0.71.0
0.70.0
0.69.1
0.69.0
0.68.0
0.67.0
0.66.0
0.65.0
0.64.0
0.63.1
0.63.0
0.62.1
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.36.0
0.35.7
0.35.6
0.35.5
0.35.4
0.35.3
0.35.2
0.35.1
0.35.0
0.34.0
0.33.2
0.33.1
0.33.0
0.32.1
0.32.0
0.31.0
0.30.0
0.29.0
0.28.1
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.1
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.1
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
Appendices
License
Gaffer
»
Reference
»
Node Reference
»
GafferCycles
GafferCycles
CyclesAttributes
CyclesBackground
CyclesLight
CyclesMeshLight
CyclesOptions
CyclesRender
CyclesShader
CyclesShaderBall
InteractiveCyclesRender