Navigation
API > API/Plugins > API/Plugins/Composite
Base class for a composite pass: a render-thread operation applied to a layer's input. Subclasses spawn a per-frame render proxy via GetProxy() that runs on the GPU.
| Name | UCompositePassBase |
| Type | class |
| Header File | /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassBase.h |
| Include Path | #include "Passes/CompositePassBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract, EditInlineNew)
class UCompositePassBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCompositePassBase
Derived Classes
UCompositePassBase derived class hierarchy
- UCompositeLayerBase
- UCompositePassBlur
- UCompositePassColorGrading
- UCompositePassColorKeyer
- UCompositePassDilation
- UCompositePassDistortion
- UCompositePassFXAA
- UCompositePassLumaKeyer
- UCompositePassMasking
- UCompositePassMaterial
- UCompositePassOpenColorIO
- UCompositePassSMAA
- UCompositePassTransform2D
- UCompositePassTranslucency
- UCompositePassUltimatteMasking
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCompositePassBase
(
const FObjectInitializer& ObjectInitializer |
Constructor. | Passes/CompositePassBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UCompositePassBase() |
Destructor. | Passes/CompositePassBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetDisplayName() |
Gets the display name of the pass | Passes/CompositePassBase.h | |
void SetDisplayName
(
const FString& InDisplayName |
Sets the display name of the pass | Passes/CompositePassBase.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetIsActive () |
Returns true if the pass should participate in rendering this frame. | Passes/CompositePassBase.h | |
virtual bool GetIsEnabled() |
Get the enabled state. | Passes/CompositePassBase.h |
|
virtual FCompositeCorePassProxy * GetProxy
(
const UE::CompositeCore::FPassInputDecl& InputDecl, |
Override to return a render-thread proxy for this pass. | Passes/CompositePassBase.h | |
virtual void SetIsEnabled
(
bool bInEnabled |
Set the enabled state. | Passes/CompositePassBase.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
Passes/CompositePassBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FString MakeUniqueDisplayName
(
const FString& BaseName, |
Generates a unique display name by appending a number if siblings share the same base type name. | Passes/CompositePassBase.h |