Navigation
API > API/Plugins > API/Plugins/Composite
Base class for defining a pass object, and its associated render proxy.
| 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
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 | |
virtual bool GetProxy
(
const UE::CompositeCore::FPassInputDecl& InputDecl, |
Getter function to override, returning pass proxies to be passed to the render thread. | Passes/CompositePassBase.h | |
virtual bool IsActive() |
Returns true if the pass is returns a valid proxy. | Passes/CompositePassBase.h | |
virtual bool IsEnabled() |
Get the enabled state. | Passes/CompositePassBase.h |
|
virtual bool NeedsSceneTextures() |
Returns true if the pass (may) need post-processing scene textures. | Passes/CompositePassBase.h | |
void SetDisplayName
(
const FString& InDisplayName |
Sets the display name of the pass | Passes/CompositePassBase.h | |
virtual void SetEnabled
(
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 |