1. Epic GamesDeveloper
  3. FSceneView

FSceneView

A projection from scene space into a 2D screen region.

Unreal Engine C++ API Reference > Runtime > Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/SceneView.h
Include #include "SceneView.h"

Syntax

class FSceneView

Remarks

A projection from scene space into a 2D screen region.

Variables

  Type Name Description
Public variable TStaticArray< FLinearColor, 6 > AdditionalSelectionOutlineColors Additional selection colors for the editor (used by post processing)
Public variable EAntiAliasingMethod AntiAliasingMethod The antialiasing method.
Public variable FTextureRHIRef AtmosphereInscatterTexture  
Public variable FTextureRHIRef AtmosphereIrradianceTexture  
Public variable FTextureRHIRef AtmosphereTransmittanceTexture Parameters for atmospheric fog.
Public variable FLinearColor BackgroundColor  
Public variable bool bAllowCrossGPUTransfer Allow cross GPU transfer for this view
Public variable bool bAllowTemporalJitter  
Public variable bool bAllowTranslucentPrimitivesInHitProxy True if we should draw translucent objects when rendering hit proxies
Public variable FVector BaseHmdLocation  
Public variable FQuat BaseHmdOrientation  
Public variable bool bCameraCut Whether we did a camera cut for this view this frame.
Public variable TOptional< bool > bCameraMotionBlur Whether to enable motion blur caused by camera movements
Public variable bool bDisableDistanceBasedFadeTransitions Whether we should disable distance-based fade transitions for this frame (usually after a large camera movement.)
Public variable bool bForceCameraVisibilityReset True if we need to force the camera to discard previous frames occlusion.
Public variable bool bForcePathTracerReset True if we should force the path tracer to reset its internal accumulation state
Public variable bool bHasNearClippingPlane  
Public variable bool bHasSelectedComponents True if any components are selected in isolation (independent of actor selection)
Public variable bool bHMDHiddenAreaMaskActive Whether this view should use an HMD hidden area mask where appropriate.
Public variable bool bIsGameView True if this scene was created from a game world.
Public variable bool bIsInstancedStereoEnabled True if instanced stereo is enabled.
Public variable bool bIsLocked Whether this view was created from a locked viewpoint.
Public variable bool bIsMobileMultiViewEnabled True if mobile multi-view is enabled.
Public variable bool bIsMultiViewportEnabled True if multi-viewport instanced stereo rendering is enabled.
Public variable bool bIsOfflineRender Whether this view is being used to render a high quality offline render
Public variable bool bIsPlanarReflection Whether this view is being used to render a planar reflection.
Public variable bool bIsReflectionCapture Whether this view is being used to render a reflection capture.
Public variable bool bIsSceneCapture Whether this view is being used to render a scene capture.
Public variable bool bIsSceneCaptureCube Whether the scene capture is a cube map (bIsSceneCapture will also be set).
Public variable bool bIsViewInfo For sanity checking casts that are assumed to be safe.
Public variable bool bIsVirtualTexture Whether this view is being used to render a runtime virtual texture.
Public variable bool bOverrideGPUMask Use custom GPUmask
Public variable bool bRenderFirstInstanceOnly Whether this view should render the first instance only of any meshes using instancing.
Public variable bool bRenderSceneTwoSided Whether to force two sided rendering for this view.
Public variable bool bReverseCulling True if ViewMatrix.Determinant() is negative.
Public variable bool bSceneCaptureUsesRayTracing Whether this view uses ray tracing, for views that are used to render a scene capture.
Public variable bool bShouldBindInstancedViewUB True if we need to bind the instanced view uniform buffer parameters.
Public variable bool bStaticSceneOnly Whether to only render static lights and objects.
Public variable bool bUseFieldOfViewForLOD Whether to use FOV when computing mesh LOD.
Public variable bool bUsePixelInspector Whether to use the pixel inspector
Public variable FIntRect CameraConstrainedViewRect Aspect ratio constrained view rect.
Public variable TOptional< FMatrix > ClipToPrevClipOverride Matrix overrides PrevViewToClip in the view uniform buffer.
Public variable FLinearColor ColorScale Color scale multiplier used during post processing
Public variable FConvexVolume CullingFrustum Monoscopic culling frustum, same as ViewFrustum in case of non-stereo
Public variable FVector CullingOrigin Monoscopic culling origin, same as the view matrix origin in case of non-stereo
Public variable FName CurrentBufferVisualizationMode Current buffer visualization mode
Public variable FName CurrentGPUSkinCacheVisualizationMode Current GPU Skin Cache visualization mode
Public variable FName CurrentGroomVisualizationMode Current Groom visualization mode
Public variable FName CurrentLumenVisualizationMode Current Lumen visualization mode
Public variable FName CurrentNaniteVisualizationMode Current Nanite visualization mode
Public variable FName CurrentStrataVisualizationMode Current Substrate visualization mode
Public variable FName CurrentVirtualShadowMapVisualizationMode Current Virtual Shadow Map visualization mode
Public variable FName CurrentVisualizeCalibrationColorMaterialName Current visualize calibration color material name
Public variable FName CurrentVisualizeCalibrationCustomMaterialName Current visualize calibration custom material name
Public variable FName CurrentVisualizeCalibrationGrayscaleMaterialName Current visualize calibration grayscale material name
Public variable FIntPoint CursorPos -1,-1 if not setup
Public variable float DesiredFOV  
Public variable FVector4f DiffuseOverrideParameter These can be used to override material parameters across the scene without recompiling shaders.
Public variable EDrawDynamicFlags::Type DrawDynamicFlags  
Public variable FViewElementDrawer * Drawer An interaction which draws the view's interaction elements.
Public variable uint64 EditorViewBitflag The set of (the first 64) groups' visibility info for this view
Protected variable FSceneViewStateInterface * EyeAdaptationViewState  
Public variable const FSceneViewFamily * Family  
Public variable const ERHIFeatureLevel::Type FeatureLevel Feature level for this scene
Public variable TArray< FPostProcessSettingsDebugInfo > FinalPostProcessDebugInfo  
Public variable FFinalPostProcessSettings FinalPostProcessSettings The final settings for the current viewer position (blended together from many volumes).
Public variable float FOV Actual field of view and that desired by the camera originally
Public variable FPlane GlobalClippingPlane Global clipping plane being applied to the scene, or all 0's if disabled.
Public variable FRHIGPUMask GPUMask The GPU nodes on which to render this view.
Public variable TSet< FPrimitiveComponentId > HiddenPrimitives The primitives which are hidden for this view.
Protected variable TUniformBufferRef< FInstancedViewUniformShaderParameters > InstancedViewUniformBuffer Instanced view uniform buffer held on the primary view.
Public variable FVector4f InvDeviceZToWorldZTransform Vector used by shaders to convert depth buffer samples into z coordinates in world space
Public variable FShaderResourceViewRHIRef LandscapeIndirectionBuffer Landscape rendering related data
Public variable FShaderResourceViewRHIRef LandscapePerComponentDataBuffer  
Public variable FVector4f LensPrincipalPointOffsetScale In some cases, the principal point of the lens is not at the center of the screen, especially for overlapped tile rendering.
Public variable float LODDistanceFactor Multiplier for cull distance on objects
Public variable float MaterialTextureMipBias Mip bias to apply in material's samplers.
Public variable int32 MaxShadowCascades Maximum number of shadow cascades to render with.
Public variable float NearClippingDistance  
Public variable FPlane NearClippingPlane  
Public variable FVector4f NormalOverrideParameter  
Public variable FVector OriginOffsetThisFrame World origin offset value. Non-zero only for a single frame when origin is rebased
Public variable FLinearColor OverlayColor  
Public variable TOptional< uint32 > OverrideFrameIndexValue The frame index to override, useful for keeping determinism when rendering sequences.
Public variable FVector OverrideLODViewOrigin For ortho views, this can control how to determine LOD parenting (ortho has no "distance-to-camera")
Public variable int32 PlayerIndex Player index this view is associated with or INDEX_NONE.
Public variable TOptional< FTransform > PreviousViewTransform  
Public variable EPrimaryScreenPercentageMethod PrimaryScreenPercentageMethod Primary screen percentage method to use.
Public variable int32 PrimaryViewIndex For stereoscopic rendering, view family index of the primary view associated with this view
Public variable FMatrix ProjectionMatrixUnadjustedForRHI  
Public variable FVector2D RoughnessOverrideParameter  
Public variable FSceneViewInitOptions SceneViewInitOptions  
Public variable FLinearColor SelectionOutlineColor Selection color for the editor (used by post processing)
Public variable FViewMatrices ShadowViewMatrices Normally the same as ViewMatrices unless "r.Shadow.FreezeCamera" is activated
Public variable TOptional< TSet< FPrimitiveComponentId > > ShowOnlyPrimitives The primitives which are visible for this view.
Public variable FVector4f SpecularOverrideParameter  
Public variable TBitArray SpriteCategoryVisibility BitArray representing the visibility state of the various sprite categories in the editor for this view
Public variable FSceneViewStateInterface * State Can be 0 (thumbnail rendering)
Public variable EStereoscopicPass StereoPass For stereoscopic rendering, whether or not this is a full pass, or a left / right eye pass
Public variable int32 StereoViewIndex For stereoscopic rendering, unique index identifying the view across view families
Public variable FLinearColor SubduedSelectionOutlineColor Selection color for use in the editor with inactive primitives
Public variable FVector TranslucentSortAxis Sort axis for when TranslucentSortPolicy is SortAlongAxis
Public variable TEnumAsByte< ETranslucentSortPolicy::Type > TranslucentSortPolicy Translucent sort mode
Public variable FIntRect UnconstrainedViewRect Raw view size (in pixels), used for screen space calculations
Public variable float UnderwaterDepth How far below the water surface this view is. -1 means the view is out of water.
Public variable const FIntRect UnscaledViewRect Final position of the view in the final render target (in pixels), potentially constrained by an aspect ratio requirement (black bars)
Public variable const AActor * ViewActor The actor which is being viewed from.
Public variable FConvexVolume ViewFrustum  
Public variable FVector ViewLocation Variables used to determine the view matrix
Public variable FViewMatrices ViewMatrices  
Public variable FRotator ViewRotation  
Public variable TUniformBufferRef< FViewUniformShaderParameters > ViewUniformBuffer The uniform buffer for the view's parameters.
Public variable FShaderResourceViewRHIRef WaterDataBuffer  
Public variable FShaderResourceViewRHIRef WaterIndirectionBuffer Water rendering related data
Public variable float WorldToMetersScale  

Constructors

  Type Name Description
Public function  

FSceneView ( const FSceneViewInitOptions& InitOptions
)

 Initialization constructor.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS

FSceneView ( const FSceneView& Other
)

 These are only needed because of deprecated members being accessed in them
Public function  

FSceneView ( FSceneView&& Other
)

  

Destructors

  Type Name Description
Public function Virtual   Default destructor

Functions

  Type Name Description
Public function Const bool  
Public function void Configure post process settings for the buffer visualization system
Public function void Configure post process settings for calibration material
Public function Const FVector4

CursorToScreen ( float X,
float Y,
float Z
)

 Transforms a cursor location in render target pixel coordinates into the view's screen-space, taking into account the viewport rectangle.
Public function Const FVector

Deproject ( const FPlane& ScreenPoint
)

 Transforms a point from the view's screen-space into world coordinates multiplies X, Y, Z by W before transforming.
Public function Const void

DeprojectFVector2D ( const FVector2D& ScreenPos,
FVector& out_WorldOrigin,
FVector& out_WorldDirection
)

 Transforms 2D screen coordinates into a 3D world-space origin and direction
Public function Static void

DeprojectScreenToWorld ( const FVector2D& ScreenPos,
const FIntRect& ViewRect,
const FMatrix& InvViewMatrix,
const FMatrix& InvProjMatrix,
FVector& out_WorldOrigin,
FVector& out_WorldDirection
)

 Transforms 2D screen coordinates into a 3D world-space origin and direction
Public function Static void

DeprojectScreenToWorld ( const FVector2D& ScreenPos,
const FIntRect& ViewRect,
const FMatrix& InvViewProjMatrix,
FVector& out_WorldOrigin,
FVector& out_WorldDirection
)

 Overload to take a single combined view projection matrix.
Public function void Applied global restrictions from show flags
Public function Const uint32 Returns the distance field temporal sample index or 0 if there is no view state
Public function Const const FConvexVolume *  
Public function Const FRDGPooledBuffer * Returns the eye adaptation buffer or null if it doesn't exist.
Public function Const ERHIFeatureLevel::Type Get the feature level for this view (cached from the scene so this is not different per view)
Public function Const const FSceneView * Get the first secondary view associated with the primary view.
Public function Const const TUniformBufferRef< FInstancedViewUniformShaderParameters > & Returns uniform buffer that is used to access (first) instanced view's properties.
Public function Const float Returns the eye adaptation exposure or 0.0f if it doesn't exist.
Public function Const uint32 Returns a the occlusion frame counter or MAX_uint32 if there is no view state
Public function Const ERenderTargetLoadAction Returns the load action to use when overwriting all pixels of a target that you intend to read from.
Public function Const const FVector &  
Public function Const const FSceneView * Get the primary view associated with the secondary view.
Public function Const FVector4f

GetScreenPositionScaleBias ( const FIntPoint& BufferSize,
const FIntRect& ViewRect
)

  
Public function Const TArray< const FSceneView * > Get all secondary views associated with the primary view.
Public function Const EShaderPlatform Get the feature level for this view
Public function Const int32 Instance factor for a stereo pass (normally 2 for ISR views, but see IStereoRendering::GetDesiredNumberOfViews()).
Public function Const FVector

GetTemporalLODOrigin ( int32 Index,
bool bUseLaggedLODTransition
)

 Returns the location used as the origin for LOD computations
Public function Const float Returns the blend factor between the last two LOD samples
Public function Const FVector  
Public function Const uint32 Returns a unique key for the view state if one exists, otherwise returns zero
Public function Const FVector  
Public function Const FVector  
Public function Const bool Tells if the eye adaptation buffer exists without attempting to allocate it.
Public function Const bool Checks whether this is the instanced view of a stereo pair.
Public function Const bool True if the view should render as an instanced stereo pass
Public function Const bool  
Public function Const bool Checks whether this is the primary view of a stereo pair (important in instanced stereo rendering).
Public function Const bool  
Public function void

OverridePostProcessSettings ( const FPostProcessSettings& Src,
float Weight
)

 Custom layers can be combined with the existing settings
Public function Const FVector4

PixelToScreen ( float X,
float Y,
float Z
)

 Transforms a point from pixel coordinates relative to the view's X,Y (left, top) into the view's screen-space.
Public function Const FVector4

PixelToWorld ( float X,
float Y,
float Z
)

 Transforms a point from pixel coordinates relative to the view's X,Y (left, top) into the view's world-space.
Public function Const FPlane

Project ( const FVector& WorldPoint
)

 Transforms a point from the view's world-space into the view's screen-space.
Public function Static bool

ProjectWorldToScreen ( const FVector& WorldPosition,
const FIntRect& ViewRect,
const FMatrix& ViewProjectionMatrix,
FVector2D& out_ScreenPos
)

 Transforms 3D world-space origin into 2D screen coordinates
Public function Const bool

ScreenToPixel ( const FVector4& ScreenPoint,
FVector2D& OutPixelLocation
)

 Transforms a point from the view's screen-space into pixel coordinates relative to the view's X,Y.
Public function Const FVector

ScreenToWorld ( const FVector4& ScreenPoint
)

 Transforms a point from the view's screen-space to world-space.
Public function void

SetDynamicMeshElementsShadowCullFrustum ( const FConvexVolume* InDynamicMeshElementsShadowCullFrustum
)

  
Public function void

SetPreShadowTranslation ( const FVector& InPreShadowTranslation
)

  
Public function void  
Public function Const void

SetupCommonViewUniformBufferParameters ( FViewUniformShaderParameters& ViewUniformShaderParameters,
const FIntPoint& InBufferSize,
int32 NumMSAASamples,
const FIntRect& InEffectiveViewRect,
const FViewMatrices& InViewMatrices,
const FViewMatrices& InPrevViewMatrices
)

 Populates the uniform buffer prameters common to all scene view use cases View parameters should be set up in this method if they are required for the view to render properly.
Public function Const void

SetupViewRectUniformBufferParameters ( FViewUniformShaderParameters& ViewUniformShaderParameters,
const FIntPoint& InBufferSize,
const FIntRect& InEffectiveViewRect,
const FViewMatrices& InViewMatrices,
const FViewMatrices& InPrevViewMatrice
)

 Sets up the view rect parameters in the view's uniform shader parameters
Public function void

StartFinalPostprocessSettings ( FVector InViewLocation
)

 Setup defaults and depending on view position (postprocess volumes)
Public function void

UpdatePlanarReflectionViewMatrix ( const FSceneView& SourceView,
const FMirrorMatrix& MirrorMatrix
)

 If we late update a view, we need to also late update any planar reflection views derived from it
Public function void

UpdateProjectionMatrix ( const FMatrix& NewProjectionMatrix
)

  
Public function void Allow things like HMD displays to update the view matrix at the last minute, to minimize perceived latency
Public function Const bool Verifies all the assertions made on members.
Public function Const bool

WorldToPixel ( const FVector& WorldPoint,
FVector2D& OutPixelLocation
)

 Transforms a point from the view's world-space into pixel coordinates relative to the view's X,Y (left, top).
Public function Const FVector4

WorldToScreen ( const FVector& WorldPoint
)

 Transforms a point from world-space to the view's screen-space.

Deprecated Variables

  Type Name Description
Public variable bool bIsMultiViewEnabled bIsMultiViewEnabled has been deprecated. Use bIsMultiViewportEnabled

Deprecated Functions

  Type Name Description
Public function Const IPooledRenderTarget * Use GetEyeAdaptationBuffer() instead.
Public function Const bool Use HasValidEyeAdaptationBuffer() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page