Navigation
| Name | ComputeFramework |
| Type | Runtime |
| Part of Plugins | Compute Framework |
| Location | /Engine/Plugins/Runtime/ComputeFramework/Source/ComputeFramework/ |
| Module Build Rules | ComputeFramework.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FComputeDataProviderRenderProxy | Compute Framework Data Provider Proxy. |
| UComputeDataInterface | Compute Data Interface required to compile a Compute Graph. |
| UComputeDataProvider | Compute Framework Data Provider. |
| UComputeGraph | Class representing a Compute Graph. |
| UComputeGraphComponent | Component which holds a context for a UComputeGraph. |
| UComputeGraphFromText | Simple data driven compute graph implementation. |
| UComputeKernel | Base class representing a kernel that will be run as a shader on the GPU. |
| UComputeKernelSource | Class representing the source for a UComputeKernel We derive from this for each authoring mechanism. |
| UComputeKernelSourceWithText | Simple concrete implementation of UComputeKernelSource with contained source text property. |
| UComputeSource | Class representing some source for inclusion in a UComputeKernel. |
Structs
| Name | Remarks |
|---|---|
| FArrayShaderValue | |
| FComputeFrameworkObjectVersion | |
| FComputeGraphEdge | Description of a single edge in a UComputeGraph. |
| FComputeGraphInstance | Class to store a set of data provider bindings for UComputeGraph and to enqueue work to the ComputeFramework's compute system. |
| FComputeKernelCompileMessage | Struct containing a message returned by shader compilation. |
| FComputeKernelCompileResults | Struct containing all of the messages returned by shader compilation. |
| FComputeKernelDefinition | |
| FComputeKernelDefinitionSet | |
| FComputeKernelPermutationBool | |
| FComputeKernelPermutationSet | |
| FComputeKernelPermutationVector | |
| FShaderFunctionDefinition | Describes a shader function signature. |
| FShaderParametersMetadataAllocations | When we build FShaderParametersMetadata at runtime it can require that we allocate additional data referenced but not owned by the FShaderParametersMetadata. |
| FShaderParamTypeDefinition | Fully describes the name and type of a parameter a shader exposes. |
| FShaderValueContainer | |
| FShaderValueContainerView | |
| FShaderValueType | |
| FShaderValueTypeHandle | |
| FTypeMetaData | Helper struct to convert shader value type to shader parameter metadata |
Interfaces
| Name | Remarks |
|---|---|
| IComputeFrameworkModule |
Enums
Public
| Name | Remarks |
|---|---|
| EComputeKernelFlags | Flags that convey kernel behavior to aid compilation/optimizations. |
| EShaderFundamentalDimensionType | Shader types can then be in the form of a scalar, vector, matrix. |
| EShaderFundamentalType | The base types of data that shaders can consume/expose |
| EShaderParamBindingType | Describes how the shader parameters are bound. |
| EShaderParamModifier | |
| EShaderResourceType |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ComputeFramework::AddParamForType
(
FShaderParametersMetadataBuilder& InOutBuilder, |
ComputeFramework/ComputeMetadataBuilder.h | ||
ENUM_CLASS_FLAGS
(
EComputeKernelFlags |
ComputeFramework/ComputeKernel.h | ||
uint32 GetTypeHash
(
const FShaderValueType& InShaderValueType |
A hashing function to allow the FShaderValueType class to be used with hashing containers (e.g. TSet or TMap). | ComputeFramework/ShaderParamTypeDefinition.h |