ComputeFramework

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public class

FComputeDataProviderRenderProxy

Compute Framework Data Provider Proxy.

Public struct UStruct

FComputeGraphEdge

Description of a single edge in a UComputeGraph.

Public struct UStruct

FComputeGraphInstance

Class to store a set of data provider bindings for UComputeGraph and to enqueue work to the ComputeFramework's compute system.

Public struct UStruct

FComputeKernelDefinitions

Public struct UStruct

FComputeKernelDefinitionsSet

Public struct UStruct

FComputeKernelPermutationBool

#TODO_ZABIR: refactor to a compact bitset once we do the UI work to present it reasonably.

Public struct UStruct

FComputeKernelPermutationSet

Public struct UStruct

FShaderFunctionDefinition

Describes a shader function signature.

Public struct UStruct

FShaderParamTypeDefinition

Fully describes the name and type of a parameter a shader exposes.

Public struct UStruct

FShaderValueType

Public struct UStruct

FShaderValueTypeHandle

Public class

IComputeFrameworkModule

Public class UClass Abstract const

UComputeDataInterface

Compute Data Interface required to compile a Compute Graph.

Public class UClass Abstract

UComputeDataProvider

Compute Framework Data Provider.

Public class UClass

UComputeGraph

Class representing a Compute Graph.

Public class UClass Blueprintable Meta

UComputeGraphComponent

Component which holds a context for a UComputeGraph.

Public class UClass HideCategories

UComputeKernel

Base class representing a kernel that will be run as a shader on the GPU.

Public class UClass BlueprintType

UComputeKernelFromText

Class responsible for loading HLSL text and parsing the options available.

Public class UClass Abstract editinlinenew

UComputeKernelSource

Class representing the source for a UComputeKernel We derive from this for each authoring mechanism.

Enums

Name

Description

Public enum

EComputeKernelCompilationFlags

Compute Kernel compilation flags.

Public enum UEnum meta

EComputeKernelFlags

Flags that convey kernel behavior to aid compilation/optimizations.

Public enum UEnum

EComputeKernelPermutationType

Public enum UEnum

EShaderFundamentalDimensionType

Shader types can then be in the form of a scalar, vector, matrix.

Public enum UEnum

EShaderFundamentalType

The base types of data that shaders can consume/expose

Public enum UEnum

EShaderParamBindingType

Describes how the shader parameters are bound.

Public enum UEnum

EShaderResourceType

Functions

Name Description

Public function

uint32

 

GetTypeHash

(
    const FShaderValueType& InShaderVa...
)

A hashing function to allow the FShaderValueType class to be used with hashing containers (e.g. TSet or TMap).

Public function

constexpr bo...

 

operator!

(
    EComputeKernelFlags E
)

Public function

constexpr EC...

 

operator&

(
    EComputeKernelFlags Lhs,
    EComputeKernelFlags Rhs
)

Public function

EComputeKern...

 

operator&=

(
    EComputeKernelFlags& Lhs,
    EComputeKernelFlags Rhs
)

Public function

constexpr EC...

 

operator^

(
    EComputeKernelFlags Lhs,
    EComputeKernelFlags Rhs
)

Public function

EComputeKern...

 

operator^=

(
    EComputeKernelFlags& Lhs,
    EComputeKernelFlags Rhs
)

Public function

constexpr EC...

 

operator|

(
    EComputeKernelFlags Lhs,
    EComputeKernelFlags Rhs
)

Public function

EComputeKern...

 

operator|=

(
    EComputeKernelFlags& Lhs,
    EComputeKernelFlags Rhs
)

Public function

constexpr EC...

 

operator~

(
    EComputeKernelFlags E
)