Skip to content
Prysm Unreal documentation
SiteEmail
READ TIME: 5 MIN

FCohtmlFileHandler

Inherits from FTickableGameObject, IAsyncResourceHandler

Public Types

Section titled “Public Types”
Name
enum classEResourceProtocol { Coui, UnrealAsset, Http}

Public Functions

Section titled “Public Functions”
Name
FCohtmlFileHandler()
virtual~FCohtmlFileHandler() override
virtual voidCancelResourceRequests()
virtual voidOnResourceRequest(const cohtml::IAsyncResourceRequest * request, cohtml::IAsyncResourceResponse * response) override
virtual voidOnAbortResourceRequest(unsigned Id) override
Called when the backend wants a load to abort. The user is STILL REQUIRED to call Finish on the resource response with the associated request.
virtual voidOnUserImageDropped(void * UserData, void * TexturePtr)
virtual voidSetActiveSystem(TWeakPtr< class FCohtmlSystemWrapper, ESPMode::ThreadSafe > SystemPtr)
virtual boolIsCurrentlyLoading()
virtual FCohtmlPathResolver *GetPathResolver()
virtual voidEnsureNoResourceRequests()
virtual boolTryGetResourcePath(const cohtml::IAsyncResourceRequest * Request, EResourceProtocol & ResourceProtocol, FURLWithFallbacks & ResultPath)
virtual voidOnUnrealResourceLoaded(unsigned Id, const FUnrealResourceTaskPtr ResourceTask)
virtual voidOnUnrealResourceLoaded(unsigned Id, FCohUnrealResourcePtr & ResourcePtr, cohtml::IAsyncResourceResponse * Response)
virtual boolTryConvertFilenameToTexture2DPath(const FString & Path, FString & ConvertedPath)
virtual boolTryEnqueueUnrealResource(unsigned Id, const FString & RelativePath, cohtml::IAsyncResourceResponse * Response)
virtual boolTryReceiveUserImage(FCohUnrealResourcePtr & Resource, cohtml::IAsyncResourceResponse * Response)
virtual voidTick(float DeltaTime) override
virtual boolIsTickable() const override
virtual boolIsTickableInEditor() const override
virtual boolIsTickableWhenPaused() const override
virtual TStatIdGetStatId() const override
virtual UTexture *TryLoadUAssetImmediately(FSoftObjectPath & RequestPathAsset)
boolIsCurrentlyLoadingUnrealResources()
voidAbortUnrealResourceRequest(unsigned Id)
voidCancelUnrealResourceRequests()
voidEnsureNoUnrealResourceRequests()

Protected Functions

Section titled “Protected Functions”
Name
FURLWithFallbacksGeneratePossibleURLs(const cohtml::IAsyncResourceRequest * Request)

Public Attributes

Section titled “Public Attributes”
Name
FCriticalSectionUnrealResourceLock
TMap< unsigned, FUnrealResourceTaskPtr >UnrealResourceQueue
FCriticalSectionPendingUnrealResourceLock
TMap< unsigned, FTexturePendingReceival >PendingUnrealResources
TArray< FCohUnrealResourcePtr >AbortedPendingUnrealResources

Protected Attributes

Section titled “Protected Attributes”
Name
FCohtmlHTTPFileHandlerHTTPFileHandler
FCohtmlRawResourceHandlerRawResourceHandler
ICohtmlPlugin::FOnURLRequestFallbackURLsOverride
TWeakPtr< class FCohtmlSystemWrapper, ESPMode::ThreadSafe >System
TUniquePtr< FCohtmlPathResolver >PathResolver

Public Types Documentation

Section titled “Public Types Documentation”

enum EResourceProtocol

Section titled “enum EResourceProtocol”
EnumeratorValueDescription
Coui
UnrealAsset
Http

Public Functions Documentation

Section titled “Public Functions Documentation”

function FCohtmlFileHandler

Section titled “function FCohtmlFileHandler”
FCohtmlFileHandler()

function ~FCohtmlFileHandler

Section titled “function ~FCohtmlFileHandler”
virtual ~FCohtmlFileHandler() override

function CancelResourceRequests

Section titled “function CancelResourceRequests”
virtual void CancelResourceRequests()

function OnResourceRequest

Section titled “function OnResourceRequest”
virtual void OnResourceRequest(
    const cohtml::IAsyncResourceRequest * request,
    cohtml::IAsyncResourceResponse * response
) override

function OnAbortResourceRequest

Section titled “function OnAbortResourceRequest”
virtual void OnAbortResourceRequest(
    unsigned Id
) override

Called when the backend wants a load to abort. The user is STILL REQUIRED to call Finish on the resource response with the associated request.

function OnUserImageDropped

Section titled “function OnUserImageDropped”
virtual void OnUserImageDropped(
    void * UserData,
    void * TexturePtr
)

function SetActiveSystem

Section titled “function SetActiveSystem”
virtual void SetActiveSystem(
    TWeakPtr< class FCohtmlSystemWrapper, ESPMode::ThreadSafe > SystemPtr
)

function IsCurrentlyLoading

Section titled “function IsCurrentlyLoading”
virtual bool IsCurrentlyLoading()

function GetPathResolver

Section titled “function GetPathResolver”
virtual FCohtmlPathResolver * GetPathResolver()

function EnsureNoResourceRequests

Section titled “function EnsureNoResourceRequests”
virtual void EnsureNoResourceRequests()

function TryGetResourcePath

Section titled “function TryGetResourcePath”
virtual bool TryGetResourcePath(
    const cohtml::IAsyncResourceRequest * Request,
    EResourceProtocol & ResourceProtocol,
    FURLWithFallbacks & ResultPath
)

function OnUnrealResourceLoaded

Section titled “function OnUnrealResourceLoaded”
virtual void OnUnrealResourceLoaded(
    unsigned Id,
    const FUnrealResourceTaskPtr ResourceTask
)

function OnUnrealResourceLoaded

Section titled “function OnUnrealResourceLoaded”
virtual void OnUnrealResourceLoaded(
    unsigned Id,
    FCohUnrealResourcePtr & ResourcePtr,
    cohtml::IAsyncResourceResponse * Response
)

function TryConvertFilenameToTexture2DPath

Section titled “function TryConvertFilenameToTexture2DPath”
virtual bool TryConvertFilenameToTexture2DPath(
    const FString & Path,
    FString & ConvertedPath
)

function TryEnqueueUnrealResource

Section titled “function TryEnqueueUnrealResource”
virtual bool TryEnqueueUnrealResource(
    unsigned Id,
    const FString & RelativePath,
    cohtml::IAsyncResourceResponse * Response
)

function TryReceiveUserImage

Section titled “function TryReceiveUserImage”
virtual bool TryReceiveUserImage(
    FCohUnrealResourcePtr & Resource,
    cohtml::IAsyncResourceResponse * Response
)

function Tick

Section titled “function Tick”
virtual void Tick(
    float DeltaTime
) override

function IsTickable

Section titled “function IsTickable”
inline virtual bool IsTickable() const override

function IsTickableInEditor

Section titled “function IsTickableInEditor”
inline virtual bool IsTickableInEditor() const override

function IsTickableWhenPaused

Section titled “function IsTickableWhenPaused”
inline virtual bool IsTickableWhenPaused() const override

function GetStatId

Section titled “function GetStatId”
virtual TStatId GetStatId() const override

function TryLoadUAssetImmediately

Section titled “function TryLoadUAssetImmediately”
virtual UTexture * TryLoadUAssetImmediately(
    FSoftObjectPath & RequestPathAsset
)

function IsCurrentlyLoadingUnrealResources

Section titled “function IsCurrentlyLoadingUnrealResources”
bool IsCurrentlyLoadingUnrealResources()

function AbortUnrealResourceRequest

Section titled “function AbortUnrealResourceRequest”
void AbortUnrealResourceRequest(
    unsigned Id
)

function CancelUnrealResourceRequests

Section titled “function CancelUnrealResourceRequests”
void CancelUnrealResourceRequests()

function EnsureNoUnrealResourceRequests

Section titled “function EnsureNoUnrealResourceRequests”
void EnsureNoUnrealResourceRequests()

Protected Functions Documentation

Section titled “Protected Functions Documentation”

function GeneratePossibleURLs

Section titled “function GeneratePossibleURLs”
FURLWithFallbacks GeneratePossibleURLs(
    const cohtml::IAsyncResourceRequest * Request
)

Public Attributes Documentation

Section titled “Public Attributes Documentation”

variable UnrealResourceLock

Section titled “variable UnrealResourceLock”
FCriticalSection UnrealResourceLock;

variable UnrealResourceQueue

Section titled “variable UnrealResourceQueue”
TMap< unsigned, FUnrealResourceTaskPtr > UnrealResourceQueue;

variable PendingUnrealResourceLock

Section titled “variable PendingUnrealResourceLock”
FCriticalSection PendingUnrealResourceLock;

variable PendingUnrealResources

Section titled “variable PendingUnrealResources”
TMap< unsigned, FTexturePendingReceival > PendingUnrealResources;

variable AbortedPendingUnrealResources

Section titled “variable AbortedPendingUnrealResources”
TArray< FCohUnrealResourcePtr > AbortedPendingUnrealResources;

Protected Attributes Documentation

Section titled “Protected Attributes Documentation”

variable HTTPFileHandler

Section titled “variable HTTPFileHandler”
FCohtmlHTTPFileHandler HTTPFileHandler;

variable RawResourceHandler

Section titled “variable RawResourceHandler”
FCohtmlRawResourceHandler RawResourceHandler;

variable FallbackURLsOverride

Section titled “variable FallbackURLsOverride”
ICohtmlPlugin::FOnURLRequest FallbackURLsOverride;

variable System

Section titled “variable System”
TWeakPtr< class FCohtmlSystemWrapper, ESPMode::ThreadSafe > System;

variable PathResolver

Section titled “variable PathResolver”
TUniquePtr< FCohtmlPathResolver > PathResolver;

© 2026 Coherent Labs. All rights reserved.

Privacy Policy