Navigation
API > API/Plugins > API/Plugins/CineCameraSceneCapture
Cine Capture Component extends Scene Capture to allow users to render Cine Camera Component into a render target. Cine Capture has a few modifiable properties, but most of the properties are controlled by Cine Camera Component. Cine Capture Component is required to be parented to Cine Camera Component or a class that extends it.
| Name | UCineCaptureComponent2D |
| Type | class |
| Header File | /Engine/Plugins/Experimental/CineCameraSceneCapture/Source/CineCameraSceneCapture/Public/CineCameraSceneCaptureComponent.h |
| Include Path | #include "CineCameraSceneCaptureComponent.h" |
Syntax
UCLASS (
HideCategories=(Transform, Collision, Object, Physics, SceneComponent, PostProcessVolume, Projection, Rendering, PlanarReflection),
ClassGroup=Rendering, EditInlineNew, Meta=(BlueprintSpawnableComponent))
class UCineCaptureComponent2D : public USceneCaptureComponent2D
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → USceneCaptureComponent → USceneCaptureComponent2D → UCineCaptureComponent2D
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCineCaptureComponent2D
(
const FObjectInitializer& ObjectInitializer |
CineCameraSceneCaptureComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFollowSceneCaptureRenderPath | bool | Affects rendering path cine capture takes. | CineCameraSceneCaptureComponent.h |
|
| bOverrideUserFlags | bool | Override state for per-view user flags accessible in materials via TestPostVolumeUserFlag node. | CineCameraSceneCaptureComponent.h |
|
| CineCameraComponent | TSoftObjectPtr< UCineCameraComponent > | Used to gather relevant properties for View rendering. | CineCameraSceneCaptureComponent.h | |
| OCIOConfiguration | FOpenColorIODisplayConfiguration | Open Color IO Configuration. Used to apply color transforms. | CineCameraSceneCaptureComponent.h |
|
| RenderTargetHighestDimension | int32 | Highest possible dimension of specified render target in either X or Y (depends on cine camera aspect ratio). | CineCameraSceneCaptureComponent.h |
|
| UserFlags | int32 | Per-view user flags accessible in materials via TestPostVolumeUserFlag node, allowing per-view overrides of material behavior. | CineCameraSceneCaptureComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CineCaptureSVE | TSharedPtr< FCineCameraCaptureSceneViewExtension, ESPMode::ThreadSafe > | This scene view extension is used to get ahold of views during the setup process. | CineCameraSceneCaptureComponent.h |
Functions
Public
Overridden from USceneCaptureComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateSceneCaptureContents
(
FSceneInterface* Scene, |
CineCameraSceneCaptureComponent.h |
Overridden from USceneComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnAttachmentChanged() |
Used for validation of this componet's attachment to Cine Camera Component. | CineCameraSceneCaptureComponent.h |
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRegister() |
CineCameraSceneCaptureComponent.h | ||
virtual void OnUnregister() |
CineCameraSceneCaptureComponent.h | ||
virtual void TickComponent
(
float DeltaTime, |
CineCameraSceneCaptureComponent.h |