1. Epic GamesDeveloper
  3. UCameraComponent

UCameraComponent

Represents a camera viewpoint and settings, such as projection type, field of view, and post-process overrides.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Camera

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Camera/CameraComponent.h
Include #include "Camera/CameraComponent.h"

Syntax

UCLASS (HideCategories=(Mobility, Rendering, LOD), Blueprintable, ClassGroup=Camera,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UCameraComponent : public USceneComponent

Remarks

Represents a camera viewpoint and settings, such as projection type, field of view, and post-process overrides. The default behavior for an actor used as the camera view target is to look for an attached camera component and use its location, rotation, and settings.

Variables

  Type Name Description
Protected variable float AdditiveFOVOffset An optional extra FOV offset to adjust the final view without modifying the component
Protected variable FTransform AdditiveOffset An optional extra transform to adjust the final view without moving the component, in the camera's local space
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float AspectRatio Aspect Ratio (Width/Height)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite TEnumAsByte< EAspectRatioAxisConstraint > AspectRatioAxisConstraint Override for the default aspect ratio axis constraint defined on the local player
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float AutoPlaneShift Manually adjusts the planes of this camera, maintaining the distance between them.
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite bool bAutoCalculateOrthoPlanes Automatically determine a min/max Near/Far clip plane position depending on OrthoWidth value
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bCameraMeshHiddenInGame If the camera mesh is visible in game. Only relevant when running editor builds.
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite uint8: 1 bConstrainAspectRatio If bConstrainAspectRatio is true, black bars will be added if the destination view has a different aspect ratio than this camera requested.
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite bool bCropOverscan Indicates that the overscanned pixels should be cropped at the end of the rendering pipeline, allowing the overscanned pixels to be used in post process effects that need extra pixels beyond the view frustum (e.g. lens distortion) without having to render those pixels to the screen.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bDrawFrustumAllowed The Frustum visibility flag for draw frustum component initialization.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bEnableFirstPersonFieldOfView True if the first person field of view should be used for primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bEnableFirstPersonScale True if the first person scale should be used for primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bLockToHmd True if the camera's orientation and position should be locked to the HMD
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite uint8: 1 bOverrideAspectRatioAxisConstraint Whether to override the default aspect ratio axis constraint defined on the local player
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite bool bScaleResolutionWithOverscan Indicates that the resolution should be scaled by the overscan amount so that the original view frustum remains the same resolution.
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite bool bUpdateOrthoPlanes Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefacting
Protected variable uint8: 1 bUseAdditiveOffset True to enable the additive view offset, for adjusting the view without moving the component.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite bool bUseCameraHeightAsViewTarget If UpdateOrthoPlanes is enabled, this setting will use the cameras current height to compensate the distance to the general view (as a pseudo distance to view target when one isn't present)
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Interp BlueprintReadWrite uint8: 1 bUseFieldOfViewForLOD If true, account for the field of view angle when computing which level of detail to use for meshes.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bUsePawnControlRotation If this camera component is placed on a pawn, should it use the view/control rotation of the pawn where possible?
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< class UStaticMesh > CameraMesh  
Protected variable TObjectPtr< class UDrawFrustumComponent > DrawFrustum The frustum component used to show visually where the camera field of view is.
Protected variable TArray< FPostProcessSettings > ExtraPostProcessBlends Optional extra PostProcessing blends stored for this camera.
Protected variable TArray< float > ExtraPostProcessBlendWeights  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float FieldOfView The horizontal field of view (in degrees) in perspective mode (ignored in Orthographic mode)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float FirstPersonFieldOfView The horizontal field of view (in degrees) used for primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float FirstPersonScale The scale to apply to primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float OrthoFarClipPlane The far plane distance of the orthographic view (in world units)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float OrthoNearClipPlane The near plane distance of the orthographic view (in world units)
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite float OrthoWidth The desired width (in world units) of the orthographic view (ignored in Perspective mode)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Overscan Amount to increase the view frustum by, from 0.0 for no increase to 1.0 for 100% increase
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float PostProcessBlendWeight Indicates if PostProcessSettings should be used when using this Camera to view through.
Public variable UProperty Category, Interp, Meta BlueprintReadWrite FPostProcessSettings PostProcessSettings Post process settings to use for this camera.
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite TEnumAsByte< ECameraProjectionMode::Type > ProjectionMode The type of camera.
Protected variable TObjectPtr< class UStaticMeshComponent > ProxyMeshComponent The camera mesh to show visually where the camera is placed.

Constructors

  Type Name Description
Public function  

UCameraComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddAdditiveOffset ( FTransform const& Transform,
float FOV
)

 Applies the given additive offset, preserving any existing offset
Public function void

AddExtraPostProcessBlend ( FPostProcessSettings const& PPSettings,
float PPBlendWeight
)

 Stores a given PP and weight to be later applied when the final PP is computed.
Public function UFunction BlueprintCallable, Category void

AddOrUpdateBlendable ( TScriptInterface< IBlendableInterface > InBlendableObject,
float InWeight
)

 Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight
Public function Static void  
Public function void Removes any additive offset.
Public function void Removes any extra PP blends.
Public function Const void

GetAdditiveOffset ( FTransform& OutAdditiveOffset,
float& OutAdditiveFOVOffset
)

 Get the additive offset
Public function Virtual UFunction BlueprintCallable, Category void

GetCameraView ( float DeltaTime,
FMinimalViewInfo& DesiredView
)

 Returns camera's Point of View.
Public function Const void

GetExtraPostProcessBlends ( TArray< FPostProcessSettings >& OutSettings,
TArray< float >& OutWeights
)

 Returns any extra PP blends that were stored.
Public function Virtual Const UFunction FText Returns the filmback text used for burnins on preview viewports.
Protected function Virtual void

HandleXRCamera ( float DeltaTime
)

  
Protected function Const bool  
Public function Virtual void Can be called from external code to notify that this camera was cut to, so it can update things like interpolation if necessary.
Protected function UFunction blueprintsetter void Internal function for updating the camera mesh visibility in PIE
Public function void

OverrideFrustumColor ( FColor OverrideColor
)

  
Public function Virtual void Refreshes the visual components to match the component state.
Public function UFunction BlueprintCallable, Category void Removes a blendable.
Protected function Virtual void  
Public function void  
Public function UFunction BlueprintCallable, Category void

SetAspectRatio ( float InAspectRatio
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetAutoCalculateOrthoPlanes ( bool bAutoCalculate
)

  
Public function UFunction BlueprintCallable, Category void

SetAutoPlaneShift ( float InAutoPlaneShift
)

  
Public function Virtual void  
Public function UFunction BlueprintCallable, Category void

SetConstraintAspectRatio ( bool bInConstrainAspectRatio
)

  
Public function UFunction BlueprintCallable, Category void

SetCropOverscan ( bool bInCropOverscan
)

 Sets whether to crop the overscanned pixels at the end of the rendering pipeline, allowing the overscanned pixels to be used in post process effects that need extra pixels beyond the view frustum (e.g. lens distortion) without having to render those pixels to the screen.
Public function UFunction BlueprintCallable, Category void

SetEnableFirstPersonFieldOfView ( bool bInEnableFirstPersonFieldOfView
)

  
Public function UFunction BlueprintCallable, Category void

SetEnableFirstPersonScale ( bool bInEnableFirstPersonScale
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetFieldOfView ( float InFieldOfView
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetFirstPersonFieldOfView ( float InFirstPersonFieldOfView
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetFirstPersonScale ( float InFirstPersonScale
)

  
Public function UFunction BlueprintCallable, Category void

SetOrthoFarClipPlane ( float InOrthoFarClipPlane
)

  
Public function UFunction BlueprintCallable, Category void

SetOrthoNearClipPlane ( float InOrthoNearClipPlane
)

  
Public function UFunction BlueprintCallable, Category void

SetOrthoWidth ( float InOrthoWidth
)

  
Public function UFunction BlueprintCallable, Category void

SetOverscan ( float InOverscan
)

  
Public function UFunction BlueprintCallable, Category void

SetPostProcessBlendWeight ( float InPostProcessBlendWeight
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetScaleResolutionWithOverscan ( bool bInScaleResolutionWithOverscan
)

 Sets whether to scale the resolution by the amount of overscan so that the original view frustum remains the same resolution.
Public function UFunction BlueprintCallable, Category void

SetUpdateOrthoPlanes ( bool bInUpdateOrthoPlanes
)

  
Public function UFunction BlueprintCallable, Category void

SetUseCameraHeightAsViewTarget ( bool bInUseCameraHeightAsViewTarget
)

  
Public function UFunction BlueprintCallable, Category void

SetUseFieldOfViewForLOD ( bool bInUseFieldOfViewForLOD
)

  
Protected function void Update draw frustum values
Protected function void Ensure the proxy mesh is in the correct place

Overridden from USceneComponent

  Type Name Description
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

 Native callback when this component is moved

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Public function Virtual bool

GetEditorPreviewInfo ( float DeltaTime,
FMinimalViewInfo& ViewOut
)

 Supplies the editor with a view specific to this component (think a view from a camera components POV, a render, etc.).
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void

TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty uint32: 1 bUseControllerViewRotation_DEPRECATED DEPRECATED: use bUsePawnControlRotation instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page