NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
FrameCapture.h File Reference

Detailed Description

NVIDIA DriveWorks API: FrameCapture Methods

Description: This file defines Frame Capture methods.

Definition in file FrameCapture.h.

Go to the source code of this file.

Data Structures

struct  dwFrameCaptureParams
 Initialization parameters for the frame capture module. More...
 

Typedefs

typedef struct dwFrameCaptureObject * dwFrameCaptureHandle_t
 Handle to a Frame Capture module object. More...
 
typedef enum dwFrameCaptureMode dwFrameCaptureMode
 Enables FrameCapture functionalities. These can be set as a logical OR between the two modes. Choosing a mode means that the resources needed by that feature will be allocated. More...
 

Enumerations

enum  dwFrameCaptureMode {
  DW_FRAMECAPTURE_MODE_SCREENCAP = 1 << 0,
  DW_FRAMECAPTURE_MODE_SERIALIZE = 1 << 1
}
 Enables FrameCapture functionalities. These can be set as a logical OR between the two modes. Choosing a mode means that the resources needed by that feature will be allocated. More...
 

Functions

DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_initialize (dwFrameCaptureHandle_t *obj, const dwFrameCaptureParams *params, dwSALHandle_t sal, dwContextHandle_t ctx)
 Create a new frame capture module. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_release (dwFrameCaptureHandle_t framecapture)
 Releases the frame capture module. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_screenCapture (const dwImageGL **imageGL, const dwRect roi, dwFrameCaptureHandle_t framecapture)
 It grabs what is currently rendered on the current frame buffer and returns a dwImageGL out of it For example, it permits to serialize additional information, such as bounding boxes, labels, etc., that are rendered on top of the current GL frame. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_screenCaptureCustom (dwImageGL *imageGL, const dwRect roi, dwFrameCaptureHandle_t framecapture)
 It grabs what is currently rendered on the current frame buffer and blits onto the input dwImageGL. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_appendFrame (const dwImageHandle_t img, dwFrameCaptureHandle_t framecapture)
 Append a dwImageHandle frame to the capture and it's serialized. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_appendFrameCUDA (const dwImageCUDA *img, dwFrameCaptureHandle_t framecapture)
 Append a dwImageCUDA frame to the capture and it's serialized. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_appendFrameCPU (const dwImageCPU *img, dwFrameCaptureHandle_t framecapture)
 Append a dwImageCPU frame to the capture and it's serialized. More...
 
DW_VIZ_API_PUBLIC dwStatus dwFrameCapture_appendFrameGL (const dwImageGL *img, dwFrameCaptureHandle_t framecapture)
 Append a dwImageGL frame to the capture and it's serialized. More...
 
DW_API_PUBLIC dwStatus dwFrameCapture_appendAllocationAttributes (dwImageProperties *imgProps, dwFrameCaptureHandle_t framecapture)
 Append the allocation attribute to create images that work with other NvSci based modules. More...