className: FOpenColorIOInvalidShaderParameters

InputTexture

type: TShaderResource...

RenderTargets

type: FRenderTargetBi...


module: OpenColorIO

code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: static OPENCOLORIO_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


code: OPENCOLORIO_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FOpenColorIOPixelShader](API\Plugins\OpenColorIO\FOpenColorIOPixelShader) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static bool ShouldCompilePermutation ( const [FOpenColorIOShaderPermutationParameters](API\Plugins\OpenColorIO\FOpenColorIOShaderPermutationPar-) & Parameters )


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static OPENCOLORIO_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FOpenColorIOPixelShader ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FOpenColorIOPixelShader

code: class FOpenColorIOPixelShader : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


className: Alignment

code: static Alignment = 16;


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FOpenColorIOPixelShaderParameters](API\Plugins\OpenColorIO\FOpenColorIOPixelShaderParameter-) & InContents, EUniformBufferUsage InUsage )


className: FileLine

code: static FileLine = builtin_LINE();


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: zzFuncPtr

code: typedef void * zzFuncPtr


className: zzMemberFunc

code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdInputTextureSampler


code: FOpenColorIOPixelShaderParameters()


description: Similar to the above, except gamma and feature level are handled by the function itself based on provided View.

code: static void AddPass_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, const [FSceneView](API\Runtime\Engine\FSceneView) & View, const [FScreenPassTexture](API\Runtime\Renderer\FScreenPassTexture) & Input, const [FScreenPassRenderTarget](API\Runtime\Renderer\FScreenPassRenderTarget) & Output, const [FOpenColorIORenderPassResources](API\Plugins\OpenColorIO\FOpenColorIORenderPassResources) & InPassInfo, [EOpenColorIOTransformAlpha](API\Plugins\OpenColorIO\EOpenColorIOTransformAlpha) TransformAlpha )


className: FOpenColorIOPixelShaderParameters

code: class FOpenColorIOPixelShaderParameters

Gamma

type: TShaderParamete...


description: Applies the color transform RDG pass with the provided resources.

code: static void AddPass_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FScreenPassViewInfo](API\Runtime\Renderer\FScreenPassViewInfo) ViewInfo, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const [FScreenPassTexture](API\Runtime\Renderer\FScreenPassTexture) & Input, const [FScreenPassRenderTarget](API\Runtime\Renderer\FScreenPassRenderTarget) & Output, const [FOpenColorIORenderPassResources](API\Plugins\OpenColorIO\FOpenColorIORenderPassResources) & InPassInfo, float InGamma, [EOpenColorIOTransformAlpha](API\Plugins\OpenColorIO\EOpenColorIOTransformAlpha) TransformAlpha )


description:
Applies the color transform described in the settings
True if a rendering command to apply the transform was queued.

code: static bool ApplyColorTransform ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings, [UTexture](API\Runtime\Engine\Engine\UTexture) * InTexture, [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * OutRenderTarget )


className: DefaultDisplayGamma

code: static float DefaultDisplayGamma = 2.2f;


description: Get render pass resources on the game thread, to be enqueue-copied for later use by the `AddPass_RenderThread_ function.FOpenColorIORenderPassResourcesRender pass resources to be enqueue-copied onto the render thread.

code: static [FOpenColorIORenderPassResources](API\Plugins\OpenColorIO\FOpenColorIORenderPassResources) GetRenderPassResources ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


description: This function sets up provided view and related family to properly support OCIO.

code: static void PrepareView ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily, [FSceneView](API\Runtime\Engine\FSceneView) & InView )


className: FOpenColorIORendering

description: Entry point to trigger OpenColorIO conversion rendering

code: class FOpenColorIORendering


description: Resources are valid when the shader resource is not null.

code: bool IsValid() const


className: FOpenColorIORenderPassResources

description: Resources needed by theFOpenColorIORenderingpass function.

code: struct FOpenColorIORenderPassResources

ShaderResource

type: FOpenColorIOTra...

description: Color transform pass (generated) shader.

TextureResources

type: TSortedMap< int...

description: Collection of LUT textures needed by the shader.

TransformName

type: FString

description: Color transform string description.


code: void AddJobs ( [TArray](API\Runtime\Core\Containers\TArray)< FShaderCommonCompileJobPtr > InNewJobs )


code: void FinishCompilation ( const TCHAR * InTransformName, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & ShaderMapIdsToFinishCompiling )


code: void Tick ( float DeltaSeconds )


code: ~FOpenColorIOShaderCompilationManager()


code: FOpenColorIOShaderCompilationManager()


code: FOpenColorIOShaderCompileWorkerInfo()


className: FOpenColorIOShaderCompilationManager

description: Handles finished shader compile jobs, applying of the shaders to their config asset, and some error handling


description: Warning: not virtual

code: ~FOpenColorIOShaderCompileWorkerInfo()


description: Reference counting.

code: void AddRef()


className: AllOpenColorIOShaderMaps

description: All color transform shader maps in memory. No ref counting needed as these are removed on destruction of the shader map.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * > AllOpenColorIOShaderMaps;


description:
Compiles the shaders for a color transform and caches them in this shader map.
Compiles the shaders for a color transform and caches them in this shader map.

code: void Compile ( [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform, const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InShaderMapId, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FSharedShaderCompilerEnvironment](API\Runtime\RenderCore\FSharedShaderCompilerEnvironment) > InCompilationEnvironment, const [FOpenColorIOCompilationOutput](API\Plugins\OpenColorIO\FOpenColorIOCompilationOutput) & InOpenColorIOCompilationOutput, EShaderPlatform InPlatform, bool bSynchronousCompile, bool bApplyCompletedShaderMapForRendering )


code: bool CompiledSuccessfully() const


className: FOpenColorIOShaderCompileWorkerInfo

description: Information tracked for each shader compile worker process instance.

bComplete

type: bool

description: Tracks whether all tasks issued to the worker have been received.

bIssuedTasksToWorker

description: Tracks whether tasks have been issued to the worker.

bLaunchedWorker

description: Whether the worker has been launched for this set of tasks.

QueuedJobs

type: TArray< FShader...

description: Jobs that this worker is responsible for compiling.

StartTime

type: double

description: Time at which the worker started the most recent batch of tasks.

WorkerProcess

type: FProcHandle

description: Process handle of the worker app once launched. Invalid handle means no process.


description:
Finds the shader map for a color transform.
Finds the shader map for a color transform.
nullptr if no cached shader map was found.

code: static [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * FindId ( const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InShaderMapId, EShaderPlatform InPlatform )


code: uint32 GetCompilingId() const


code: static [TMap](API\Runtime\Core\Containers\TMap)< [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) >, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * > > & GetInFlightShaderMaps()


code: const [FMemoryImageString](API\Runtime\Core\Serialization\FMemoryImageString) & GetFriendlyName() const


code: template<typename ShaderType> TShaderRef< ShaderType > GetShader() const


code: TShaderRef< [FShader](API\Runtime\RenderCore\FShader) > GetShader ( [FShaderType](API\Runtime\RenderCore\FShaderType) * ShaderType ) const


description: Builds a list of the shaders in a shader map.

code: void GetShaderList ( [TMap](API\Runtime\Core\Containers\TMap)< [FShaderId](API\Runtime\RenderCore\FShaderId), TShaderRef< [FShader](API\Runtime\RenderCore\FShader) >> & OutShaders ) const


description: Registers all shaders that have been loaded in Serialize virtual void RegisterSerializedShaders(bool bCooked) override; virtual void DiscardSerializedShaders() override;

code: const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & GetShaderMapId() const


className: GIdToOpenColorIOShaderMap

description: A global map from a ColorTransform's ID and static switch set to any shader map cached for that color transform. Note: this does not necessarily contain all color transform shader maps in memory. Shader maps with the same key can evict each other. No ref counting needed as these are removed on destruction of the shader map.

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId), [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * > GIdToOpenColorIOShaderMap;


code: bool IsCompilationFinalized() const


description:
Checks whether the shader map is missing any shader types necessary for the given color transform.
True if the shader map has all of the shader types necessary.

code: bool IsComplete ( const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform, bool bSilent )


description: Attempts to load the shader map for the given color transform from the Derived Data Cache. If InOutShaderMap is valid, attempts to load the individual missing shaders instead.

code: static void LoadFromDerivedDataCache ( const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform, const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InShaderMapId, EShaderPlatform InPlatform, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) > & InOutShaderMap )


className: OpenColorIOShaderMapsBeingCompiled

description: TracksFOpenColorIOTransformResourceand their shader maps that are being compiled. Uses aTRefCountPtras this will be the only reference to a shader map while it is being compiled.

code: static [TMap](API\Runtime\Core\Containers\TMap)< [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) >, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * > > OpenColorIOShaderMapsBeingCompiled;


className: NextCompilingId

description: Next value for CompilingId.

code: static uint32 NextCompilingId = 2;


description: Sorts the incoming compiled jobs into the appropriate OCIO shader maps, and finalizes this shader map so that it can be used for rendering.

code: bool ProcessCompilationResults ( const [TArray](API\Runtime\Core\Containers\TArray)< FShaderCommonCompileJobPtr > & InCompilationResults, int32 & InOutResultIndex, float & InOutTimeBudget )


description: Registers a OpenColorIO shader map in the global map.

code: void Register ( EShaderPlatform InShaderPlatform )


description: Removes a ColorTransform from OpenColorIOShaderMapsBeingCompiled.

code: static void RemovePendingColorTransform ( [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform )


description: Saves this shader map to the derived data cache.

code: void SaveToDerivedDataCache()


description: Serializes the shader map.

code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bInlineShaderResources )


code: void SetCompiledSuccessfully ( bool bSuccess )


description:
Checks to see if the shader map is already being compiled for another color transform, and if so adds the specified color transform to the list to be applied to once the compile finishes.
True if the shader map was being compiled and we added ColorTransform to the list to be applied.

code: bool TryToAddToExistingCompilationTask ( [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform )


description: Destructor.

code: ~FOpenColorIOShaderMap()


className: FOpenColorIOShaderMap

description: The shaders required to apply an OCIO color transform.

code: class FOpenColorIOShaderMap : public [TShaderMap< FOpenColorIOShaderMapContent, FShaderMapPointerTable >](API\Runtime\RenderCore\TShaderMap), public [FDeferredCleanupInterface](API\Runtime\RenderCore\FDeferredCleanupInterface)


code: FOpenColorIOShaderMapCompileResults()


className: FOpenColorIOShaderMapCompileResults

description: Results for a single compiled shader map.


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FOpenColorIOShaderMapContent](API\Plugins\OpenColorIO\FOpenColorIOShaderMapContent) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


description: Initialize(FTypeLayoutDesc& TypeDesc)

code: template<> struct InternalLinkType< COUNTER-CounterBase >


className: InternalLinkType

description: InternalLinkType<COUNTER-CounterBase >

code: template<int Counter> struct InternalLinkType


code: static [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FOpenColorIOShaderMapFinalizeResults ( const [FOpenColorIOShaderMapCompileResults](API\Plugins\OpenColorIO\FOpenColorIOShaderMapCompileResu-) & InCompileResults )


className: FOpenColorIOShaderMapContent

description: No constructors are accessible with public or protected access.

code: class FOpenColorIOShaderMapContent : public [FShaderMapContent](API\Runtime\RenderCore\FShaderMapContent)


className: FOpenColorIOShaderMapFinalizeResults

description: Results for a single compiled and finalized shader map.

code: struct FOpenColorIOShaderMapFinalizeResults : public [FOpenColorIOShaderMapCompileResults](API\Plugins\OpenColorIO\FOpenColorIOShaderMapCompileResu-)

FinalizeJobIndex

description: Tracks finalization progress on this shader map.


description: Appends string representations of this Id to a key string.

code: void AppendKeyString ( [FString](API\Runtime\Core\Containers\FString) & OutKeyString ) const


description: Returns true if the requested shader type is a dependency of this shader map Id.

code: bool ContainsShaderType ( const [FShaderType](API\Runtime\RenderCore\FShaderType) * ShaderType ) const


description: Hashes the color transform specific part of this shader map Id.

code: void GetOpenColorIOHash ( [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & OutHash ) const


code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) >::Type InternalBaseType


code: template<> struct InternalLinkType< __COUNTER__-CounterBase >


code: bool operator!= ( const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InReferenceSet ) const


description:
Tests this set against another for equality, disregarding override settings.
true if the sets are equal

code: bool operator== ( const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InReferenceSet ) const


code: void SetShaderDependencies ( const [TArray](API\Runtime\Core\Containers\TArray)< [FShaderType](API\Runtime\RenderCore\FShaderType) * > & InShaderTypes, EShaderPlatform InShaderPlatform )


code: FOpenColorIOShaderPermutationParameters ( [FName](API\Runtime\Core\UObject\FName) InGlobalShaderName, EShaderPlatform InPlatform, const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InTransform )


className: FOpenColorIOShaderPermutationParameters

code: struct FOpenColorIOShaderPermutationParameters : public [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-)

Transform

type: constFOpenColo...


description: Enqueues a compilation for a new shader of this type.

code: void BeginCompileShader ( uint32 ShaderMapId, const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform, [FSharedShaderCompilerEnvironment](API\Runtime\RenderCore\FSharedShaderCompilerEnvironment) * CompilationEnvironment, EShaderPlatform Platform, [TArray](API\Runtime\Core\Containers\TArray)< [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< class [FShaderCommonCompileJob](API\Runtime\RenderCore\FShaderCommonCompileJob) >> & NewJobs, [FShaderTarget](API\Runtime\RenderCore\FShaderTarget) Target )


code: CompiledShaderInitializerType &40; const FShaderType &42; InType, int32 InPermutationId, const FShaderCompilerOutput & CompilerOutput, const FSHAHash & InOCIOShaderMapHash, const FString & InDebugDescription &41;


className: CompiledShaderInitializerType

code: struct CompiledShaderInitializerType : public [FShaderCompiledShaderInitializerType](API\Runtime\RenderCore\FShaderCompiledShaderInitializer-)

DebugDescription

type: constFString


description: Either creates a new instance of this type or returns an equivalent existing shader.

code: [FShader](API\Runtime\RenderCore\FShader) * FinishCompileShader ( const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & InOCIOShaderMapHash, const [FShaderCompileJob](API\Runtime\RenderCore\FShaderCompileJob) & CurrentJob, const [FString](API\Runtime\Core\Containers\FString) & InDebugDescription ) const


description: Sets up the environment used to compile an instance of this shader type.

code: void SetupCompileEnvironment ( EShaderPlatform InPlatform, const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment ) const


description:
Checks if the shader type should be cached for a particular platform and color transform.
True if this shader type should be cached.

code: bool ShouldCache ( EShaderPlatform InPlatform, const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InColorTransform ) const


code: FOpenColorIOShaderType ( [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & InTypeLayout, const TCHAR * InName, const TCHAR * InSourceFilename, const TCHAR * InFunctionName, uint32 InFrequency, int32 InTotalPermutationCount, [ConstructSerializedType](API\Runtime\RenderCore\FShaderType\ConstructSerializedType) InConstructSerializedRef, [ConstructCompiledType](API\Runtime\RenderCore\FShaderType\ConstructCompiledType) InConstructCompiledRef, [ShouldCompilePermutationType](API\Runtime\RenderCore\FShaderType\ShouldCompilePermutationType) InShouldCompilePermutationRef, [GetRayTracingPayloadTypeType](API\Runtime\RenderCore\FShaderType\GetRayTracingPayloadTypeType) InGetRayTracingPayloadTypeRef, [ModifyCompilationEnvironmentType](API\Runtime\RenderCore\FShaderType\ModifyCompilationEnvironmentType) InModifyCompilationEnvironmentRef, [ValidateCompiledResultType](API\Runtime\RenderCore\FShaderType\ValidateCompiledResultType) InValidateCompiledResultRef, uint32 InTypeSize, const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * InRootParametersMetadata )


className: FOpenColorIOShaderType

description: A shader meta type for OpenColorIO-linked shaders.

code: class FOpenColorIOShaderType : public [FShaderType](API\Runtime\RenderCore\FShaderType)


code: void AddCompileId ( uint32 InIdentifier )


description: Caches the shaders for this color transform with no static parameters on the given platform. This is used byUOpenColorIOColorTransform

code: bool CacheShaders ( EShaderPlatform InPlatform, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, bool bApplyCompletedShaderMapForRendering, bool bSynchronous )


className: FOpenColorIOShaderMapId

description: Contains all the information needed to uniquely identify a FOpenColorIOShaderMapID.

code: class FOpenColorIOShaderMapId

FeatureLevel

type: ERHIFeatureLeve...

description: Feature level that the shader map is going to be compiled for.

LayoutParams

type: FPlatformTypeLa...

description: Type layout parameters of the memory image

ShaderCodeAndConfigHash

type: FMemoryImageStr...

description: The hash computed from the shader code has and config hash.

ShaderTypeDependencies

type: TMemoryImageArr...

description: Shader types of shaders that are inlined in this shader map in the DDC.


code: bool CacheShaders ( const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InShaderMapId, EShaderPlatform InPlatform, bool bApplyCompletedShaderMapForRendering, bool bSynchronous )


description: Cancels all outstanding compilation jobs

code: void CancelCompilation()


description: Blocks until compilation has completed. Returns immediately if a compilation is not outstanding.

code: void FinishCompilation()


description: Get OCIO generated source code for the shader

code: bool GetColorTransformHLSLSource ( [FString](API\Runtime\Core\Containers\FString) & OutSource )


description: Accessors.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetCompileErrors() const


code: void GetDependentShaderTypes ( EShaderPlatform InPlatform, [TArray](API\Runtime\Core\Containers\TArray)< [FShaderType](API\Runtime\RenderCore\FShaderType) * > & OutShaderTypes ) const


code: const [FString](API\Runtime\Core\Containers\FString) & GetFriendlyName() const


description: Discards loaded shader maps if the application can't render

code: void DiscardShaderMap()


code: [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * GetGameThreadShaderMap() const


description: Returns owner name for tracking


code: template<typename ShaderType> TShaderRef< ShaderType > GetShader() const


code: template<typename ShaderType> TShaderRef< ShaderType > GetShaderGameThread() const


code: virtual void GetShaderMapId ( EShaderPlatform InPlatform, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & OutId ) const


description: Fills the passed array with IDs of shader maps unfinished compilation jobs.

code: void GetShaderMapIDsWithUnfinishedCompilation ( [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutShaderMapIds )


description:
Checks if the compilation for this shader is finished
returns true if compilation is complete false otherwise

code: bool IsCompilationFinished() const


description: Should shaders compiled for this color transform be saved to disk?

code: virtual bool IsPersistent() const


code: bool IsSame ( const [FOpenColorIOShaderMapId](API\Plugins\OpenColorIO\FOpenColorIOShaderMapId) & InId ) const


description: Releases this color transform's shader map. Must only be called on ColorTransforms not exposed to the rendering thread!

code: void ReleaseShaderMap()


code: void RemoveOutstandingCompileId ( const int32 InOldOutstandingCompileShaderMapId )


code: void SerializeShaderMap ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetCompileErrors ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InCompileErrors )


code: void SetCompileErrors ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InErrors )


code: void SetFeatureLevel ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


description: Note: SetRenderingThreadShaderMap must also be called with the same value, but from the rendering thread.

code: void SetGameThreadShaderMap ( [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * InShaderMap )


code: void SetInlineShaderMap ( [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * InShaderMap )


description: Note: SetGameThreadShaderMap must also be called with the same value, but from the game thread.

code: void SetRenderingThreadShaderMap ( [FOpenColorIOShaderMap](API\Plugins\OpenColorIO\FOpenColorIOShaderMap) * InShaderMap )


code: void SetupResource ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel, const [FString](API\Runtime\Core\Containers\FString) & InShaderCodeHash, const [FString](API\Runtime\Core\Containers\FString) & InShadercode, const [FString](API\Runtime\Core\Containers\FString) & InRawConfigHash, const [FString](API\Runtime\Core\Containers\FString) & InFriendlyName, const [FName](API\Runtime\Core\UObject\FName) & InAssetPath, [EOpenColorIOWorkingColorSpaceTransform](API\Developer\OpenColorIOWrapper\EOpenColorIOWorkingColorSpaceTra-) InWorkingColorSpaceTransformType )


description:
Should the shader for this color transform with the given platform, shader type and vertex factory type combination be compiled
true if the shader should be compiled

code: virtual bool ShouldCache ( EShaderPlatform InPlatform, const [FShaderType](API\Runtime\RenderCore\FShaderType) * InShaderType ) const


description: Minimal initialization constructor.

code: FOpenColorIOTransformResource()


description: Destructor


className: FOpenColorIOTransformResource

description: FOpenColorIOTransformResourcerepresents a OpenColorIO color transform to the shader compilation process

code: class FOpenColorIOTransformResource


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IOpenColorIOModule](API\Plugins\OpenColorIO\IOpenColorIOModule) & Get()


description: Returns the collections of ocio display look currently in play


description: Deprecated* This function is deprecated and has been replaced by FOpenColorIOWrapperConfig class in the OpenColorIOWrapper module.


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()during shutdown ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IOpenColorIOModule

description: Interface for the OpenColorIO module.

code: class IOpenColorIOModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: OpenColorIOBindTextureResources

code: void OpenColorIOBindTextureResources ( [FOpenColorIOPixelShaderParameters](API\Plugins\OpenColorIO\FOpenColorIOPixelShaderParameter-) * Parameters, const [TSortedMap](API\Runtime\Core\Containers\TSortedMap)< int32, [FTextureResource](API\Runtime\Engine\FTextureResource) * > & InTextureResources )


className: OpenColorIOGetMiniFontTexture


className: WithPostSerialize

code: enum &123; WithPostSerialize = true &125;


code: template<> struct TStructOpsTypeTraits< FOpenColorIOColorConversionSettings > : public [TStructOpsTypeTraitsBase2< FOpenColorIOColorConversionSettings >](API\Runtime\CoreUObject\UObject\TStructOpsTypeTraitsBase2)


description: static constexpr TCHAR OpenColorIOShaderFunctionName[] = TEXT("OCIOConvert"); static constexpr uint32 Lut3dEdgeLength = 65;

code: namespace OpenColorIOShader { static constexpr uint32 OpenColorIOShader::MaximumTextureSlots = 8; }


className: WithSerializer

code: enum &123; WithSerializer = true &125;


code: template<> struct TStructOpsTypeTraits< FOpenColorIODisplayConfiguration > : public [TStructOpsTypeTraitsBase2< FOpenColorIODisplayConfiguration >](API\Runtime\CoreUObject\UObject\TStructOpsTypeTraitsBase2)


description:
Applies a rendering pass of the color transform described in the settings
True if a rendering command to apply the transform was queued.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenColorIO", Meta=(WorldContext="WorldContextObject")) static bool ApplyColorSpaceTransform ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & ConversionSettings, [UTexture](API\Runtime\Engine\Engine\UTexture) * InputTexture, [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * OutputRenderTarget )


code: UOpenColorIOBlueprintLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: For all ColorTransforms,UOpenColorIOColorTransform::CacheResourceShadersForRendering.


description: Deprecated* This method is deprecated.


description: Returns true if shader/texture resources have finished compiling and are ready for use (to be called on the game thread).

code: bool AreRenderResourcesReady() const


description: Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects

code: virtual void BeginCacheForCookedPlatformData ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Cache resource shaders for cooking on the given shader platform. If a matching shader map is not found in memory or the DDC, a new one will be compiled. This does not apply completed results to the renderer scenes. Caller is responsible for deleting OutCachedResource.

code: void CacheResourceShadersForCooking ( EShaderPlatform InShaderPlatform, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, const [FString](API\Runtime\Core\Containers\FString) & InShaderHash, const [FString](API\Runtime\Core\Containers\FString) & InShaderCode, const [FString](API\Runtime\Core\Containers\FString) & InRawConfigHash, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * > & OutCachedResources )


description: Cache resource shaders for rendering. If a matching shader map is not found in memory or the DDC, a new one will be compiled.

code: void CacheResourceShadersForRendering ( bool bRegenerateId )


description: Deprecated* This method is deprecated.

code: void CacheResourceTextures()


code: void CacheShadersForResources ( EShaderPlatform InShaderPlatform, [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InResourcesToCache, bool bApplyCompletedShaderMapForRendering, bool bIsCooking, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Clear all cached cooked platform data


description: Clears cached cooked platform data for specific platform

code: virtual void ClearCachedCookedPlatformData ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Helper function taking raw 1D LUT data coming from the library and initializing aUTexturewith it.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UTexture](API\Runtime\Engine\Engine\UTexture) > CreateTexture1DLUT ( const [FString](API\Runtime\Core\Containers\FString) & InProcessorIdentifier, const [FName](API\Runtime\Core\UObject\FName) & InName, uint32 InTextureWidth, uint32 InTextureHeight, TextureFilter InFilter, bool bRedChannelOnly, const float * InSourceData )


description: Helper function taking raw 3D LUT data coming from the library and initializing aUVolumeTexturewith it.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UTexture](API\Runtime\Engine\Engine\UTexture) > CreateTexture3DLUT ( const [FString](API\Runtime\Core\Containers\FString) & InProcessorIdentifier, const [FName](API\Runtime\Core\UObject\FName) & InName, uint32 InLutLength, TextureFilter InFilter, const float * InSourceData )


code: static void DeclareConstructClasses ( [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutConstructClasses, const [UClass](API\Runtime\CoreUObject\UObject\UClass) * SpecificSubclass )


description: Because properties are destroyed here,Super::FinishDestroy()should always be called at the end of your child class'sFinishDestroy()method, rather than at the beginning.

code: virtual void FinishDestroy()


description: Deprecated* This method is deprecated.

code: bool GenerateColorTransformData ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDestinationColorSpace )


description: Deprecated* This method is deprecated.

code: bool GenerateColorTransformData ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDisplay, const [FString](API\Runtime\Core\Containers\FString) & InView, [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) InDirection )


description: Get the context key-values.

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & GetContextKeyValues() const


description:
Get the display view direction type, when applicable.
True if the transformation is of display-view type.

code: bool GetDisplayViewDirection ( [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) & OutDirection ) const


description: Returns a Guid for the LUT based on its unique identifier, name and the OCIO DDC key.

code: static void GetOpenColorIOLUTKeyGuid ( const [FString](API\Runtime\Core\Containers\FString) & InProcessorIdentifier, const [FName](API\Runtime\Core\UObject\FName) & InName, [FGuid](API\Runtime\Core\Misc\FGuid) & OutLutGuid )


description: Returns the desired resources required to apply this transform during rendering.

code: bool GetRenderResources ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel, [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) *& OutShaderResource, [TSortedMap](API\Runtime\Core\Containers\TSortedMap)< int32, [FTextureResource](API\Runtime\Engine\FTextureResource) * > & OutTextureResources )


description: Helper function returning the color space transform name based on source and destination color spaces.


description: Initialize resources for color space transform.

code: bool Initialize ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDestinationColorSpace, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InContextKeyValues )


description: Initialize resources for display-view transform.

code: bool Initialize ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDisplay, const [FString](API\Runtime\Core\Containers\FString) & InView, [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) InDirection, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InContextKeyValues )


description: Deprecated* This method is deprecated, please use Initialize without the owner argument.

code: bool Initialize ( [UOpenColorIOConfiguration](API\Plugins\OpenColorIO\UOpenColorIOConfiguration) * InOwner, const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDestinationColorSpace, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InContextKeyValues )


code: bool Initialize ( [UOpenColorIOConfiguration](API\Plugins\OpenColorIO\UOpenColorIOConfiguration) * InOwner, const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDisplay, const [FString](API\Runtime\Core\Containers\FString) & InView, [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) InDirection, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & InContextKeyValues )


description: Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData

code: virtual bool IsCachedCookedPlatformDataLoaded ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description:
Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

code: virtual bool IsReadyForFinishDestroy()


code: bool IsTransform ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDestinationColorSpace ) const


code: bool IsTransform ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDisplay, const [FString](API\Runtime\Core\Containers\FString) & InView, [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) InDirection ) const


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Helper function to register serialized shader maps for the given color transform resources

code: static void ProcessSerializedShaderMaps ( [UOpenColorIOColorTransform](API\Plugins\OpenColorIO\UOpenColorIOColorTransform) * Owner, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) > & LoadedResources, [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) *(&) OutColorTransformResourcesLoaded )


description: Releases rendering resources used by this color transform. This should only be called directly if the ColorTransform will not be deleted through the GC system afterward. FlushRenderingCommands() must have been called before this.

code: void ReleaseResources()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Serialize LUT data. This will effectively serialize the LUT only when cooking

code: void SerializeLuts ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Helper function to serialize shader maps for the given color transform resources.

code: static void SerializeOpenColorIOShaderMaps ( const [TMap](API\Runtime\Core\Containers\TMap)< const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) *, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * >> * PlatformColorTransformResourcesToSavePtr, [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) > & OutLoadedResources )


description: Apply the color transform in-place to the specified image.

code: bool TransformImage ( const [FImageView](API\Runtime\ImageCore\FImageView) & InOutImage ) const


description: Apply the color transform from the source image to the destination image. (The destinationFImageViewis const but what it points at is not.)

code: bool TransformImage ( const [FImageView](API\Runtime\ImageCore\FImageView) & SrcImage, const [FImageView](API\Runtime\ImageCore\FImageView) & DestImage ) const


code: bool UpdateShaderInfo ( [FString](API\Runtime\Core\Containers\FString) & OutShaderCodeHash, [FString](API\Runtime\Core\Containers\FString) & OutShaderCode, [FString](API\Runtime\Core\Containers\FString) & OutRawConfigHash )


code: virtual ~UOpenColorIOColorTransform()


className: UOpenColorIOColorTransform

description: Object used to generate shader and LUTs from OCIO configuration file and contain required resource to make a color space transform.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UOpenColorIOColorTransform : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

DisplayViewDirection

type: EOpenColorIOVie...


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: This method is called by directory watcher when any file or folder is changed in the directory where raw ocio config is located.

code: void ConfigPathChangedEvent ( const [TArray](API\Runtime\Core\Containers\TArray)< [FFileChangeData](API\Developer\DirectoryWatcher\FFileChangeData) > & InFileChanges, const [FString](API\Runtime\Core\Containers\FString) InFileMountPath )


code: void CreateColorTransform ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDestinationColorSpace )


code: void CreateColorTransform ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDisplay, const [FString](API\Runtime\Core\Containers\FString) & InView, [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) InDirection )


code: static void DeclareConstructClasses ( [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutConstructClasses, const [UClass](API\Runtime\CoreUObject\UObject\UClass) * SpecificSubclass )


code: const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UOpenColorIOColorTransform](API\Plugins\OpenColorIO\UOpenColorIOColorTransform) > * FindTransform ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings ) const


code: UOpenColorIOColorTransform ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


description: Internal only: Replacement for previousGetNativeConfig_Internal()_,GetLoadedConfiguration()and `GetLoadedConfigurationFile()functions, returning the private implementation of the native OCIO config.

code: FOpenColorIOWrapperConfig * GetConfigWrapper() const


code: bool GetRenderResources ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel, const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings, [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) *& OutShaderResource, [TSortedMap](API\Runtime\Core\Containers\TSortedMap)< int32, [FTextureResource](API\Runtime\Engine\FTextureResource) * > & OutTextureResources )


code: bool HasDesiredDisplayView ( const [FOpenColorIODisplayView](API\Plugins\OpenColorIO\FOpenColorIODisplayView) & DisplayView ) const


code: bool HasDesiredColorSpace ( const [FOpenColorIOColorSpace](API\Plugins\OpenColorIO\FOpenColorIOColorSpace) & ColorSpace ) const


code: bool HasTransform ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDestinationColorSpace )


code: bool HasTransform ( const [FString](API\Runtime\Core\Containers\FString) & InSourceColorSpace, const [FString](API\Runtime\Core\Containers\FString) & InDisplay, const [FString](API\Runtime\Core\Containers\FString) & InView, [EOpenColorIOViewTransformDirection](API\Plugins\OpenColorIO\EOpenColorIOViewTransformDirecti-) InDirection )


code: bool IsTransformReady ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


code: virtual void PostLoad()


description: Objects created from within PreSave will NOT have PreSave called on them!!!

code: virtual void PreSave ( [FObjectPreSaveContext](API\Runtime\CoreUObject\UObject\FObjectPreSaveContext) SaveContext )


description: This forces to reload colorspaces and corresponding shaders if those are not loaded already.


description: Same as above except user can specify the path manually.

code: void StartDirectoryWatch ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description: Stop watching the current directory.

code: void StopDirectoryWatch()


code: bool TransformImage ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings, const [FImageView](API\Runtime\ImageCore\FImageView) & InOutImage ) const


code: bool TransformImage ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & InSettings, const [FImageView](API\Runtime\ImageCore\FImageView) & SrcImage, const [FImageView](API\Runtime\ImageCore\FImageView) & DestImage ) const


code: UOpenColorIOConfiguration ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UOpenColorIOConfiguration

description: Asset to manage allowed OpenColorIO color spaces. This will create required transform objects.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(DisplayName="OpenColorIO Configuration")) class UOpenColorIOConfiguration : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

ConfigurationFile

type: FFilePath

DesiredColorSpaces

type: TArray<FOpenCo...


description: Creates an instance of this object, configured for use in game with the given OCIO configuration.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Create In-Game OpenColorIO Display Extension"), Category="OpenColorIO") static [UOpenColorIODisplayExtensionWrapper](API\Plugins\OpenColorIO\UOpenColorIODisplayExtensionWrap-) * CreateInGameOpenColorIODisplayExtension ( [FOpenColorIODisplayConfiguration](API\Plugins\OpenColorIO\FOpenColorIODisplayConfiguration) InDisplayConfiguration )


description: Creates an instance of this object, configured with the given arguments (OCIO and activation function).

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Create OpenColorIO Display Extension"), Category="OpenColorIO") static [UOpenColorIODisplayExtensionWrapper](API\Plugins\OpenColorIO\UOpenColorIODisplayExtensionWrap-) * CreateOpenColorIODisplayExtension ( [FOpenColorIODisplayConfiguration](API\Plugins\OpenColorIO\FOpenColorIODisplayConfiguration) InDisplayConfiguration, const [FSceneViewExtensionIsActiveFunctor](API\Runtime\Engine\FSceneViewExtensionIsActiveFunct-) & IsActiveFunction )


description: Gets the display extension OCIO configuration.


description: Removes the extension.


description: Sets the display extension OCIO configuration.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set OpenColorIO Configuration"), Category="OpenColorIO") void SetOpenColorIOConfiguration ( [FOpenColorIODisplayConfiguration](API\Plugins\OpenColorIO\FOpenColorIODisplayConfiguration) InDisplayConfiguration )


description: Sets a single activation function. Will remove any others.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenColorIO") void SetSceneExtensionIsActiveFunction ( const [FSceneViewExtensionIsActiveFunctor](API\Runtime\Engine\FSceneViewExtensionIsActiveFunct-) & IsActiveFunction )


description: Sets an array of activation functions. Will remove any others.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenColorIO") void SetSceneExtensionIsActiveFunctions ( const [TArray](API\Runtime\Core\Containers\TArray)< [FSceneViewExtensionIsActiveFunctor](API\Runtime\Engine\FSceneViewExtensionIsActiveFunct-) > & IsActiveFunctions )


className: UOpenColorIODisplayExtensionWrapper

description: This Blueprintable object can hold an OCIO Scene View Extension. You can change its OCIO config, and specify the context in which you want it to be active on.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(DisplayName="OpenColorIO Display Extension Wrapper")) class UOpenColorIODisplayExtensionWrapper : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetCategoryName() const


description: The unique name for your section of settings, uses the class'sFName.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetSectionName() const


description: Gets the section text, uses the classes DisplayName by default.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetSectionText() const


className: UOpenColorIOSettings

description: Rendering settings.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig) class UOpenColorIOSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)


className: UpdateOpenColorIOShaderCompilingStats

description: Called for every color transform shader to update the appropriate stats.

code: void UpdateOpenColorIOShaderCompilingStats ( const [FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) * InShader )


className: IOpenColorIOEditorModule

description: Interface for the OpenColorIOEditor module.

module: OpenColorIOEditor

code: class IOpenColorIOEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FOpenColorIOShaderProcessorTickable

description: Handles ticking the shader compilation manager and dispatch the results

code: class FOpenColorIOShaderProcessorTickable : private [FTickableEditorObject](API\Editor\UnrealEd\FTickableEditorObject)


description:
Apply a color space transform to a texture asset.
true upon success.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenColorIO") static bool ApplyColorSpaceTransformToTexture ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & ConversionSettings, [UTexture](API\Runtime\Engine\Engine\UTexture) * InOutTexture )


description:
Apply a color space transform with a target compression setting to a texture asset.
true upon success.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenColorIO") static bool ApplyColorSpaceTransformToTextureCompressed ( const [FOpenColorIOColorConversionSettings](API\Plugins\OpenColorIO\FOpenColorIOColorConversionSetti-) & ConversionSettings, TextureCompressionSettings TargetCompression, [UTexture](API\Runtime\Engine\Engine\UTexture) * InOutTexture )


description: Set the active editor viewport's display configuration color transform .

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenColorIO") static void SetActiveViewportConfiguration ( const [FOpenColorIODisplayConfiguration](API\Plugins\OpenColorIO\FOpenColorIODisplayConfiguration) & InConfiguration )


className: UOpenColorIOEditorBlueprintLibrary


className: EOpenCVArucoDictionary

module: OpenCVHelper

code: enum EOpenCVArucoDictionary { Dict4x4, Dict5x5, Dict6x6, Dict7x7, DictOriginal, }


className: EOpenCVArucoDictionarySize

code: enum EOpenCVArucoDictionarySize { DictSize50, DictSize100, DictSize250, DictSize1000, }


code: FOpenCVArucoDetectedMarker()


className: FOpenCVArucoDetectedMarker

Corners

type: TArray< FVector...

Pose

type: FTransform


description: Converts in-place the coordinate system of the given FTransform by specifying the source axes in terms of the destionation axes

code: static void ConvertCoordinateSystem ( FTransform & Transform, const [EAxis](API\Plugins\OpenCVHelper\FOpenCVHelper\EAxis) DstXInSrcAxis, const [EAxis](API\Plugins\OpenCVHelper\FOpenCVHelper\EAxis) DstYInSrcAxis, const [EAxis](API\Plugins\OpenCVHelper\FOpenCVHelper\EAxis) DstZInSrcAxis )


description: Converts in-place an FTransform in OpenCV coordinates to Unreal coordinates

code: static void ConvertOpenCVToUnreal ( FTransform & Transform )


description: Converts in-place an FTransform in Unreal coordinates to OpenCV coordinates

code: static void ConvertUnrealToOpenCV ( FTransform & Transform )


className: EAxis

description: Enumeration to specify any cartesian axis in positive or negative directions

code: enum EAxis { X, Y, Z, Xn, Yn, Zn, }


code: static const FVector & UnitVectorFromAxisEnum ( const [EAxis](API\Plugins\OpenCVHelper\FOpenCVHelper\EAxis) Axis )


className: UnitVectors

description: These axes must match the order in which they are declared in EAxis.

code: static const [TArray](API\Runtime\Core\Containers\TArray)< FVector > UnitVectors = { { 1, 0, 0 }, { 0, 1, 0 }, { 0, 0, 1 }, { -1, 0, 0 }, { 0, -1, 0 }, { 0, 0, -1 }, };


className: FOpenCVHelper

code: class FOpenCVHelper


description: Returns true if lens distortion parameters are for identity lens (or default parameters)

code: bool IsIdentity() const


description: Compare two lens distortion models and return whether they are equal.

code: bool operator== ( const [FOpenCVLensDistortionParametersBase](API\Plugins\OpenCVHelper\FOpenCVLensDistortionParametersB-) & Other ) const


description: Compare two lens distortion models and return whether they are different.

code: bool operator!= ( const [FOpenCVLensDistortionParametersBase](API\Plugins\OpenCVHelper\FOpenCVLensDistortionParametersB-) & Other ) const


code: FOpenCVLensDistortionParametersBase()


className: FOpenCVLensDistortionParametersBase

description: Mathematic camera model for lens distortion/undistortion. Camera matrix = | F.X 0 C.x | | 0 F.Y C.Y | | 0 0 1 | where F and C are normalized.

bUseFisheyeModel

description: Camera lens needs Fisheye camera model.

C

description: Camera matrix's normalized Cx and Cy.

F

description: Camera matrix's normalized Fx and Fy.

type: float

description: Radial parameter #1.

description: Radial parameter #2.

description: Radial parameter #3.

description: Radial parameter #4.

description: Radial parameter #5.

description: Radial parameter #6.

description: Tangential parameter #1.

description: Tangential parameter #2.


description: Virtual destructor.

code: virtual ~IOpenCVHelperModule()


description: Keep track of UE's int64 and uint64 typedefs to be able to restore it after including CV headers


className: IOpenCVHelperModule

code: class IOpenCVHelperModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Detects all ArUco markers in the supplied image
Total number of markers detected in the input image

code: static int32 OpenCVArucoDetectMarkers ( const [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InRenderTarget, const [EOpenCVArucoDictionary](API\Plugins\OpenCVHelper\EOpenCVArucoDictionary) InDictionary, const [EOpenCVArucoDictionarySize](API\Plugins\OpenCVHelper\EOpenCVArucoDictionarySize) InDictionarySize, const bool bDebugDrawMarkers, const bool bEstimatePose, const float InMarkerLengthInMeters, const [FOpenCVLensDistortionParametersBase](API\Plugins\OpenCVHelper\FOpenCVLensDistortionParametersB-) & InLensDistortionParameters, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) *& OutDebugTexture, [TArray](API\Runtime\Core\Containers\TArray)< [FOpenCVArucoDetectedMarker](API\Plugins\OpenCVHelper\FOpenCVArucoDetectedMarker) > & OutDetectedMarkers )


description:
Detects a camera calibration chessboard in the supplied image
Total number of corners detected in the input image

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenCV", Meta=(DisplayName="OpenCV Chessboard Detect Corners")) static int32 OpenCVChessboardDetectCorners ( const [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InRenderTarget, const FIntPoint InPatternSize, const bool bDebugDrawCorners, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) *& OutDebugTexture, [TArray](API\Runtime\Core\Containers\TArray)< FVector2D > & OutDetectedCorners )


className: UOpenCVBlueprintFunctionLibrary


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

module: OpenCVLensCalibration

code: static [IOpenCVLensCalibrationModule](API\Plugins\OpenCVLensCalibration\IOpenCVLensCalibrationModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IOpenCVLensCalibrationModule

description: The public interface to this module

code: class IOpenCVLensCalibrationModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: OpenCVLensDistortion

code: FOpenCVCameraViewInfo()


className: FOpenCVCameraViewInfo

FocalLengthRatio

description: Focal length aspect ratio -> Fy / Fx

HorizontalFOV

description: Horizontal Field Of View in degrees

VerticalFOV

description: Vertical Field Of View in degrees


description: Creates a texture containing a DisplacementMap in the Red and the Green channel for undistorting a camera image. This call can take quite some time to process depending on the resolution.

code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CreateUndistortUVDisplacementMap ( const FIntPoint & InImageSize, const float InCroppingFactor, [FOpenCVCameraViewInfo](API\Plugins\OpenCVLensDistortion\FOpenCVCameraViewInfo) & OutCameraViewInfo ) const


description: Draws UV displacement map within the output render target.

code: static void DrawDisplacementMapToRenderTarget ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InOutputRenderTarget, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * InPreComputedUndistortDisplacementMap )


className: FOpenCVLensDistortionParameters


code: static [IOpenCVLensDistortionModule](API\Plugins\OpenCVLensDistortion\IOpenCVLensDistortionModule) & Get()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: IOpenCVLensDistortionModule

description: The public interface to this module

code: class IOpenCVLensDistortionModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Creates a texture containing a DisplacementMap in the Red and the Green channel for undistorting a camera image. This call can take quite some time to process depending on the resolution.
Texture2D containing the distort to undistort space displacement map.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Lens Distortion | OpenCV", Meta=(WorldContext="WorldContextObject")) static [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CreateUndistortUVDisplacementMap ( const [FOpenCVLensDistortionParameters](API\Plugins\OpenCVLensDistortion\FOpenCVLensDistortionParameters) & LensParameters, const FIntPoint & ImageSize, const float CroppingFactor, [FOpenCVCameraViewInfo](API\Plugins\OpenCVLensDistortion\FOpenCVCameraViewInfo) & CameraViewInfo )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Lens Distortion | OpenCV", Meta=(WorldContext="WorldContextObject")) static void DrawDisplacementMapToRenderTarget ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * OutputRenderTarget, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * PreComputedUndistortDisplacementMap )


description: Returns true if A is equal to B (A == B)

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="Equal (LensDistortionParameters)", CompactNodeTitle="==", Keywords="== equal", ScriptOperator="=="), Category="Lens Distortion") static bool EqualEqual_CompareLensDistortionModels ( const [FOpenCVLensDistortionParameters](API\Plugins\OpenCVLensDistortion\FOpenCVLensDistortionParameters) & A, const [FOpenCVLensDistortionParameters](API\Plugins\OpenCVLensDistortion\FOpenCVLensDistortionParameters) & B )


description: Returns true if A is not equal to B (A != B)

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="NotEqual (LensDistortionParameters)", CompactNodeTitle="!=", Keywords="!= not equal", ScriptOperator="!="), Category="Lens Distortion") static bool NotEqual_CompareLensDistortionModels ( const [FOpenCVLensDistortionParameters](API\Plugins\OpenCVLensDistortion\FOpenCVLensDistortionParameters) & A, const [FOpenCVLensDistortionParameters](API\Plugins\OpenCVLensDistortion\FOpenCVLensDistortionParameters) & B )


code: UOpenCVLensDistortionBlueprintLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UOpenCVLensDistortionBlueprintLibrary


description: Call this to get the number of mipmap levels.

module: OpenExrWrapper

code: virtual int32 GetNumberOfMipLevels()


description: Call this to add an attribute to the EXR file. This MUST be called before CreateOutputFile.

code: void AddIntAttribute ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 Value )


description: Constructor.

code: FBaseOutputFile ( const FIntPoint & DisplayWindowMin, const FIntPoint & DisplayWindowMax, const FIntPoint & DataWindowMin, const FIntPoint & DataWindowMax )


description: Destructor.

code: virtual ~FBaseOutputFile()


className: FBaseOutputFile

description: Base class for our classes that output EXR files.

code: class FBaseOutputFile

Header

type: void *

description: Stores the EXR header object.

OutputFile

description: Stores the EXR object.


code: static void SetGlobalThreadCount ( uint16 ThreadCount )


code: int32 CalculateNumMipLevels ( const FIntPoint & NumTiles ) const


code: const TCHAR * GetCompressionName() const


code: FIntPoint GetDataWindow() const


code: [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFrameRate ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & DefaultValue ) const


description:
Get an attribute from the image.
True if the attribute was found, false otherwise.

code: bool GetIntAttribute ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 & Value )


description: Gets tile dimensions. Returns false if image has no tiles.

code: bool GetTileSize ( FIntPoint & OutTileSize ) const


code: int32 GetNumChannels() const


code: int32 GetUncompressedSize() const


code: FOpenExrHeaderReader ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


className: FOpenExrHeaderReader

code: class FOpenExrHeaderReader


code: FIntRect GetDataWindowRect() const


code: FIntRect GetDisplayWindow() const


code: void ReadPixels ( int32 StartY, int32 EndY )


code: void SetFrameBuffer ( void * Buffer, const FIntPoint & Stride )


code: FRgbaInputFile ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


code: FRgbaInputFile ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, uint16 ThreadCount )


className: FRgbaInputFile

code: class FRgbaInputFile


description: Call this before CreateOutputFile for each channel in the image.

code: void AddChannel ( const [FString](API\Runtime\Core\Containers\FString) & Name )


description: Call this before SetFrameBuffer for each channel in the frame buffer.

code: void AddFrameBufferChannel ( const [FString](API\Runtime\Core\Containers\FString) & Name, void * Base, const FIntPoint & Stride )


description: Call this after adding any attributes or channels BUT before doing anything else.

code: void CreateOutputFile ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, int32 TileWidth, int32 TileHeight, bool bIsMipsEnabled, int32 NumThreads )


description: Get the height of a mip level.

code: int32 GetMipHeight ( int32 MipLevel )


description: Get the width of a mip level.

code: int32 GetMipWidth ( int32 MipLevel )


code: virtual int32 GetNumberOfMipLevels()


description: Get number of horizontal tiles for a mip level.

code: int32 GetNumXTiles ( int32 MipLevel )


description: Get number of vertical tiles for a mip level.

code: int32 GetNumYTiles ( int32 MipLevel )


description: Call this prior to WriteTile to set where the data is coming from.

code: void SetFrameBuffer()


description: Call this to change a channel in the frame buffer.

code: void UpdateFrameBufferChannel ( const [FString](API\Runtime\Core\Containers\FString) & Name, void * Base, const FIntPoint & Stride )


description: Call this to write data to some tiles. If tiles are not enabled then this just writes out the whole image.

code: void WriteTiles ( int32 TileX1, int32 TileX2, int32 TileY1, int32 TileY2, int32 MipLevel )


description: Constructor.

code: FTiledOutputFile ( const FIntPoint & DisplayWindowMin, const FIntPoint & DisplayWindowMax, const FIntPoint & DataWindowMin, const FIntPoint & DataWindowMax, bool bInIsTiled )


description: Call this to write data to a specific tile. If tiles are not enabled then this just writes out the whole image.

code: void WriteTile ( int32 TileX, int32 TileY, int32 MipLevel )


description: Destructor.

code: virtual ~FTiledOutputFile()


className: FTiledOutputFile

description: Add any attributes and AddChannel after construction. Then you can call CreateOutputFile. Then you can call AddFrameBufferChannel for each channel, and then SetFrameBuffer. After that, you can write out data to the file.

code: class FTiledOutputFile : public [FBaseOutputFile](API\Plugins\OpenExrWrapper\FBaseOutputFile)


description: Call this after adding any attributes BUT before doing anything else.

code: void CreateOutputFile ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, int32 TileWidth, int32 TileHeight, int32 NumChannels, bool bIsMipsEnabled )


code: void SetFrameBuffer ( void * Buffer, const FIntPoint & Stride )


description: Call this to write data to a specific tile.


description: Constructor.

code: FTiledRgbaOutputFile ( const FIntPoint & DisplayWindowMin, const FIntPoint & DisplayWindowMax, const FIntPoint & DataWindowMin, const FIntPoint & DataWindowMax )


className: FTiledRgbaOutputFile

description: Add any attributes after construction. Then you can call CreateOutputFile. After that, you can write out data to the file.

code: class FTiledRgbaOutputFile : public [FBaseOutputFile](API\Plugins\OpenExrWrapper\FBaseOutputFile)


className: EDataType

module: OpenXRAR

code: enum EDataType { Unknown, Mesh, QRCode, Plane, }


code: [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * ConstructNewTrackedGeometry ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > ARSupportInterface )


code: void UpdateTrackedGeometry ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > ARSupportInterface )


code: virtual ~FOpenXRARTrackedGeometryData()


description: Force derived classes to init the type.

code: FOpenXRARTrackedGeometryData ( [EDataType](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData\EDataType) InDataType )


className: FOpenXRARTrackedGeometryData

description: Base class for ARTrackedGeometryData These structs are designed to be constructed by openxr plugin code on any thread and then used by UE4 on the Game Thread. All their data members need to be safe to create on any thread.

code: struct FOpenXRARTrackedGeometryData : public [FNoncopyable](API\Runtime\Core\Templates\FNoncopyable)

DataType

type: constEDataType

Id

type: FGuid

TrackingState

type: EARTrackingStat...


code: virtual [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * ConstructNewTrackedGeometry ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > ARSupportInterface )


code: bool HasSpatialMeshUsageFlag ( const EARSpatialMeshUsageFlags & InFlag )


code: virtual void UpdateTrackedGeometry ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > ARSupportInterface )


className: FOpenXRMeshUpdate

code: struct FOpenXRMeshUpdate : public [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData)

Indices

type: TArray< uint32 ...

SpatialMeshUsageFlags

type: EARSpatialMeshU...

Type

type: EARObjectClassi...


className: FOpenXRPlaneUpdate

code: struct FOpenXRPlaneUpdate : public [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData)

Extent

type: FVector


className: FOpenXRQRCodeData

code: struct FOpenXRQRCodeData : public [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData)

QRCode

type: FString

Timestamp

type: double


description: Deprecated* Use overload with SharedPtr instead.

code: void ARTrackedGeometryAdded ( struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) * InData )


code: void ARTrackedGeometryAdded ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) > InData )


code: void ARTrackedGeometryRemoved ( struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) * InData )


code: void ARTrackedGeometryRemoved ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) > InData )


code: void ARTrackedGeometryUpdated ( struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) * InData )


code: void ARTrackedGeometryUpdated ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) > InData )


code: [FOpenXRMeshUpdate](API\Plugins\OpenXRAR\FOpenXRMeshUpdate) * AllocateMeshUpdate ( [FGuid](API\Runtime\Core\Misc\FGuid) InGuidMeshUpdate )


className: IOpenXRARTrackedGeometryHolder

code: class IOpenXRARTrackedGeometryHolder : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: [FOpenXRPlaneUpdate](API\Plugins\OpenXRAR\FOpenXRPlaneUpdate) * AllocatePlaneUpdate ( [FGuid](API\Runtime\Core\Misc\FGuid) InGuidPlaneUpdate )


code: void ObjectUpdated ( [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) * InUpdate )


code: void ObjectUpdated ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< struct [FOpenXRARTrackedGeometryData](API\Plugins\OpenXRAR\FOpenXRARTrackedGeometryData) > )


code: void RemoveMesh ( [FGuid](API\Runtime\Core\Misc\FGuid) InGuidMeshUpdate )


code: void RemovePlane ( [FGuid](API\Runtime\Core\Misc\FGuid) InGuidPlaneUpdate )


code: virtual ~IOpenXRARTrackedMeshHolder()


className: IOpenXRARTrackedMeshHolder

code: class IOpenXRARTrackedMeshHolder


className: IOpenXREditorModule

module: OpenXREditor

code: class IOpenXREditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

module: OpenXREyeTracker

code: static [IOpenXREyeTrackerModule](API\Plugins\OpenXREyeTracker\IOpenXREyeTrackerModule) & Get()


code: virtual [FString](API\Runtime\Core\Containers\FString) GetModuleKeyName() const


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IOpenXREyeTrackerModule

description: The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

code: class IOpenXREyeTrackerModule : public [IEyeTrackerModule](API\Runtime\EyeTracker\IEyeTrackerModule)


module: OpenXRHandTracking

code: void AddLiveLinkSource()


description:
Returns the Input Device associated with this InputDeviceModule.
Shared pointer to the Input Device.


description:
Returns the LiveLinkSource associated with this OpenXRHandTrackingPlugin.
Shared pointer to the Input Device.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILiveLinkSource](API\Runtime\LiveLinkInterface\ILiveLinkSource) > GetLiveLinkSource()


code: static [IOpenXRHandTrackingModule](API\Plugins\OpenXRHandTracking\IOpenXRHandTrackingModule) & Get()


description:
Checks if the LiveLinkSource as been created.
True if the LiveLinkSource has been created with GetLiveLinkSource or AddLiveLinkSource

code: bool IsLiveLinkSourceValid() const


code: void RemoveLiveLinkSource()


className: IOpenXRHandTrackingModule

code: class IOpenXRHandTrackingModule : public [IInputDeviceModule](API\Runtime\InputDevice\IInputDeviceModule)


className: UOpenXRHandTrackingSettings

description: Implements the settings for the OpenXR Input plugin.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Input, defaultconfig) class UOpenXRHandTrackingSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: UOpenXRHandTrackingSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Delegates.

module: OpenXRHMD

code: typedef TMulticastDelegate_ThreeParams< void, XrHapticVibration *, [FOpenXRExtensionChainStructPtrs](API\Plugins\OpenXRHMD\FOpenXRExtensionChainStructPtrs) &, struct [FHapticFeedbackBuffer](API\Runtime\ApplicationCore\GenericPlatform\FHapticFeedbackBuffer) * > FApplyHapticFeedbackAddChainStructsDelegate


className: FilterActionName

code: void FilterActionName ( const char * InActionName, char * OutActionName )


className: FOpenXRAssetDirectory

code: class FOpenXRAssetDirectory


code: virtual ~FOpenXRExtensionChainStruct()


className: FOpenXRExtensionChainStruct

code: struct FOpenXRExtensionChainStruct


className: FOpenXRExtensionChainStructPtrs


description: Get the number of characters, excluding null-terminator, thatToString()would yield

code: uint32 GetStringLength() const


className: FOpenXRPath::operator bool

code: operator bool() const


className: FOpenXRPath::operator FName

code: operator FName() const


className: FOpenXRPath::operator FString

code: operator FString() const


description: Operators to append another path ensuring the / character is used between them

code: [FOpenXRPath](API\Plugins\OpenXRHMD\FOpenXRPath) operator/ ( const char * Suffix ) const


code: [FOpenXRPath](API\Plugins\OpenXRHMD\FOpenXRPath) operator/ ( [FString](API\Runtime\Core\Containers\FString) Suffix ) const


code: [FOpenXRPath](API\Plugins\OpenXRHMD\FOpenXRPath) operator/ ( [FOpenXRPath](API\Plugins\OpenXRHMD\FOpenXRPath) Suffix ) const


description: Efficiently converts an XrPath to anFNameFNamerepresenting the path


description:
Converts an XrPath to a readable format
String representation of the path


description: Efficiently converts anFNameto an XrPath

code: FOpenXRPath ( [FName](API\Runtime\Core\UObject\FName) InName )


description: Converts a string to an XrPath

code: FOpenXRPath ( const char * PathString )


code: FOpenXRPath ( const [FString](API\Runtime\Core\Containers\FString) & PathString )


className: FOpenXRPath::operator XrPath

code: operator XrPath() const


className: FOpenXRPath

description: XrPath wrapper with convenience functions

code: class FOpenXRPath


className: FXrCompositionLayerUnion

code: union FXrCompositionLayerUnion

Cylinder

type: XrCompositionLa...


className: InitOpenXRCore

description:
Initialize core OpenXR functions.
true if initialization was successful.

code: bool InitOpenXRCore ( XrInstance Instance )


description: Used to init our AR system


code: static [IOpenXRARModule](API\Plugins\OpenXRHMD\IOpenXRARModule) & Get()


code: bool GetExtensions ( [TArray](API\Runtime\Core\Containers\TArray)< const ANSICHAR * > & OutExtensions )


code: static bool IsAvailable()


code: void SetTrackingSystem ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FXRTrackingSystemBase](API\Plugins\XRBase\FXRTrackingSystemBase), ESPMode::ThreadSafe > InTrackingSystem )


className: IOpenXRARModule

code: class IOpenXRARModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual bool ArePinsReadyToLoad()


description: ARPin Local Store support. Some Platforms/Devices have the ability to persist AR Anchors (real world positions) to the device or user account. They are saved and loaded with a string identifier.

code: virtual bool IsLocalPinSaveSupported() const


code: virtual void LoadARPins ( XrSession InSession, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [UARPin](API\Runtime\AugmentedReality\UARPin) *([FName](API\Runtime\Core\UObject\FName))> OnCreatePin )


description: Method to add an anchor on tracking space

code: bool OnPinComponent ( class [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin, XrSession InSession, XrSpace TrackingSpace, XrTime DisplayTime, float worldToMeterScale )


description: Method to remove an anchor from tracking space

code: void OnRemovePin ( class [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin )


code: void OnUpdatePin ( class [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin, XrSession InSession, XrSpace TrackingSpace, XrTime DisplayTime, float worldToMeterScale )


code: virtual void RemoveAllSavedARPins ( XrSession InSession )


code: virtual void RemoveSavedARPin ( XrSession InSession, [FName](API\Runtime\Core\UObject\FName) InName )


code: virtual bool SaveARPin ( XrSession InSession, [FName](API\Runtime\Core\UObject\FName) InName, [UARPin](API\Runtime\AugmentedReality\UARPin) * InPin )


className: IOpenXRCustomAnchorSupport

code: class IOpenXRCustomAnchorSupport


code: virtual FTransform GetCameraTransform() const


code: virtual FVector GetWorldSpaceRayFromCameraPoint ( FVector2D pixelCoordinate ) const


description: the AR texture for the specified type

code: virtual [UARTexture](API\Runtime\AugmentedReality\UARTexture) * OnGetARTexture ( EARTextureType TextureType ) const


code: virtual bool OnGetCameraIntrinsics ( struct [FARCameraIntrinsics](API\Runtime\AugmentedReality\FARCameraIntrinsics) & OutCameraIntrinsics ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > OnLineTraceTrackedObjects ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > ARCompositionComponent, const FVector Start, const FVector End, const EARLineTraceChannels TraceChannels )


code: virtual bool OnToggleARCapture ( const bool bOnOff )


className: IOpenXRCustomCaptureSupport

code: class IOpenXRCustomCaptureSupport


description: Add any actions provided by the plugin to Actions. This allows a plugin to 'hard code' an action so that the plugin can use it.

code: virtual void AddActions ( XrInstance Instance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< XrAction(XrActionType InActionType, const [FName](API\Runtime\Core\UObject\FName) &InName, const [TArray](API\Runtime\Core\Containers\TArray)< XrPath > &InSubactionPaths)> AddAction )


description: Deprecated* Functionality moved toAttachActionSets().

code: virtual void AddActionSets ( [TArray](API\Runtime\Core\Containers\TArray)< XrActiveActionSet > & OutActionSets )


description: Add any action sets provided by the plugin to be attached as active to the session This allows a plugin to manage a custom actionset that will be active in xrSyncActions

code: virtual void AttachActionSets ( [TSet](API\Runtime\Core\Containers\TSet)< XrActionSet > & OutActionSets )


code: virtual void BindExtensionPluginDelegates ( class [IOpenXRExtensionPluginDelegates](API\Plugins\OpenXRHMD\IOpenXRExtensionPluginDelegates) & OpenXRHMD )


description: Specify action sets to be included in XrActionsSyncInfo::activeActionSets.

code: virtual void GetActiveActionSetsForSync ( [TArray](API\Runtime\Core\Containers\TArray)< XrActiveActionSet > & OutActiveSets )


description: NOTE: All models that can be returned also need to be returned in GetControllerModels() so they're included when cooking a project. If this is skipped the controllers won't show up in packaged projects

code: virtual bool GetControllerModel ( XrInstance InInstance, XrPath InInteractionProfile, XrPath InDevicePath, [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & OutPath )


description: Add all asset paths that need to be packaged for cooking.

code: virtual void GetControllerModelsForCooking ( [TArray](API\Runtime\Core\Containers\TArray)< [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) > & OutPaths )


description: Get custom anchor interface if provided by this extension.

code: virtual [IOpenXRCustomAnchorSupport](API\Plugins\OpenXRHMD\IOpenXRCustomAnchorSupport) * GetCustomAnchorSupport()


description: Get custom capture interface if provided by this extension.

code: virtual [IOpenXRCustomCaptureSupport](API\Plugins\OpenXRHMD\IOpenXRCustomCaptureSupport) * GetCustomCaptureSupport ( const EARCaptureType CaptureType )


description: Optionally use a custom loader (via GetInstanceProcAddr) for the OpenXR plugin.

code: virtual bool GetCustomLoader ( PFN_xrGetInstanceProcAddr * OutGetProcAddr )


description: Optionally provide a custom render bridge for the OpenXR plugin. Note: this returns a pointer to a new instance allocated with "new". Calling code is responsible for eventually deleting it.

code: virtual FOpenXRRenderBridge * GetCustomRenderBridge ( XrInstance InInstance )


description: Set the output parameters to add an interaction profile to OpenXR Input

code: virtual bool GetInteractionProfile ( XrInstance InInstance, [FString](API\Runtime\Core\Containers\FString) & OutKeyPrefix, XrPath & OutPath, bool & OutHasHaptics )


description: Fill the array with extensions optionally supported by the plugin If false is returned the plugin and its extensions will be ignored

code: virtual bool GetOptionalExtensions ( [TArray](API\Runtime\Core\Containers\TArray)< const ANSICHAR * > & OutExtensions )


description: Fill the array with extensions required by the plugin If false is returned the plugin and its extensions will be ignored

code: virtual bool GetRequiredExtensions ( [TArray](API\Runtime\Core\Containers\TArray)< const ANSICHAR * > & OutExtensions )


description: Set a spectator screen controller specific to the platform If true is returned and OutSpectatorScreenController is nullptr, spectator screen will be disabled If false is returned a default spectator screen controller will be created

code: virtual bool GetSpectatorScreenController ( [FHeadMountedDisplayBase](API\Plugins\XRBase\FHeadMountedDisplayBase) * InHMDBase, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FDefaultSpectatorScreenController](API\Plugins\XRBase\FDefaultSpectatorScreenControlle-) > & OutSpectatorScreenController )


description: Experimental: Optionally hand off the loader/plugin GetInstanceProcAddr to an extension plugin to support API layering. Returns true if plugin is wrapping API. Layers can chain by using received GetProcAddr to hand off API calls.

code: virtual bool InsertOpenXRAPILayer ( PFN_xrGetInstanceProcAddr & InOutGetProcAddr )


description: Indicates that the device we're currently running does not support a spectator view. This will only be called once at initialization and should only return a result based for the current device the engine is running on.


code: virtual const void * OnBeginFrame ( XrSession InSession, XrTime DisplayTime, const void * InNext )


code: virtual const void * OnBeginDepthInfo ( XrSession InSession, int32 InLayerIndex, int32 InViewIndex, const void * InNext )


code: virtual const void * OnBeginProjectionView ( XrSession InSession, int32 InLayerIndex, int32 InViewIndex, const void * InNext )


description: OpenXRHMD::OnBeginRendering_RenderThread.

code: virtual void OnBeginRendering_RenderThread ( XrSession InSession )


code: virtual const void * OnBeginSession ( XrSession InSession, const void * InNext )


description: Callbacks with returned pointer added to next chain, donotreturn pointers to structs on the stack. Remember to assign InNext to the next pointer of your struct or otherwise you may break the next chain.

code: virtual const void * OnCreateInstance ( class [IOpenXRHMDModule](API\Plugins\OpenXRHMD\IOpenXRHMDModule) * InModule, const void * InNext )


code: virtual const void * OnCreateSession ( XrInstance InInstance, XrSystemId InSystem, const void * InNext )


code: virtual void OnDestroySession ( XrSession InSession )


description: FOpenXRRenderBridge::Present, RHI thread.

code: virtual const void * OnEndFrame ( XrSession InSession, XrTime DisplayTime, const void * InNext )


code: virtual const void * OnEndProjectionLayer ( XrSession InSession, int32 InLayerIndex, const void * InNext, XrCompositionLayerFlags & OutFlags )


code: virtual void * OnEnumerateViewConfigurationViews ( XrInstance InInstance, XrSystemId InSystem, XrViewConfigurationType InViewConfigurationType, uint32_t InViewIndex, void * InNext )


description: Use this callback to handle events that the OpenXR plugin doesn't handle itself

code: virtual void OnEvent ( XrSession InSession, const XrEventDataBaseHeader * InHeader )


code: virtual const void * OnGetSystem ( XrInstance InInstance, const void * InNext )


code: virtual const void * OnLocateViews ( XrSession InSession, XrTime InDisplayTime, const void * InNext )


description: Stop the AR system but leave its internal state intact.

code: virtual void OnPauseARSession()


code: virtual void OnSetDeviceProperty ( XrSession InSession, int32 ControllerId, const [FInputDeviceProperty](API\Runtime\ApplicationCore\GenericPlatform\FInputDeviceProperty) * Property )


description: FOpenXRHMD::OnBeginRendering_RenderThread.

code: virtual void OnSetupLayers_RenderThread ( XrSession InSession, const [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & LayerIds )


description:
Start the AR system.
true if the system was successfully started

code: virtual void OnStartARSession ( class [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig )


description: Stop the AR system and reset its internal state; this task must succeed.

code: virtual void OnStopARSession()


description: FOpenXRInput::Tick, game thread, setting up for xrSyncActions. This happens near the start of the game frame.

code: virtual const void * OnSyncActions ( XrSession InSession, const void * InNext )


code: virtual void * OnWaitFrame ( XrSession InSession, void * InNext )


code: virtual void PostCreateInstance ( XrInstance InInstance )


code: virtual void PostCreateSession ( XrSession InSession )


code: virtual void PostGetSystem ( XrInstance InInstance, XrSystemId InSystem )


description: FOpenXRInput::Tick, game thread, after xrSyncActions.

code: virtual void PostSyncActions ( XrSession InSession )


description: Register module as an extension on startup. It is common to do this in StartupModule of yourIModuleInterfaceclass (which may also be the class that implements this interface). The module's LoadingPhase must be PostConfigInit or earlier because OpenXRHMD will look for these after it is loaded in that phase.


description: FOpenXRHMD::OnFinishRendering_RHIThread.

code: virtual void UpdateCompositionLayers ( XrSession InSession, [TArray](API\Runtime\Core\Containers\TArray)< const XrCompositionLayerBaseHeader * > & Headers )


description: OpenXRHMD::OnStartGameFrame.

code: virtual void UpdateDeviceLocations ( XrSession InSession, XrTime DisplayTime, XrSpace TrackingSpace )


description: Update OpenXRHMD to use reference space types other than view, local, and stage.

code: virtual bool UseCustomReferenceSpaceType ( XrReferenceSpaceType & OutReferenceSpaceType )


code: virtual ~IOpenXRExtensionPlugin()


className: IOpenXRExtensionPlugin

code: class IOpenXRExtensionPlugin : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


className: IOpenXRExtensionPluginDelegates

code: class IOpenXRExtensionPluginDelegates


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IOpenXRHMDModule](API\Plugins\OpenXRHMD\IOpenXRHMDModule) & Get()


code: bool IsExtensionAvailable ( const [FString](API\Runtime\Core\Containers\FString) & Name ) const


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


code: bool IsExtensionEnabled ( const [FString](API\Runtime\Core\Containers\FString) & Name ) const


code: bool IsLayerAvailable ( const [FString](API\Runtime\Core\Containers\FString) & Name ) const


code: bool IsLayerEnabled ( const [FString](API\Runtime\Core\Containers\FString) & Name ) const


code: XrPath ResolveNameToPath ( [FName](API\Runtime\Core\UObject\FName) Name )


code: [FName](API\Runtime\Core\UObject\FName) ResolvePathToName ( XrPath Path )


className: IOpenXRHMDModule

description: The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

code: class IOpenXRHMDModule : public [IHeadMountedDisplayModule](API\Runtime\HeadMountedDisplay\IHeadMountedDisplayModule)


className: IOpenXRInputModule

code: class IOpenXRInputModule


className: OpenXRReferenceSpaceTypeToString

code: constexpr const TCHAR * OpenXRReferenceSpaceTypeToString ( XrReferenceSpaceType e )


className: OpenXRResultToString

code: constexpr const TCHAR * OpenXRResultToString ( XrResult e )


className: OpenXRSessionStateToString

code: constexpr const TCHAR * OpenXRSessionStateToString ( XrSessionState e )


className: PreInitOpenXRCore

description:
Initialize essential OpenXR functions.
true if initialization was successful.

code: bool PreInitOpenXRCore ( PFN_xrGetInstanceProcAddr InGetProcAddr )


className: ToFIntRect

code: FIntRect ToFIntRect ( XrRect2Di Rect )


className: ToFQuat

code: FQuat ToFQuat ( XrQuaternionf Quat )


className: ToFTimespan

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) ToFTimespan ( XrTime Time )


className: ToFTransform

code: FTransform ToFTransform ( XrPosef Transform, float Scale )


className: ToFVector

code: FVector ToFVector ( XrVector3f Vector, float Scale )


code: FVector2D ToFVector2D ( XrVector2f Vector, float Scale )


code: FVector2D ToFVector2D ( XrExtent2Df Extent, float Scale )


code: FVector3f ToFVector3f ( XrVector3f Vector, float Scale )


code: TOpenXRExtensionChainStruct ( void * Head, XrStructureType XRType )


code: virtual ~TOpenXRExtensionChainStruct()


className: TOpenXRExtensionChainStruct

code: template<typename ChainStructType> struct TOpenXRExtensionChainStruct : public [FOpenXRExtensionChainStruct](API\Plugins\OpenXRHMD\FOpenXRExtensionChainStruct)

Data

type: ChainStructType


code: XrExtent2Df ToXrExtent2D ( FVector2D Vector, float Scale )


className: ToXrPose

code: XrPosef ToXrPose ( FTransform Transform, float Scale )


className: ToXrPriority

code: uint32 ToXrPriority ( int32 Priority )


className: ToXrQuat

code: XrQuaternionf ToXrQuat ( FQuat Quat )


className: ToXrRect

code: XrRect2Di ToXrRect ( FIntRect Rect )


className: ToXrTime

code: XrTime ToXrTime ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Time )


className: ToXrVector

code: XrVector3f ToXrVector ( FVector Vector, float Scale )


code: XrVector2f ToXrVector2f ( FVector2D Vector, float Scale )


description: Allows to change the environment blend mode at runtime.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="OpenXR|Experimental") static void SetEnvironmentBlendMode ( int32 NewBlendMode )


code: UOpenXRBlueprintFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UOpenXRBlueprintFunctionLibrary


code: UOpenXRHMDSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UOpenXRHMDSettings

description: Implements the settings for the OpenXR HMD plugin.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Game, defaultconfig) class UOpenXRHMDSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bIsFBFoveationEnabled

type: bool

description: Enables foveation provided by the XR_FB_foveation OpenXR extension.


module: OpenXRInput

code: static [IOpenXRInputPlugin](API\Plugins\OpenXRInput\IOpenXRInputPlugin) & Get()


code: static bool IsAvailable()


className: IOpenXRInputPlugin

code: class IOpenXRInputPlugin : public [IInputDeviceModule](API\Runtime\InputDevice\IInputDeviceModule)