Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/SceneView.h |
Include |
#include "SceneView.h" |
class FSceneView
A projection from scene space into a 2D screen region.
Name | Description | ||
---|---|---|---|
|
AntiAliasingMethod |
The antialiasing method. |
|
|
AtmosphereInscatterTexture |
||
|
AtmosphereIrradianceTexture |
||
|
AtmosphereTransmittanceTexture |
Parameters for atmospheric fog. |
|
|
BackgroundColor |
||
|
bAllowCrossGPUTransfer |
Allow cross GPU transfer for this view |
|
|
bAllowTemporalJitter |
||
|
bAllowTranslucentPrimitivesInHitProxy |
True if we should draw translucent objects when rendering hit proxies |
|
|
BaseHmdLocation |
||
|
BaseHmdOrientation |
||
|
bCameraCut |
Whether we did a camera cut for this view this frame. |
|
|
bCameraMotionBlur |
Whether to enable motion blur caused by camera movements |
|
|
bForceCameraVisibilityReset |
True if we need to force the camera to discard previous frames occlusion. |
|
|
bForcePathTracerReset |
True if we should force the path tracer to reset its internal accumulation state |
|
|
bHasNearClippingPlane |
||
|
bHasSelectedComponents |
True if any components are selected in isolation (independent of actor selection) |
|
|
bIsGameView |
True if this scene was created from a game world. |
|
|
bIsInstancedStereoEnabled |
True if instanced stereo is enabled. |
|
|
bIsLocked |
Whether this view was created from a locked viewpoint. |
|
|
bIsMobileMultiViewEnabled |
True if mobile multi-view is enabled. |
|
|
bIsMultiViewEnabled |
True if multi-view is enabled. |
|
|
bIsOfflineRender |
Whether this view is being used to render a high quality offline render |
|
|
bIsPlanarReflection |
Whether this view is being used to render a planar reflection. |
|
|
bIsReflectionCapture |
Whether this view is being used to render a reflection capture. |
|
|
bIsSceneCapture |
Whether this view is being used to render a scene capture. |
|
|
bIsViewInfo |
For sanity checking casts that are assumed to be safe. |
|
|
bIsVirtualTexture |
Whether this view is being used to render a runtime virtual texture. |
|
|
bOverrideGPUMask |
Use custom GPUmask |
|
|
bRenderFirstInstanceOnly |
Whether this view should render the first instance only of any meshes using instancing. |
|
|
bRenderSceneTwoSided |
Whether to force two sided rendering for this view. |
|
|
bReverseCulling |
True if ViewMatrix.Determinant() is negative. |
|
|
bSceneCaptureUsesRayTracing |
Whether this view uses ray tracing, for views that are used to render a scene capture. |
|
|
bShouldBindInstancedViewUB |
True if we need to bind the instanced view uniform buffer parameters. |
|
|
bStaticSceneOnly |
Whether to only render static lights and objects. |
|
|
bUseFieldOfViewForLOD |
Whether to use FOV when computing mesh LOD. |
|
|
bUsePixelInspector |
Whether to use the pixel inspector |
|
|
CameraConstrainedViewRect |
Aspect ratio constrained view rect. |
|
|
ClipToPrevClipOverride |
Matrix overrides PrevViewToClip in the view uniform buffer. |
|
|
ColorScale |
Color scale multiplier used during post processing |
|
|
CullingFrustum |
Monoscopic culling frustum, same as ViewFrustum in case of non-stereo |
|
|
CullingOrigin |
Monoscopic culling origin, same as the view matrix origin in case of non-stereo |
|
|
CurrentBufferVisualizationMode |
Current buffer visualization mode |
|
|
CurrentNaniteVisualizationMode |
Current Nanite visualization mode |
|
|
CurrentVisualizeCalibrationColorMaterialName |
Current visualize calibration color material name |
|
|
CurrentVisualizeCalibrationCustomMaterialName |
Current visualize calibration custom material name |
|
|
CurrentVisualizeCalibrationGrayscaleMaterialName |
Current visualize calibration grayscale material name |
|
|
CursorPos |
-1,-1 if not setup |
|
|
float |
DesiredFOV |
|
|
DiffuseOverrideParameter |
These can be used to override material parameters across the scene without recompiling shaders. |
|
|
DrawDynamicFlags |
||
|
Drawer |
An interaction which draws the view's interaction elements. |
|
|
EditorViewBitflag |
The set of (the first 64) groups' visibility info for this view |
|
|
EyeAdaptationViewState |
||
|
const FSceneVie... |
Family |
|
|
const ERHIFeatu... |
FeatureLevel |
Feature level for this scene |
|
FinalPostProcessDebugInfo |
||
|
FinalPostProcessSettings |
The final settings for the current viewer position (blended together from many volumes). |
|
|
float |
FOV |
Actual field of view and that desired by the camera originally |
|
FrameSubIsOccluded |
||
|
GlobalClippingPlane |
Global clipping plane being applied to the scene, or all 0's if disabled. |
|
|
GPUMask |
The GPU nodes on which to render this view. |
|
|
HiddenPrimitives |
The primitives which are hidden for this view. |
|
|
InvDeviceZToWorldZTransform |
Vector used by shaders to convert depth buffer samples into z coordinates in world space |
|
|
LandscapeIndirectionBuffer |
Landscape rendering related data |
|
|
LandscapePerComponentDataBuffer |
||
|
LensPrincipalPointOffsetScale |
In some cases, the principal point of the lens is not at the center of the screen, especially for overlapped tile rendering. |
|
|
float |
LODDistanceFactor |
Multiplier for cull distance on objects |
|
float |
MaterialTextureMipBias |
Mip bias to apply in material's samplers. |
|
MaxShadowCascades |
Maximum number of shadow cascades to render with. |
|
|
float |
NearClippingDistance |
|
|
NearClippingPlane |
||
|
NormalOverrideParameter |
||
|
OriginOffsetThisFrame |
World origin offset value. Non-zero only for a single frame when origin is rebased |
|
|
OverlayColor |
||
|
OverrideFrameIndexValue |
The frame index to override, useful for keeping determinism when rendering sequences. |
|
|
OverrideLODViewOrigin |
For ortho views, this can control how to determine LOD parenting (ortho has no "distance-to-camera") |
|
|
PlayerIndex |
Player index this view is associated with or INDEX_NONE. |
|
|
PreviousViewTransform |
||
|
PrimaryScreenPercentageMethod |
Primary screen percentage method to use. |
|
|
PrimaryViewIndex |
For stereoscopic rendering, view family index of the primary view associated with this view |
|
|
ProjectionMatrixUnadjustedForRHI |
||
|
RoughnessOverrideParameter |
||
|
SceneViewInitOptions |
||
|
SelectionOutlineColor |
Selection color for the editor (used by post processing) |
|
|
ShadowViewMatrices |
Normally the same as ViewMatrices unless "r.Shadow.FreezeCamera" is activated |
|
|
ShowOnlyPrimitives |
The primitives which are visible for this view. |
|
|
SpecularOverrideParameter |
||
|
SpriteCategoryVisibility |
BitArray representing the visibility state of the various sprite categories in the editor for this view |
|
|
State |
Can be 0 (thumbnail rendering) |
|
|
float |
StereoIPD |
Half of the view's stereo IPD (- for lhs, + for rhs) |
|
StereoPass |
For stereoscopic rendering, whether or not this is a full pass, or a left / right eye pass |
|
|
StereoViewIndex |
For stereoscopic rendering, unique index identifying the view across view families |
|
|
SubduedSelectionOutlineColor |
Selection color for use in the editor with inactive primitives |
|
|
TranslucentSortAxis |
Sort axis for when TranslucentSortPolicy is SortAlongAxis |
|
|
TEnumAsByte< ET... |
TranslucentSortPolicy |
Translucent sort mode |
|
UnconstrainedViewRect |
Raw view size (in pixels), used for screen space calculations |
|
|
float |
UnderwaterDepth |
How far below the water surface this view is. -1 means the view is out of water. |
|
const FIntRect |
UnscaledViewRect |
Final position of the view in the final render target (in pixels), potentially constrained by an aspect ratio requirement (black bars) |
|
const AActor &#... |
ViewActor |
The actor which is being viewed from. |
|
ViewFrustum |
||
|
ViewLocation |
Variables used to determine the view matrix |
|
|
ViewMatrices |
||
|
ViewRotation |
||
|
ViewUniformBuffer |
The uniform buffer for the view's parameters. |
|
|
WaterDataBuffer |
||
|
WaterIndirectionBuffer |
Water rendering related data |
|
|
float |
WorldToMetersScale |
Name | Description | |
---|---|---|
|
FSceneView ( |
Initialization constructor. |
Name | Description | ||
---|---|---|---|
|
AllowGPUParticleUpdate() |
||
|
ConfigureBufferVisualizationSettings() |
Configure post process settings for the buffer visualization system |
|
|
ConfigureVisualizeCalibrationSettings() |
Configure post process settings for calibration material |
|
|
Deproject ( |
Transforms a point from the view's screen-space into world coordinates multiplies X, Y, Z by W before transforming. |
|
|
DeprojectFVector2D |
Transforms 2D screen coordinates into a 3D world-space origin and direction |
|
|
DeprojectScreenToWorld |
Overload to take a single combined view projection matrix. |
|
|
DeprojectScreenToWorld |
Transforms 2D screen coordinates into a 3D world-space origin and direction |
|
|
EndFinalPostprocessSettings ( |
Applied global restrictions from show flags |
|
|
GetDistanceFieldTemporalSampleIndex() |
Returns the distance field temporal sample index or 0 if there is no view state |
|
|
const FConve... |
GetDynamicMeshElementsShadowCullFrustum() |
|
|
FRDGPooledBu... |
GetEyeAdaptationBuffer() |
Returns the eye adaptation buffer (mobile) or null if it doesn't exist. |
|
IPooledRende... |
GetEyeAdaptationTexture() |
Returns the eye adaptation texture (SM5+ only) or null if it doesn't exist. |
|
ERHIFeatureL... |
GetFeatureLevel() |
Get the feature level for this view (cached from the scene so this is not different per view) |
|
const FScene... |
GetInstancedSceneView() |
Get the first secondary view associated with the primary view. |
|
GetOcclusionFrameCounter() |
Returns a the occlusion frame counter or MAX_uint32 if there is no view state |
|
|
const FVecto... |
GetPreShadowTranslation() |
|
|
const FScene... |
GetPrimarySceneView() |
Get the primary view associated with the secondary view. |
|
GetScreenPositionScaleBias |
||
|
TArray< cons... |
GetSecondaryViews() |
Get all secondary views associated with the primary view. |
|
EShaderPlatf... |
GetShaderPlatform() |
Get the feature level for this view |
|
GetTemporalLODOrigin |
Returns the location used as the origin for LOD computations |
|
|
float |
GetTemporalLODTransition() |
Returns the blend factor between the last two LOD samples |
|
GetViewDirection() |
||
|
GetViewKey() |
Returns a unique key for the view state if one exists, otherwise returns zero |
|
|
GetViewRight() |
||
|
GetViewUp() |
||
|
HasValidEyeAdaptationBuffer() |
||
|
HasValidEyeAdaptationTexture() |
Tells if the eye adaptation texture / buffer exists without attempting to allocate it. |
|
|
IsInstancedStereoPass() |
True if the view should render as an instanced stereo pass |
|
|
IsPerspectiveProjection() |
||
|
IsUnderwater() |
||
|
OverridePostProcessSettings ( |
Custom layers can be combined with the existing settings |
|
|
PixelToScreen ( |
Transforms a point from pixel coordinates relative to the view's X,Y (left, top) into the view's screen-space. |
|
|
PixelToWorld ( |
Transforms a point from pixel coordinates relative to the view's X,Y (left, top) into the view's world-space. |
|
|
Project ( |
Transforms a point from the view's world-space into the view's screen-space. |
|
|
ProjectWorldToScreen |
Transforms 3D world-space origin into 2D screen coordinates |
|
|
ScreenToPixel |
Transforms a point from the view's screen-space into pixel coordinates relative to the view's X,Y. |
|
|
ScreenToWorld ( |
Transforms a point from the view's screen-space to world-space. |
|
|
SetDynamicMeshElementsShadowCullFrustum ( |
||
|
SetPreShadowTranslation ( |
||
|
SetupAntiAliasingMethod() |
||
|
SetupCommonViewUniformBufferParameters ( |
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. |
|
|
SetupViewRectUniformBufferParameters ( |
Sets up the view rect parameters in the view's uniform shader parameters |
|
|
StartFinalPostprocessSettings ( |
Setup defaults and depending on view position (postprocess volumes) |
|
|
UpdatePlanarReflectionViewMatrix ( |
If we late update a view, we need to also late update any planar reflection views derived from it |
|
|
UpdateProjectionMatrix ( |
||
|
UpdateViewMatrix() |
Allow things like HMD displays to update the view matrix at the last minute, to minimize perceived latency |
|
|
VerifyMembersChecks() |
Verifies all the assertions made on members. |
|
|
WorldToPixel |
Transforms a point from the view's world-space into pixel coordinates relative to the view's X,Y (left, top). |
|
|
WorldToScreen ( |
Transforms a point from world-space to the view's screen-space. |
Name |
Description |
---|---|
NumBufferedSubIsOccludedArrays |