UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSceneViewInitOptions Struct Reference

#include <SceneView.h>

+ Inheritance diagram for FSceneViewInitOptions:

Public Member Functions

 FSceneViewInitOptions ()
 
- Public Member Functions inherited from FSceneViewProjectionData
void SetViewRectangle (const FIntRect &InViewRect)
 
void SetConstrainedViewRectangle (const FIntRect &InViewRect)
 
bool IsValidViewRectangle () const
 
bool IsPerspectiveProjection () const
 
const FIntRectGetViewRect () const
 
const FIntRectGetConstrainedViewRect () const
 
FMatrix ComputeViewProjectionMatrix () const
 
float GetNearPlaneFromProjectionMatrix () const
 
bool UpdateOrthoPlanes (float &NearPlane, float &FarPlane, float HalfOrthoWidth, bool bUseCameraHeightAsViewTarget)
 
ENGINE_API bool UpdateOrthoPlanes (FMinimalViewInfo &MinimalViewInfo)
 
ENGINE_API bool UpdateOrthoPlanes (bool bUseCameraHeightAsViewTarget)
 

Public Attributes

const FSceneViewFamilyViewFamily
 
FSceneViewStateInterfaceSceneViewStateInterface
 
FSceneViewStateInterfaceExposureSceneViewStateInterface
 
FSceneViewOwner ViewActor
 
int32 PlayerIndex
 
FViewElementDrawerViewElementDrawer
 
FLinearColor BackgroundColor
 
FLinearColor OverlayColor
 
FLinearColor ColorScale
 
EStereoscopicPass StereoPass
 
int32 StereoViewIndex
 
float WorldToMetersScale
 
FVector ViewLocation
 
FRotator ViewRotation
 
TSet< FPrimitiveComponentIdHiddenPrimitives
 
TOptional< TSet< FPrimitiveComponentId > > ShowOnlyPrimitives
 
FIntPoint CursorPos
 
float LODDistanceFactor
 
float OverrideFarClippingPlaneDistance
 
FVector OriginOffsetThisFrame
 
bool bInCameraCut
 
bool bUseFieldOfViewForLOD
 
float FOV
 
float DesiredFOV
 
FFirstPersonParameters FirstPersonParams
 
bool bIsSceneCapture
 
bool bIsSceneCaptureCube
 
bool bSceneCaptureUsesRayTracing
 
bool bIsReflectionCapture
 
bool bIsPlanarReflection
 
bool bExcludeFromSceneTextureExtents = false
 
float OverridePrimaryResolutionFraction
 
float OverscanResolutionFraction = 1.0f
 
float CropFraction = 1.0f
 
FVector4f AsymmetricCropFraction = FVector4f::One()
 
- Public Attributes inherited from FSceneViewProjectionData
FVector ViewOrigin = FVector::ZeroVector
 
FMatrix ViewRotationMatrix = FMatrix::Identity
 
FMatrix ProjectionMatrix = FMatrix::Identity
 
FIntRect ViewRect = FIntRect(0,0,0,0)
 
FVector CameraToViewTarget = FVector::ZeroVector
 

Additional Inherited Members

- Static Public Member Functions inherited from FSceneViewProjectionData
static float GetNearPlaneFromProjectionMatrix (const FMatrix &ProjectionMatrix)
 
static ENGINE_API bool UpdateOrthoPlanes (FSceneViewProjectionData *InOutProjectionData, float &NearPlane, float &FarPlane, float HalfOrthoWidth, bool bUseCameraHeightAsViewTarget)
 
- Protected Attributes inherited from FSceneViewProjectionData
FIntRect ConstrainedViewRect = FIntRect(0,0,0,0)
 

Constructor & Destructor Documentation

◆ FSceneViewInitOptions()

FSceneViewInitOptions::FSceneViewInitOptions ( )
inline

Member Data Documentation

◆ AsymmetricCropFraction

FVector4f FSceneViewInitOptions::AsymmetricCropFraction = FVector4f::One()

The fraction for each edge between 0.0 and 1.0 of the view to crop to during the final post process upscale, with 1.0 meaning no crop. By convention, X is the left edge, Y is the right edge, Z is the top edge, and W is the bottom edge. Stacks with uniform CropFraction.

◆ BackgroundColor

FLinearColor FSceneViewInitOptions::BackgroundColor

◆ bExcludeFromSceneTextureExtents

bool FSceneViewInitOptions::bExcludeFromSceneTextureExtents = false

Whether this view should be excluded from extent history tracking.

◆ bInCameraCut

bool FSceneViewInitOptions::bInCameraCut

Was there a camera cut this frame?

◆ bIsPlanarReflection

bool FSceneViewInitOptions::bIsPlanarReflection

Whether this view is being used to render a planar reflection.

◆ bIsReflectionCapture

bool FSceneViewInitOptions::bIsReflectionCapture

Whether this view is being used to render a reflection capture.

◆ bIsSceneCapture

bool FSceneViewInitOptions::bIsSceneCapture

Whether this view is being used to render a scene capture.

◆ bIsSceneCaptureCube

bool FSceneViewInitOptions::bIsSceneCaptureCube

Whether the scene capture is a cube map (bIsSceneCapture will also be set).

◆ bSceneCaptureUsesRayTracing

bool FSceneViewInitOptions::bSceneCaptureUsesRayTracing

Whether this view uses ray tracing, for views that are used to render a scene capture.

◆ bUseFieldOfViewForLOD

bool FSceneViewInitOptions::bUseFieldOfViewForLOD

Whether to use FOV when computing mesh LOD.

◆ ColorScale

FLinearColor FSceneViewInitOptions::ColorScale

◆ CropFraction

float FSceneViewInitOptions::CropFraction = 1.0f

Fraction of the view to crop to during the secondary upscale pass, with 1.0 meaning no crop

◆ CursorPos

FIntPoint FSceneViewInitOptions::CursorPos

◆ DesiredFOV

float FSceneViewInitOptions::DesiredFOV

◆ ExposureSceneViewStateInterface

FSceneViewStateInterface* FSceneViewInitOptions::ExposureSceneViewStateInterface

◆ FirstPersonParams

FFirstPersonParameters FSceneViewInitOptions::FirstPersonParams

Parameters controlling the rendering (FOV and scale) of first person primitives.

◆ FOV

float FSceneViewInitOptions::FOV

Actual field of view and that desired by the camera originally

◆ HiddenPrimitives

TSet<FPrimitiveComponentId> FSceneViewInitOptions::HiddenPrimitives

◆ LODDistanceFactor

float FSceneViewInitOptions::LODDistanceFactor

◆ OriginOffsetThisFrame

FVector FSceneViewInitOptions::OriginOffsetThisFrame

World origin offset value. Non-zero only for a single frame when origin is rebased

◆ OverlayColor

FLinearColor FSceneViewInitOptions::OverlayColor

◆ OverrideFarClippingPlaneDistance

float FSceneViewInitOptions::OverrideFarClippingPlaneDistance

If > 0, overrides the view's far clipping plane with a plane at the specified distance.

◆ OverridePrimaryResolutionFraction

float FSceneViewInitOptions::OverridePrimaryResolutionFraction

If > 0, overrides the view's resolution fraction.

◆ OverscanResolutionFraction

float FSceneViewInitOptions::OverscanResolutionFraction = 1.0f

Resolution fraction that scales with the amount of overscan in the view

◆ PlayerIndex

int32 FSceneViewInitOptions::PlayerIndex

◆ SceneViewStateInterface

FSceneViewStateInterface* FSceneViewInitOptions::SceneViewStateInterface

◆ ShowOnlyPrimitives

TOptional<TSet<FPrimitiveComponentId> > FSceneViewInitOptions::ShowOnlyPrimitives

The primitives which are visible for this view. If the array is not empty, all other primitives will be hidden.

◆ StereoPass

EStereoscopicPass FSceneViewInitOptions::StereoPass

For stereoscopic rendering, whether or not this is a full pass, or a primary / secondary pass

◆ StereoViewIndex

int32 FSceneViewInitOptions::StereoViewIndex

For stereoscopic rendering, a unique index to identify the view across view families

◆ ViewActor

FSceneViewOwner FSceneViewInitOptions::ViewActor

◆ ViewElementDrawer

FViewElementDrawer* FSceneViewInitOptions::ViewElementDrawer

◆ ViewFamily

const FSceneViewFamily* FSceneViewInitOptions::ViewFamily

◆ ViewLocation

FVector FSceneViewInitOptions::ViewLocation

The view origin and rotation without any stereo offsets applied to it

◆ ViewRotation

FRotator FSceneViewInitOptions::ViewRotation

◆ WorldToMetersScale

float FSceneViewInitOptions::WorldToMetersScale

Conversion from world units (uu) to meters, so we can scale motion to the world appropriately


The documentation for this struct was generated from the following file: