Frame Capture

Detailed Description

Defines FrameCapture module for performing capture of currently bound GL frame buffer.

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...

Functions
DW_API_PUBLIC dwStatus	dwFrameCapture_appendFrameCUDA (const dwImageCUDA *img, dwFrameCaptureHandle_t framecapture)
	Append a dwImageCUDA frame to the capture and it's serialized. More...
DW_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_initialize (dwFrameCaptureHandle_t *obj, const dwFrameCaptureParams *params, dwSALHandle_t sal, dwContextHandle_t ctx)
	Create a new frame capture module. More...
DW_API_PUBLIC dwStatus	dwFrameCapture_release (dwFrameCaptureHandle_t *framecapture)
	Releases the frame capture module. More...
DW_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...

---

Data Structure Documentation

dwFrameCaptureParams

struct dwFrameCaptureParams

Data Fields
dwBool	disableSerialization	Set DW_TRUE to disable setup for serialization and setup only screen capture.
uint32_t	height	Height of the GL window / image.
dwSerializerParams	params	SensorSerializer parameters, see SensorSerializer.h.
dwImageType	type	Type, either DW_IMAGE_GL or DW_IMAGE_CUDA for the type of image serializaion.
uint32_t	width	Width of the GL window / image.

Typedef Documentation

dwFrameCaptureHandle_t

typedef struct dwFrameCaptureObject* dwFrameCaptureHandle_t

Handle to a Frame Capture module object.

Definition at line 60 of file FrameCapture.h.

Function Documentation

dwFrameCapture_appendFrameCUDA()

DW_API_PUBLIC dwStatus dwFrameCapture_appendFrameCUDA	(	const dwImageCUDA *	img,
		dwFrameCaptureHandle_t	framecapture
	)

Append a dwImageCUDA frame to the capture and it's serialized.

Parameters

[in]	img	dwImageCUDA to serialize
[in]	framecapture	Handle to the frame capture module being released.

Returns

DW_INVALID_HANDLE - if given handle is invalid
DW_SUCCESS

dwFrameCapture_appendFrameGL()

DW_API_PUBLIC dwStatus dwFrameCapture_appendFrameGL	(	const dwImageGL *	img,
		dwFrameCaptureHandle_t	framecapture
	)

Append a dwImageGL frame to the capture and it's serialized.

Parameters

[in]	img	dwImageGL to serialize
[in]	framecapture	Handle to the frame capture module being released.

Returns

DW_INVALID_HANDLE - if given handle is invalid
DW_SUCCESS

dwFrameCapture_initialize()

DW_API_PUBLIC dwStatus dwFrameCapture_initialize	(	dwFrameCaptureHandle_t *	obj,
		const dwFrameCaptureParams *	params,
		dwSALHandle_t	sal,
		dwContextHandle_t	ctx
	)

Create a new frame capture module.

Parameters

[out]	obj	Handle to the frame capture module being initialized.
[in]	params	Frame capture initialization parameters.
[in]	sal	Handle to current SAL interface
[in]	ctx	Handle to the current driveworks context.

Returns

DW_INVALID_ARGUMENTS - if given arguments are invalid
DW_SUCCESS

dwFrameCapture_release()

DW_API_PUBLIC dwStatus dwFrameCapture_release

(

dwFrameCaptureHandle_t *

framecapture

)

Releases the frame capture module.

Parameters

[in]

framecapture

Handle to the frame capture module being released.

Returns

DW_INVALID_HANDLE - if given handle is invalid
DW_SUCCESS

dwFrameCapture_screenCapture()

DW_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.

It is independent from the original source of the GL frame, i.e. video or camera, and platform, i.e. Linux or Vibrante.

Parameters

[out]	imageGL	a pointer to a dwImageGL pointer containing the captured window
[in]	roi	Region of interest to be captured
[in]	framecapture	Handle to the frame capture module being released.

Returns

DW_INVALID_HANDLE - if given handle is invalid
DW_SUCCESS