OpenColorIO

API > API/Plugins

Classes

  Type Name Description
Public struct UStruct BlueprintType meta FOpenColorIOColorConversionSettings Identifies a OCIO ColorSpace conversion.  
Public struct UStruct BlueprintType meta FOpenColorIOColorSpace Structure to identify a ColorSpace as described in an OCIO configuration file.  
Public class FOpenColorIOCompilationOutput Stores outputs from the color transform compile that need to be saved.  
Public struct UStruct BlueprintType meta FOpenColorIODisplayConfiguration Identifies an OCIO Display look configuration  
Public class FOpenColorIODisplayExtension View extension applying an OCIO Display Look to the viewport we're attached to  
Public class FOpenColorIODisplayManager    
Public struct UStruct BlueprintType meta FOpenColorIODisplayView    
Public class FOpenColorIOEditorConfigurationInspector    
Public class FOpenColorIOPixelShader    
Public class FOpenColorIORendering Entry point to trigger OpenColorIO conversion rendering  
Public struct FOpenColorIORenderPassResources Resources needed by the FOpenColorIORendering pass function.  
Public class FOpenColorIOShaderCompilationManager Handles finished shader compile jobs, applying of the shaders to their config asset, and some error handling  
Public struct FOpenColorIOShaderCompileWorkerInfo Information tracked for each shader compile worker process instance.  
Public class FOpenColorIOShaderMap The shaders required to apply an OCIO color transform.  
Public struct FOpenColorIOShaderMapCompileResults Results for a single compiled shader map.  
Public class FOpenColorIOShaderMapContent    
Public struct FOpenColorIOShaderMapFinalizeResults Results for a single compiled and finalized shader map.  
Public class FOpenColorIOShaderMapId Contains all the information needed to uniquely identify a FOpenColorIOShaderMapID.  
Public struct FOpenColorIOShaderPermutationParameters    
Public class FOpenColorIOShaderType A shader meta type for OpenColorIO-linked shaders.  
Public class FOpenColorIOTransformResource FOpenColorIOTransformResource represents a OpenColorIO color transform to the shader compilation process  
Public class IOpenColorIOModule Interface for the OpenColorIO module.  
Public class UClass MinimalAPI Meta UOpenColorIOBlueprintLibrary    
Public class UClass UOpenColorIOColorTransform Object used to generate shader and LUTs from OCIO configuration file and contain required resource to make a color space transform.  
Public class UClass BlueprintType Meta UOpenColorIOConfiguration Asset to manage allowed OpenColorIO color spaces. This will create required transform objects.  
Public class UClass Blueprintable Meta UOpenColorIODisplayExtensionWrapper This Blueprintable object can hold an OCIO Scene View Extension.  
Public class UClass Config defaultconfig UOpenColorIOSettings Rendering settings.  

Enums

  Type Name Description
Public enum EOpenColorIOTransformAlpha Option to transform the render target alpha before applying the color transform.  
Public enum UEnum BlueprintType meta EOpenColorIOViewTransformDirection Transformation direction type for display-view transformations.  
Public enum EOpenColorIOWorkingColorSpaceTransform Enum used to indicate whether the working color space should be used as a source or destination.  

Functions

  Type Name Description
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FOpenColorIOPixelShaderParameters
)

  
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FOpenColorIOInvalidShaderParameters
)

  
Public function InputTexture MiniFontTexture RENDER_TARGET_BINDING_SLOTS() END_SHADER_PARAMETER_STRUCT() class FOpen...

OpenColorIOBindTextureResources ( FOpenColorIOPixelShaderParameters* Parameters,
const TSortedMap< int32, FTextureResource* >& InTextureResources
)

  
Public function FRHITexture *  
Public function InputTexture Gamma

SHADER_PARAMETER ( uint32,
TransformAlpha
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_5Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_4Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_3Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_2Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_1Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_0Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_7Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_6Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_4Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_6Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_3Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_2Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_1Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_0Sampler
)

  
Public function InputTexture

SHADER_PARAMETER_SAMPLER ( SamplerState,
InputTextureSampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut3d_5Sampler
)

  
Public function InputTexture Gamma Ocio_lut3d_0 Ocio_lut3d_1 Ocio_lut3d_2 Ocio_lut3d_3 Ocio_lut3d_4 Ocio_lut3d_5 Oci...

SHADER_PARAMETER_SAMPLER ( SamplerState,
Ocio_lut1d_7Sampler
)

  
Public function void Called for every OpenColorIO shader to update the appropriate stats.

Variables

  Type Name Description
Public variable FOpenColorIOShaderCompilationManager GOpenColorIOShaderCompilationManager  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page