Navigation
API > API/Runtime > API/Runtime/Engine
Describes a user-specified HLSL function.
| Name | FFunctionHLSLDesc |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/Materials/MaterialIREmitter.h |
| Include Path | #include "Materials/MaterialIREmitter.h" |
Syntax
struct FFunctionHLSLDesc
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Code | FStringView | The user-specified HLSL code inside the function body. | Materials/MaterialIREmitter.h | |
| Defines | TConstArrayView< FFunctionHLSLDefine > | Array of user-specified defines to declare before this function. | Materials/MaterialIREmitter.h | |
| Includes | TConstArrayView< FStringView > | Array of user-specified #include directives to declare before this function. | Materials/MaterialIREmitter.h | |
| Name | FStringView | The function name, used for debugging purposes and referenced in the generated HLSL. | Materials/MaterialIREmitter.h | |
| NumInputOnlyParams | uint32 | The number of parameters that are input-only. | Materials/MaterialIREmitter.h | |
| NumInputOutputParams | uint32 | The number of input-output parameters after the input-only parameters. | Materials/MaterialIREmitter.h | |
| NumOutputOnlyParams | uint32 | The number of output-only parameters after the input-output parameters. | Materials/MaterialIREmitter.h | |
| Parameters | FFunctionParameter | Array of descriptions of the function parameters. | Materials/MaterialIREmitter.h | |
| ReturnType | FType | The function return type. | Materials/MaterialIREmitter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetNumParameters() |
Returns the total number of parameters. | Materials/MaterialIREmitter.h | |
| Pushes an input-only parameter and returns whether there was an available free parameter to push this one into. | Materials/MaterialIREmitter.h | ||
| Pushes an input-output parameter and returns whether there was an available free parameter to push this one into. | Materials/MaterialIREmitter.h | ||
| Pushes an output-only parameter and returns whether there was an available free parameter to push this one into. | Materials/MaterialIREmitter.h |