NVIDIA DeepLearning Dataset Synthesizer (NDDS)
 All Classes Namespaces Functions Variables Typedefs Pages
UNVSceneCaptureComponent2D Class Reference
+ Inheritance diagram for UNVSceneCaptureComponent2D:
+ Collaboration diagram for UNVSceneCaptureComponent2D:

Public Member Functions

 UNVSceneCaptureComponent2D (const FObjectInitializer &ObjectInitializer)
 
void CaptureSceneToPixelsData (UNVSceneCaptureComponent2D::OnFinishedCaptureScenePixelsDataCallback Callback)
 Order the component to capture the scene to the render target texture, after the scene is captured, read back the pixels data NOTE: This function run asynchronously, the callback function should use the context data to decide what to do with the pixels data This function is combination of CaptureSceneToTexture and ReadPixelsDataFromTexture. More...
 
FMatrix GetProjectionMatrix () const
 
void StartCapturing ()
 
void StopCapturing ()
 
virtual void UpdateSceneCaptureContents (FSceneInterface *Scene) override
 

Static Public Member Functions

static FMatrix BuildProjectionMatrix (const FNVImageSize &RenderTargetSize, ECameraProjectionMode::Type ProjectionType, float FOV, float OrthoWidth)
 Build a projection matrix (instrinsic) base on the camera settings (aspect ratio, projection type, fov and orthogonal width) More...
 
static FMatrix BuildViewProjectionMatrix (const FTransform &ViewTransform, const FNVImageSize &RenderTargetSize, ECameraProjectionMode::Type ProjectionType, float FOVAngle, float OrthoWidth, FMatrix &ProjectionMatrix)
 Build a projection matrix from a specific view location and rotation. More...
 
static FMatrix BuildViewProjectionMatrix (const FTransform &ViewTransform, const FMatrix &ProjectionMatrix)
 Build a projection matrix from a specific view transform and projection matrix. More...
 

Public Attributes

bool bIgnoreReadbackAlpha
 If true, don't read back the raw alpha value from the render target but set it to 1. More...
 
TEnumAsByte< EPixelFormat > OverrideTexturePixelFormat
 
TEnumAsByte
< ETextureRenderTargetFormat > 
TextureTargetFormat
 Pixel format of the captured TextureTarget NOTE: If a valid TextureTarget is specified then this property will be ignored. More...
 
FNVImageSize TextureTargetSize
 The size (width x height in pixels) of the captured TextureTarget. More...
 

Protected Member Functions

void BeginPlay () override
 
void CaptureSceneToTexture ()
 Command tell this scene capturer to capture the scene into its render target texture later in the rendering phase. More...
 
void EndPlay (const EEndPlayReason::Type EndPlayReason) override
 
void InitTextureRenderTarget ()
 
void OnSceneCaptured ()
 
bool ReadPixelsDataFromTexture (FNVTexturePixelData &OutPixelsData)
 Read back the pixels data from the captured texture NOTE: This function run synchronously (it flush rendering commands) which can cause hitches on the game thread. More...
 
void ReadPixelsDataFromTexture (OnFinishedCaptureScenePixelsDataCallback Callback)
 Async function to read back the pixels data from the captured texture NOTE: This function run asynchronously, the callback function should use the context data to decide what to do with the pixels data. More...
 
bool ShouldCaptureCurrentFrame () const
 
bool ShouldReadbackPixelsData () const
 
void TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
 

Protected Attributes

TArray
< UNVSceneCaptureComponent2D::OnFinishedCaptureScenePixelsDataCallback > 
ReadbackCallbackList
 
FNVTextureRenderTargetReader RenderTargetReader
 

Detailed Description

Definition at line 28 of file NVSceneCaptureComponent2D.h.

Member Function Documentation

static FMatrix UNVSceneCaptureComponent2D::BuildProjectionMatrix ( const FNVImageSize RenderTargetSize,
ECameraProjectionMode::Type  ProjectionType,
float  FOV,
float  OrthoWidth 
)
static

Build a projection matrix (instrinsic) base on the camera settings (aspect ratio, projection type, fov and orthogonal width)

static FMatrix UNVSceneCaptureComponent2D::BuildViewProjectionMatrix ( const FTransform &  ViewTransform,
const FNVImageSize RenderTargetSize,
ECameraProjectionMode::Type  ProjectionType,
float  FOVAngle,
float  OrthoWidth,
FMatrix &  ProjectionMatrix 
)
static

Build a projection matrix from a specific view location and rotation.

static FMatrix UNVSceneCaptureComponent2D::BuildViewProjectionMatrix ( const FTransform &  ViewTransform,
const FMatrix &  ProjectionMatrix 
)
static

Build a projection matrix from a specific view transform and projection matrix.

void UNVSceneCaptureComponent2D::CaptureSceneToPixelsData ( UNVSceneCaptureComponent2D::OnFinishedCaptureScenePixelsDataCallback  Callback)

Order the component to capture the scene to the render target texture, after the scene is captured, read back the pixels data NOTE: This function run asynchronously, the callback function should use the context data to decide what to do with the pixels data This function is combination of CaptureSceneToTexture and ReadPixelsDataFromTexture.

void UNVSceneCaptureComponent2D::CaptureSceneToTexture ( )
protected

Command tell this scene capturer to capture the scene into its render target texture later in the rendering phase.

bool UNVSceneCaptureComponent2D::ReadPixelsDataFromTexture ( FNVTexturePixelData OutPixelsData)
protected

Read back the pixels data from the captured texture NOTE: This function run synchronously (it flush rendering commands) which can cause hitches on the game thread.

void UNVSceneCaptureComponent2D::ReadPixelsDataFromTexture ( OnFinishedCaptureScenePixelsDataCallback  Callback)
protected

Async function to read back the pixels data from the captured texture NOTE: This function run asynchronously, the callback function should use the context data to decide what to do with the pixels data.

Member Data Documentation

bool UNVSceneCaptureComponent2D::bIgnoreReadbackAlpha

If true, don't read back the raw alpha value from the render target but set it to 1.

Definition at line 110 of file NVSceneCaptureComponent2D.h.

TEnumAsByte<ETextureRenderTargetFormat> UNVSceneCaptureComponent2D::TextureTargetFormat

Pixel format of the captured TextureTarget NOTE: If a valid TextureTarget is specified then this property will be ignored.

Definition at line 103 of file NVSceneCaptureComponent2D.h.

FNVImageSize UNVSceneCaptureComponent2D::TextureTargetSize

The size (width x height in pixels) of the captured TextureTarget.

Definition at line 98 of file NVSceneCaptureComponent2D.h.


The documentation for this class was generated from the following file: