1. Epic GamesDeveloper
  3. FWorldRenderCapture

FWorldRenderCapture

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

API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/Scene

References

   
Module ModelingComponents
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Scene/WorldRenderCapture.h
Include #include "Scene/WorldRenderCapture.h"

Syntax

class FWorldRenderCapture

Remarks

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.

Variables

  Type Name Description
Protected variable bool bWriteDebugImage  
Protected variable TArray< AActor * > CaptureActors  
Protected variable int32 DebugImageCounter  
Protected variable FString DebugImageFolderName  
Protected variable UTextureRenderTarget2D * DepthRenderTexture  
Protected variable FImageDimensions Dimensions  
Protected variable UTextureRenderTarget2D * GammaRenderTexture  
Protected variable FViewMatrices LastCaptureViewMatrices  
Protected variable UTextureRenderTarget2D * LinearRenderTexture Temporary textures used as render targets. We explicitly prevent this from being GC'd internally.
Protected variable TArray< FLinearColor > ReadImageBuffer Temporary buffer used to read from texture
Protected variable FImageDimensions RenderTextureDimensions  
Protected variable FBoxSphereBounds VisibleBounds  
Protected variable TSet< FPrimitiveComponentId > VisiblePrimitives  
Protected variable UWorld * World  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function 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
Protected function 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
Public function 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.
Protected function bool

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

 Combined Metallic/Roughness/Specular uses a custom postprocess material
Public function Const FSphere

ComputeContainingRenderSphere ( float HorzFOVDegrees,
float SafetyBoundsScale
)

 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.
Protected function UTextureRenderTarget2D *  
Public function Const const FImageDimensions &  
Public function Const const FViewMatrices &  
Protected function UTextureRenderTarget2D *

GetRenderTexture ( bool bLinear
)

  
Public function Const FBoxSphereBounds Get bounding-box of the Visible actors
Public function void

SetDimensions ( const FImageDimensions& Dimensions
)

 Set desired pixel dimensions of the rendered target image
Public function void

SetEnableWriteDebugImage ( bool bEnable,
int32 ImageCounter,
FString FolderName
)

 Enable debug image write.
Public function void

SetVisibleActors ( const TArray< AActor* >& Actors
)

 Set the set of Actors in the target World that should be included in the Rendering.
Public function void

SetWorld ( UWorld* World
)

 Set the target World
Public function void Explicitly release any allocated textures or other data structres
Protected function void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page