Upgrading to v2

Upgrading to v2

Guides¶

Guides

Using OCIO
Environment Variables
Tool overview
- ocioarchive
- ociocheck
- ociochecklut
- ociobakelut
- ocioconvert
- ociodisplay
- pyociodisplay
- ociolutimage
- ociomakeclf
- ocioperf
- ociowrite
- pyocioamf
Supported LUT Formats
Compatible Software
- After Effects
- Anchorpoint
- Arnold (Autodesk)
- Blender
- C++
- cineSync (ftrack)
- Clarisse (Isotropix)
- CryEngine (CryTek)
- DJV
- Gaffer
- Guerilla Render
- Hiero (Foundry)
- Houdini (SideFX)
- Java (Beta)
- Katana (Foundry)
- Krita
- Mari (Foundry)
- Maya (Autodesk)
- Mocha Pro (Boris FX)
- Modo (Foundry)
- mrViewer
- Natron
- Nuke (Foundry)
- OpenImageIO
- PhotoFlow
- Photoshop
- Python
- RV (Autodesk)
- Silhouette (Boris FX)
- Substance Designer (Adobe)
- Unreal Engine (Epic Games)
- Vegas Pro (Magix)
- V-Ray (Chaos Group)
- Apps w/icc or luts
FAQ
- Can you query a color space by name (like “Rec709”) and get back XYZ coordinates of its primaries and whitepoint?
- Can you convert XYZ <-> named color space RGB values?
- What are the differences between Nuke’s Vectorfield and OCIOFileTransform?
- What do ColorSpace::setAllocation() and ColorSpace::setAllocationVars() do?
Authoring Configurations
Config syntax
- YAML basics
- Checking for errors
- Config sections
- Config header
- Environment
  - environment
- Roles
  - roles
- File & Viewing rules
- Displays & Views
- Looks
  - looks
- Colorspaces
  - colorspaces
- Display Colorspaces
  - display_colorspaces
- Available transforms
- Named Transforms
Looks Example
- Example configuration
Contexts Example
- A contrived example
- Per-shot grades
- A complete example
How to Configure ColorSpace Allocation
Developing with OCIO
Usage Examples
- Applying a basic ColorSpace transform, using the CPU
  - C++
  - Python
- Displaying an image, using the CPU using getProcessor
  - C++
  - Python
- Displaying an image, using the CPU using DisplayViewTransform
  - C++
  - Python
- Displaying an image, using the GPU (Full Display Pipeline)
  - C++
Application Helpers
Contributing
Getting started
- Checking Out The Codebase
- Reference Build Environment
- Merging changes
Repository structure
- Root
- .github/workflows
- ASWF
- docs
- ext
- include
- share
- src
- tests
- vendor
Architectural notes
Coding style guide
- File conventions
- Copyright notices
- Line length
- Formatting
- Misc. rules
- Bottom line
Unit tests
Test framework
- C++
- Python
- Java
Issues
Submitting an issue
Submitting Changes
- Code Review
- Development and Pull Requests
Documentation guidelines
- Installation of requirements
- Building the docs
- Updating the Python docs
- Building the docs – Excluding the API docs
- Basics
- Quirks
- Emacs rST mode
OpenColorIO Doxygen Style Guide
- Source Code Documentation Syntax
- Documentation Language