UCameraComponent

class Engine Blueprint Since 4.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › UActorComponent › USceneComponent › UCameraComponent

#include "Camera/CameraComponent.h"

Description

A component that defines a camera view. Attach it to an actor to make that actor capable of providing a camera perspective to the player.

Caveats & Gotchas

• The camera only becomes active when the owning actor is possessed and the player's view target is set. Attaching a UCameraComponent does not automatically make it the active camera.
• FOV, aspect ratio, and projection mode are set on the component. Post-process settings can also be applied here.
• Typically paired with a USpringArmComponent to get a smooth third-person follow camera.

Example

Add a camera to a character C++

UCameraComponent* Camera = CreateDefaultSubobject<UCameraComponent>(TEXT("Camera"));
Camera->SetupAttachment(SpringArm, USpringArmComponent::SocketName);
Camera->bUsePawnControlRotation = false;

Functions (14)

Lifecycle 1 Transform 1 Rendering 2 Camera 4 PostProcess 3 View Offset 3

Lifecycle

1 ▼

Access	Type	Name	Description
public	function	UCameraComponent::OnRegister	UActorComponent override called when the camera component is registered with the world, used to set up the editor-only frustum visualization and proxy mesh.

Transform

1 ▼

Access	Type	Name	Description
public	function	UCameraComponent::OnUpdateTransform	USceneComponent override called whenever this camera's world transform changes, keeping the editor-only frustum visualization and proxy mesh synced to the new position.

Rendering

2 ▼

Access	Type	Name	Description
public	function	UCameraComponent::AddOrUpdateBlendable	Adds a blendable object (implementing IBlendableInterface) to this camera's post-process settings, or updates its weight if it's already present.
public	function	UCameraComponent::RemoveBlendable	Removes a previously added blendable object from this camera's post-process settings.

Camera

4 ▼

Access	Type	Name	Description
public	function	UCameraComponent::SetProjectionMode	Sets whether this camera renders using perspective or orthographic projection.
public	function	UCameraComponent::GetCameraView	Computes this camera's point of view for the current frame, combining its transform, field of view, and post-process settings into a FMinimalViewInfo.
public	function	UCameraComponent::SetPostProcessBlendWeight	Sets how strongly this camera's PostProcessSettings are blended into the final view, from 0.
public	function	UCameraComponent::NotifyCameraCut	Notifies the camera component that a hard camera cut occurred so dependent systems can reset interpolation instead of smoothing from the previous view.

PostProcess

3 ▼

Access	Type	Name	Description
public	function	UCameraComponent::AddExtraPostProcessBlend	Stores a post-process settings/weight pair on the camera for later retrieval, without applying it to the camera's live view.
public	function	UCameraComponent::ClearExtraPostProcessBlends	Removes all extra post-process blends previously stored on this camera with AddExtraPostProcessBlend.
public	function	UCameraComponent::GetExtraPostProcessBlends	Retrieves the extra post-process settings and blend weights previously stored on this camera via AddExtraPostProcessBlend.

View Offset

3 ▼

Access	Type	Name	Description
public	function	UCameraComponent::AddAdditiveOffset	Applies an additive positional/rotational and FOV offset to the camera's final view without moving the component itself, preserving any offset already set.
public	function	UCameraComponent::ClearAdditiveOffset	Removes any additive positional/rotational and FOV offset previously applied via AddAdditiveOffset.
public	function	UCameraComponent::GetAdditiveOffset	Retrieves the additive offset and FOV offset currently applied to this camera via AddAdditiveOffset.

Properties

Access	Type	Name	Description
public	property	UCameraComponent::PostProcessBlendWeight	Indicates how strongly this camera's PostProcessSettings should be blended into the final view when using this camera to view through.
public	property	UCameraComponent::PostProcessSettings	Post-process settings applied when this camera component is the active view.
public	property	UCameraComponent::ProjectionMode	Controls whether this camera renders using perspective (standard 3D) or orthographic projection.

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?