1. Epic GamesDeveloper
  3. FWorldRenderCapture

FWorldRenderCapture

[FWorldRenderCapture](API\Plugins\ModelingComponents\FWorldRenderCapture) captures a rendering of a set of Actors in a World from a specific viewpoint.

API > API/Plugins > API/Plugins/ModelingComponents

FWorldRenderCapture captures a rendering of a set of Actors in a World from a specific viewpoint. Various types of rendering are supported, as defined by ERenderCaptureType. Currently rendering an entire World, ie without an explicit list of Actors or Components, is not supported.

   
Name FWorldRenderCapture
Type class
Header File /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Scene/WorldRenderCapture.h
Include Path #include "Scene/WorldRenderCapture.h"

Syntax

class FWorldRenderCapture

Constructors

Name Remarks Include Path Unreal Specifiers
  Scene/WorldRenderCapture.h  
  Scene/WorldRenderCapture.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FWorldRenderCapture ()

   Scene/WorldRenderCapture.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FWorldRenderCapture()

   Scene/WorldRenderCapture.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CaptureFromPosition ( ERenderCaptureType CaptureType,
const FFrame3d& ViewFrame,
double HorzFOVDegrees,
double NearPlaneDist,
FImageAdapter& ResultImageOut,
const FRenderCaptureConfig& Config
)

 Capture the desired buffer type CaptureType with the given view/camera parameters. Scene/WorldRenderCapture.h  

FSphere ComputeContainingRenderSphere ( float HorzFOVDegrees,
float SafetyBoundsScale
) const

 Compute a sphere where, if the camera is on the sphere pointed at the center, then the Visible Actors will be fully visible (ie a square capture will not have any clipping), for the given Field of View. Scene/WorldRenderCapture.h  

const FImageDimensions & GetDimensions()

   Scene/WorldRenderCapture.h  

const FViewMatrices & GetLastCaptureViewMatrices()

   Scene/WorldRenderCapture.h  

FBoxSphereBounds GetVisibleActorBounds()

 Get bounding-box of the Visible actors Scene/WorldRenderCapture.h  

void SetDimensions ( const FImageDimensions& Dimensions
)

 Set desired pixel dimensions of the rendered target image Scene/WorldRenderCapture.h  

void SetEnableWriteDebugImage ( bool bEnable,
int32 ImageCounter,
FString FolderName
)

 Enable debug image write. Scene/WorldRenderCapture.h  

void SetVisibleActors ( const TArray< AActor* >& Actors
)

 Set the set of Actors in the target World that should be included in the Rendering. Scene/WorldRenderCapture.h  

void SetVisibleActorsAndComponents ( const TArray< AActor* >& VisibleActors,
const TArray< UActorComponent* >& VisibleComponents
)

 Set the set of Actors and Components in the target World that should be included in the Rendering. Scene/WorldRenderCapture.h  

void SetVisibleComponents ( const TArray< UActorComponent* >& Components
)

 Set the set of Components in the target World that should be included in the Rendering. Scene/WorldRenderCapture.h  

void SetWorld ( UWorld* World
)

 Set the target World Scene/WorldRenderCapture.h  

void Shutdown()

 Explicitly release any allocated textures or other data structres Scene/WorldRenderCapture.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CaptureBufferVisualizationFromPosition ( const FName& VisualizationMode,
const FFrame3d& Frame,
double HorzFOVDegrees,
double NearPlaneDist,
FImageAdapter& ResultImageOut,
const FRenderCaptureConfig& Config
)

 The following values for VisualizationMode are supported: BaseColor, Metallic, Roughness, Specular, WorldNormal, Opacity, SubsurfaceColor, PreTonemapHDRColor Scene/WorldRenderCapture.h  

bool CaptureDeviceDepthFromPosition ( const FFrame3d& Frame,
double HorzFOVDegrees,
double NearPlaneDist,
FImageAdapter& ResultImageOut,
const FRenderCaptureConfig& Config
)

 Depth is a special case and uses different code than capture of color/property channels Scene/WorldRenderCapture.h  

bool CaptureEmissiveFromPosition ( const FFrame3d& Frame,
double HorzFOVDegrees,
double NearPlaneDist,
FImageAdapter& ResultImageOut,
const FRenderCaptureConfig& Config
)

 Emissive is a special case and uses different code than capture of color/property channels Scene/WorldRenderCapture.h  

bool CaptureMRSFromPosition ( const FFrame3d& Frame,
double HorzFOVDegrees,
double NearPlaneDist,
FImageAdapter& ResultImageOut,
const FRenderCaptureConfig& Config
)

 Combined Metallic/Roughness/Specular uses a custom postprocess material Scene/WorldRenderCapture.h  

UTextureRenderTarget2D * GetDepthRenderTexture()

   Scene/WorldRenderCapture.h  

UTextureRenderTarget2D * GetRenderTexture ( bool bLinear
)

   Scene/WorldRenderCapture.h  

void WriteDebugImage ( const FImageAdapter& ResultImageOut,
const FString& ImageTypeName
)

   Scene/WorldRenderCapture.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Scene/WorldRenderCapture.h  
  Scene/WorldRenderCapture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page