1. Epic GamesDeveloper
  3. FMinimalViewInfo

FMinimalViewInfo

API > API/Runtime > API/Runtime/Engine

   
Name FMinimalViewInfo
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Camera/CameraTypes.h
Include Path #include "Camera/CameraTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FMinimalViewInfo

Constructors

Name Remarks Include Path Unreal Specifiers

FMinimalViewInfo()

   Camera/CameraTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AspectRatio float Aspect Ratio (Width/Height) Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
AspectRatioAxisConstraint TOptional< EAspectRatioAxisConstraint > Aspect ratio axis constraint override. Camera/CameraTypes.h  
AsymmetricCropFraction FVector4f Experimental: 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. Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
  • Meta=(ClampMin=0.0, UIMin=0.0, ClampMax=1.0, UIMax=1.0)
AutoPlaneShift float Manually adjusts the planes of this camera, maintaining the distance between them. Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
bAutoCalculateOrthoPlanes bool Option for the Ortho camera to automatically calculated the near/far plane Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
bConstrainAspectRatio uint32 If bConstrainAspectRatio is true, black bars will be added if the destination view has a different aspect ratio than this camera requested. Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
bUpdateOrthoPlanes bool Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefacting Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
bUseCameraHeightAsViewTarget bool 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) Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
bUseFieldOfViewForLOD uint32 If true, account for the field of view angle when computing which level of detail to use for meshes. Camera/CameraTypes.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadWrite
  • Category=CameraSettings
bUseFirstPersonParameters uint32 If bUseFirstPersonParameters is true, FirstPersonFOV and FirstPersonScale should be applied to primitives tagged as "IsFirstPerson". Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
CropFraction float The fraction between 0.0 and 1.0 of the view to crop to during the final post process upscale, with 1.0 meaning no crop Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
  • Meta=(ClampMin=0.0, UIMin=0.0, ClampMax=1.0, UIMax=1.0)
DesiredFOV float The originally desired horizontal field of view before any adjustments to account for different aspect ratios Camera/CameraTypes.h
  • Transient
FirstPersonFOV float The horizontal field of view (in degrees) used for primitives tagged as "IsFirstPerson". Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
FirstPersonScale float The scale to apply to primitives tagged as "IsFirstPerson". Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
FOV float The horizontal field of view (in degrees) in perspective mode (ignored in orthographic mode). Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
Location FVector Location Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
OffCenterProjectionOffset FVector2D Off-axis / off-center projection offset as proportion of screen dimensions Camera/CameraTypes.h
  • Transient
  • VisibleInstanceOnly
  • BlueprintReadWrite
  • Category=Camera
OrthoFarClipPlane float The far plane distance of the orthographic view (in world units) Camera/CameraTypes.h
  • Interp
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
OrthoNearClipPlane float The near plane distance of the orthographic view (in world units) Camera/CameraTypes.h
  • Interp
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
OrthoWidth float The desired width (in world units) of the orthographic view (ignored in Perspective mode) Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
OverscanResolutionFraction float Resolution fraction that scales with the amount of overscan added to the view Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
PerspectiveNearClipPlane float The near plane distance of the perspective view (in world units). Camera/CameraTypes.h
  • Interp
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
PostProcessBlendWeight float Indicates if PostProcessSettings should be applied. Camera/CameraTypes.h
  • BlueprintReadWrite
  • Category=Camera
PostProcessSettings FPostProcessSettings Post-process settings to use if PostProcessBlendWeight is non-zero. Camera/CameraTypes.h
  • BlueprintReadWrite
  • Category=Camera
PreviousViewTransform TOptional< FTransform > Optional transform to be considered as this view's previous transform Camera/CameraTypes.h  
ProjectionMode TEnumAsByte< ECameraProjectionMode::Type > The type of camera. Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera
Rotation FRotator Rotation Camera/CameraTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Camera

Protected

Name Type Remarks Include Path Unreal Specifiers
AsymmetricOverscan FVector4f Experimental: The amount of asymmetric overscan that has been applied to the view's frustum, with 0.0 meaning no overscan and 1.0 meaning 100% overscan. Camera/CameraTypes.h  
CameraToViewTarget FVector Only used for Ortho camera auto plane calculations, tells the Near plane of the extra distance that needs to be added. Camera/CameraTypes.h  
Overscan float The amount of overscan that has been applied to the view's frustum, with 0.0 meaning no overscan and 1.0 meaning 100% overscan Camera/CameraTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddWeightedViewInfo ( const FMinimalViewInfo& OtherView,
const float& Weight
)

 Combines this view with another one which will be weighted. Camera/CameraTypes.h  

void ApplyAsymmetricOverscan ( const FVector4f& InAsymmetricOverscan,
bool bScaleResolutionWithOverscan,
bool bCropOverscan
)

 Experimental: Apply asymmetric overscan to the view info, which scales the field of view, ortho width, aspect ratio, and off-center projection to simulate expanding the view frustum asymmetrically. Camera/CameraTypes.h  

void ApplyBlendWeight ( const float& Weight
)

 Applies weighting to this view, in order to be blended with another one. Camera/CameraTypes.h  

void ApplyOverscan ( float InOverscan,
bool bScaleResolutionWithOverscan,
bool bCropOverscan
)

 Apply overscan to the view info, which scales the field of view and ortho width to simulate expanding the view frustum. Camera/CameraTypes.h  

bool AutoCalculateOrthoPlanes ( FSceneViewProjectionData& InOutProjectionData
)

 Automatically calculates the Near/Far plane values for an Ortho camera Camera/CameraTypes.h  

void BlendViewInfo ( FMinimalViewInfo& OtherInfo,
float OtherWeight
)

 Blends view information Note: booleans are orred together, instead of blending Camera/CameraTypes.h  
Correction factor to apply to the first person transform used on primitives tagged as "IsFirstPerson" to achieve a first person specific field of view. Camera/CameraTypes.h  

FMatrix CalculateProjectionMatrix()

 Calculates the projection matrix using this view info's aspect ratio (regardless of bConstrainAspectRatio) Camera/CameraTypes.h  

void ClearOverscan()

 Removes all overscan (uniform and asymmetric) from the view info. Camera/CameraTypes.h  

bool Equals ( const FMinimalViewInfo& OtherInfo
) const

 Is this equivalent to the other one? Camera/CameraTypes.h  
The near plane distance of the perspective view (in world units). Camera/CameraTypes.h  

float GetOverscan()

 Gets the total amount of overscan that has been applied to the view's frustum, with 0.0 meaning no overscan and 1.0 meaning 100% overscan Camera/CameraTypes.h  

void SetCameraToViewTarget ( const FVector ActorLocation
)

 Sets the camera distance from view target for AutoCalculateOrthoPlanes Camera/CameraTypes.h  

FVector TransformWorldToFirstPerson ( const FVector& WorldPosition,
bool bIgnoreFirstPersonScale
) const

 Transforms a world space location into "first person space". Camera/CameraTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CalculateProjectionMatrixGivenView ( FMinimalViewInfo& ViewInfo,
TEnumAsByte< enum EAspectRatioAxisConstraint > AspectRatioAxisConstraint,
FViewport* Viewport,
FSceneViewProjectionData& InOutProjectionData
)

 Calculates the projection matrix (and potentially a constrained view rectangle) given a FMinimalViewInfo and partially configured projection data (must have the view rect already set) Camera/CameraTypes.h  

static void CalculateProjectionMatrixGivenViewRectangle ( FMinimalViewInfo& ViewInfo,
TEnumAsByte< enum EAspectRatioAxisConstraint > AspectRatioAxisConstraint,
const FIntRect& ConstrainedViewRectangle,
FSceneViewProjectionData& InOutProjectionData
)

 Calculates the projection matrix (and potentially a constrained view rectangle) given a FMinimalViewInfo and partially configured projection data (must have the view rect already set). Camera/CameraTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page