FComputeGraphBuilder

Programmatic builder for [UComputeGraph](API\Plugins\ComputeFramework\UComputeGraph).

API > API/Plugins > API/Plugins/ComputeFramework

Programmatic builder for UComputeGraph. Handles the direct array manipulation and name-matching that are required when directly filling the UComputeGraph properties. Expected to be used as a temporary object to do the build. Passed in UObject pointers aren't GC tracked.

   
Name FComputeGraphBuilder
Type class
Header File /Engine/Plugins/Runtime/ComputeFramework/Source/ComputeFramework/Public/ComputeFramework/ComputeGraphBuilder.h
Include Path #include "ComputeFramework/ComputeGraphBuilder.h"

Syntax

class FComputeGraphBuilder

Constructors

Name Remarks Include Path Unreal Specifiers
  ComputeFramework/ComputeGraphBuilder.h  
  ComputeFramework/ComputeGraphBuilder.h  

Structs

Name Remarks
FInterfaceEntry  
FKernelEntry  
FPinEntry  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
InterfaceEntries TArray< FInterfaceEntry >   ComputeFramework/ComputeGraphBuilder.h  
KernelEntries TArray< FKernelEntry >   ComputeFramework/ComputeGraphBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FInterfaceHandle AddDataInterface ( UComputeDataInterface* Interface,
UClass* BindingClass,
FName Name
)

 Add a data interface. BindingClass is the UObject subclass that will be bound at runtime. ComputeFramework/ComputeGraphBuilder.h  

FKernelHandle AddKernel ( UComputeKernelSource* Source,
FName Name
)

 Add a kernel. ComputeFramework/ComputeGraphBuilder.h  

void Build ( UComputeGraph& OutGraph,
UObject& Outer
) const

 Apply the built topology to OutGraph, resetting any existing topology first. ComputeFramework/ComputeGraphBuilder.h  

void ConnectInput ( FKernelHandle Kernel,
FStringView KernelFn,
FInterfaceHandle Interface,
FStringView InterfaceFn
)

 Connect a kernel HLSL input parameter to a data interface read function. ComputeFramework/ComputeGraphBuilder.h  

void ConnectOutput ( FKernelHandle Kernel,
FStringView KernelFn,
FInterfaceHandle Interface,
FStringView InterfaceFn
)

 Connect a kernel HLSL output parameter to a data interface write function. ComputeFramework/ComputeGraphBuilder.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ComputeFramework/ComputeGraphBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page