Navigation
API > API/Plugins > API/Plugins/ComputeFramework
Compute Framework Data Provider Proxy. A concrete instance of this is created by the UComputeDataProvider gathering of data for a Compute Kernel on the render thread.
| Name | FComputeDataProviderRenderProxy |
| Type | class |
| Header File | /Engine/Plugins/Runtime/ComputeFramework/Source/ComputeFramework/Public/ComputeFramework/ComputeDataProvider.h |
| Include Path | #include "ComputeFramework/ComputeDataProvider.h" |
Syntax
class FComputeDataProviderRenderProxy
Derived Classes
- FDIFleshDeformerProviderProxy
- FMLDeformerGraphDebugDataProviderProxy
- FVertexDeltaGraphDataProviderProxy
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FComputeDataProviderRenderProxy() |
ComputeFramework/ComputeDataProvider.h |
Structs
| Name | Remarks |
|---|---|
| FAllocationData | Setup needed to allocate resources. |
| FCollectedDispatchData | |
| FDispatchData | Setup needed to gather dispatch data. |
| FDispatchSetup | |
| FPermutationData | Data needed for setting permuations. |
| FReadbackData | |
| FValidationData | Data needed for validation. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FReadbackCallback | TFunction< void(const void *InData, int InNumBytes)> | ComputeFramework/ComputeDataProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AllocateResources
(
FRDGBuilder& GraphBuilder |
Todo: Fix up derived classes to implement new AllocateResources(). | ComputeFramework/ComputeDataProvider.h | |
virtual void AllocateResources
(
FRDGBuilder& GraphBuilder, |
Called once before any calls to GatherDispatchData() to allow any RDG resource allocation. | ComputeFramework/ComputeDataProvider.h | |
virtual void GatherDispatchData
(
FDispatchData const& InDispatchData |
Collect parameter data required to dispatch work. | ComputeFramework/ComputeDataProvider.h | |
virtual void GatherPermutations
(
FPermutationData& InOutPermutationData |
Gathers permutation bits for each invocation. | ComputeFramework/ComputeDataProvider.h | |
virtual int32 GetDispatchThreadCount
(
TArray< FIntVector >& ThreadCounts |
Called on render thread to determine invocation count and dispatch thread counts per invocation. | ComputeFramework/ComputeDataProvider.h | |
virtual void GetReadbackData
(
TArray< FReadbackData >& OutReadbackData |
Data for any readbacks that should be performed. | ComputeFramework/ComputeDataProvider.h | |
virtual bool IsValid
(
FValidationData const& InValidationData |
Validates that we are OK to dispatch work. Default implementation returns false. | ComputeFramework/ComputeDataProvider.h | |
virtual void PostGraphDispatch
(
FRDGBuilder& GraphBuilder |
ComputeFramework/ComputeDataProvider.h | ||
virtual void PostSubmit
(
FRDGBuilder& InGraphBuilder |
Called immediately after every kernel dispatch that outputs to this data. | ComputeFramework/ComputeDataProvider.h | |
virtual void PreSubmit
(
FRDGBuilder& InGraphBuilder |
Called immediately prior to every kernel dispatch that outputs to this data. | ComputeFramework/ComputeDataProvider.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GatherDispatchData
(
FDispatchSetup const& InDispatchSetup, |
ComputeFramework/ComputeDataProvider.h | ||
TStridedView< ElementType > MakeStridedParameterView
(
FDispatchData const& InDispatchData |
Helper for making an FStridedView over the FDispatchData. | ComputeFramework/ComputeDataProvider.h |