Navigation
| Name | CompositeCore |
| Type | Plugin |
| Part of Plugins | CompositeCore |
| Location | /Engine/Plugins/Compositing/CompositeCore/Source/CompositeCore/ |
| Module Build Rules | CompositeCore.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FCompositeCoreModule | |
| FCompositeCorePassProxy | Render-thread pass proxy. |
| FFXAAPassProxy | |
| FMergePassProxy | |
| UCompositeCorePluginSettings | Settings for the CompositeCore module. |
| UCompositeCoreSubsystem | Composite subsytem used as an interface to the (private) scene view extension. |
| UHoldoutCompositeComponent |
Structs
| Name | Remarks |
|---|---|
| FActiveViewportFilter | Per-frame filter restricting compositing to a single viewport. |
| FBuiltInRenderPassOptions | Options to control the built-in custom render pass. |
| FExternalTexture | External texture resource and its accompanying metadata. |
| FPassContext | Per-dispatch pass parameter information. |
| FPassExternalResourceDesc | Pass texture description for external render targets. |
| FPassInputArray | Resolved pass inputs handed to FCompositeCorePassProxy::Add at render time. |
| FPassInternalResourceDesc | Pass texture description for internal resources (default scene textures). |
| FPassTexture | Resolved texture resource with an active (screen) texture and its accompanying metadata. |
| FPassTypeDescriptor | Static metadata describing the shape of a pass type. |
| FRenderWork | Render-thread struct for scene view extension render work per frame. |
| FResourceMetadata | Texture resource metadata. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FHoldoutCompositeComponentDelegate | TMulticastDelegate_OneParam< void, const UHoldoutCompositeComponent * > | HoldoutCompositeComponent.h | |
| FPassInput | FPassTexture | Pass texture input definition. | Passes/CompositeCorePassProxy.h |
| FPassInputDecl | TVariant< FPassInternalResourceDesc, FPassExternalResourceDesc, const FCompositeCorePassProxy * > | Pass input declaration, referring to internal textures, external textures or the output of another pass proxy. | Passes/CompositeCorePassProxy.h |
| FPassInputDeclArray | TArray< FPassInputDecl > | Array of pass input declarations. | Passes/CompositeCorePassProxy.h |
Enums
Public
| Name | Remarks |
|---|---|
| ECompositeCoreHoldoutManagement | Holdout property management on registered primitives. |
| ECompositeCoreMergeOp | Merge/blend operations, assuming inputs are alpha pre-multiplied. |
| UE::CompositeCore::EEncoding | Texture encoding type, used for scene color. (HDR is not currently supported.) |
| UE::CompositeCore::ELensDistortionHandling | Describe whether lens distortion is handled in the merge shader pass. |
| UE::CompositeCore::ResourceId | Strongly-typed identifier for passes, textures, or built-in renderer sources/targets. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| STATCAT_Advanced | CompositeCoreModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ResourceId UE::CompositeCore::MakeExternalResourceId
(
int32 ExternalIndex |
Builds a ResourceId that identifies the external texture at the given array index in FRenderWork::ExternalInputs. | Passes/CompositeCorePassProxy.h | |
uint32 UE::CompositeCore::ToIndex
(
ResourceId Id |
Returns the underlying integer value for a ResourceId; use for logging only. | Passes/CompositeCorePassProxy.h | |
TOptional< int32 > UE::CompositeCore::TryGetExternalIndex
(
ResourceId Id |
If Id refers to an external texture (i.e., Id >= ExternalRangeStart), returns the corresponding array index into FRenderWork::ExternalInputs. | Passes/CompositeCorePassProxy.h |