Navigation
| Name | OpenColorIO |
| Type | Plugin |
| Part of Plugins | OpenColorIO (OCIO) |
| Location | /Engine/Plugins/Compositing/OpenColorIO/Source/OpenColorIO/ |
| Module Build Rules | OpenColorIO.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FOpenColorIOCompilationOutput | Stores outputs from the color transform compile that need to be saved. |
| FOpenColorIODisplayExtension | View extension applying an OCIO Display Look to the viewport we're attached to |
| FOpenColorIODisplayManager | |
| FOpenColorIOInvalidPixelShader | |
| FOpenColorIOInvalidShaderParameters | |
| FOpenColorIOPixelShader | |
| FOpenColorIOPixelShaderParameters | |
| FOpenColorIORendering | Entry point to trigger OpenColorIO conversion rendering |
| FOpenColorIOShaderCompilationManager | Handles finished shader compile jobs, applying of the shaders to their config asset, and some error handling |
| FOpenColorIOShaderMap | The shaders required to apply an OCIO color transform. |
| FOpenColorIOShaderMapContent | |
| FOpenColorIOShaderMapId | Contains all the information needed to uniquely identify a FOpenColorIOShaderMapID. |
| FOpenColorIOShaderType | A shader meta type for OpenColorIO-linked shaders. |
| FOpenColorIOTransformResource | FOpenColorIOTransformResource represents a OpenColorIO color transform to the shader compilation process |
| UOpenColorIOBlueprintLibrary | |
| UOpenColorIOColorTransform | Object used to generate shader and LUTs from OCIO configuration file and contain required resource to make a color space transform. |
| UOpenColorIOConfiguration | Asset to manage allowed OpenColorIO color spaces. This will create required transform objects. |
| UOpenColorIODisplayExtensionWrapper | This Blueprintable object can hold an OCIO Scene View Extension. |
| UOpenColorIOSettings | Rendering settings. |
Structs
| Name | Remarks |
|---|---|
| FOpenColorIOColorConversionSettings | Identifies a OCIO ColorSpace conversion. |
| FOpenColorIOColorSpace | Structure to identify a ColorSpace as described in an OCIO configuration file. |
| FOpenColorIODisplayConfiguration | Identifies an OCIO Display look configuration |
| FOpenColorIODisplayView | |
| FOpenColorIORenderPassResources | Resources needed by the FOpenColorIORendering pass function. |
| FOpenColorIOShaderCompileWorkerInfo | Information tracked for each shader compile worker process instance. |
| FOpenColorIOShaderMapCompileResults | Results for a single compiled shader map. |
| FOpenColorIOShaderMapFinalizeResults | Results for a single compiled and finalized shader map. |
| FOpenColorIOShaderPermutationParameters |
Interfaces
| Name | Remarks |
|---|---|
| IOpenColorIOModule | Interface for the OpenColorIO module. |
Enums
Public
| Name | Remarks |
|---|---|
| EOpenColorIOTransformAlpha | Option to transform the render target alpha before applying the color transform. |
| EOpenColorIOViewTransformDirection | Transformation direction type for display-view transformations. |
| EOpenColorIOWorkingColorSpaceTransform | Enum used to indicate whether the working color space should be used as a source or destination. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OpenColorIOShader::MaximumTextureSlots | uint32 | OpenColorIOShader.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GOpenColorIOShaderCompilationManager | FOpenColorIOShaderCompilationManager | OpenColorIOShaderCompilationManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool OpenColorIOBindTextureResources
(
FOpenColorIOPixelShaderParameters* Parameters, |
OpenColorIOShader.h | ||
FRHITexture * OpenColorIOGetMiniFontTexture() |
OpenColorIOShader.h | ||
void UpdateOpenColorIOShaderCompilingStats
(
const FOpenColorIOTransformResource* InShader |
Called for every OpenColorIO shader to update the appropriate stats. | OpenColorIOShaderType.h |