Navigation
API > API/Plugins > API/Plugins/ComputeFramework
Class representing the source for a UComputeKernel We derive from this for each authoring mechanism. (HLSL text, VPL graph, ML Meta Lang, etc.)
| Name | UComputeKernelSource |
| Type | class |
| Header File | /Engine/Plugins/Runtime/ComputeFramework/Source/ComputeFramework/Public/ComputeFramework/ComputeKernelSource.h |
| Include Path | #include "ComputeFramework/ComputeKernelSource.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UComputeKernelSource : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UComputeKernelSource
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdditionalSources | TArray< TObjectPtr< UComputeSource > > | An array of additional independent source assets that the kernel source depends on. | ComputeFramework/ComputeKernelSource.h |
|
| DefinitionsSet | FComputeKernelDefinitionSet | Base environment defines for kernel compilation. | ComputeFramework/ComputeKernelSource.h |
|
| EntryPoint | FString | Kernel entry point. | ComputeFramework/ComputeKernelSource.h |
|
| ExternalInputs | TArray< FShaderFunctionDefinition > | Named external inputs for the kernel. These must be fulfilled by linked data providers. | ComputeFramework/ComputeKernelSource.h |
|
| ExternalOutputs | TArray< FShaderFunctionDefinition > | Named external outputs for the kernel. These must be fulfilled by linked data providers. | ComputeFramework/ComputeKernelSource.h |
|
| GroupSize | FIntVector | Kernel group size. | ComputeFramework/ComputeKernelSource.h |
|
| PermutationSet | FComputeKernelPermutationSet | Base permutations exposed by the kernel. | ComputeFramework/ComputeKernelSource.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetSource() |
Get kernel source code ready for HLSL compilation. | ComputeFramework/ComputeKernelSource.h |