DriveWorks SDK Reference

| 0.6.67 Release

FrameCapture.h
Go to the documentation of this file.
1 // This code contains NVIDIA Confidential Information and is disclosed
3 // under the Mutual Non-Disclosure Agreement.
4 //
5 // Notice
6 // ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
7 // NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
8 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
9 // MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
10 //
11 // NVIDIA Corporation assumes no responsibility for the consequences of use of such
12 // information or for any infringement of patents or other rights of third parties that may
13 // result from its use. No license is granted by implication or otherwise under any patent
14 // or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
15 // expressly authorized by NVIDIA. Details are subject to change without notice.
16 // This code supersedes and replaces all information previously supplied.
17 // NVIDIA Corporation products are not authorized for use as critical
18 // components in life support devices or systems without express written approval of
19 // NVIDIA Corporation.
20 //
21 // Copyright (c) 2017 NVIDIA Corporation. All rights reserved.
22 //
23 // NVIDIA Corporation and its licensors retain all intellectual property and proprietary
24 // rights in and to this software and related documentation and any modifications thereto.
25 // Any use, reproduction, disclosure or distribution of this software and related
26 // documentation without an express license agreement from NVIDIA Corporation is
27 // strictly prohibited.
28 //
30 
45 #ifndef DW_FRAMECAPTURE_H__
46 #define DW_FRAMECAPTURE_H__
47 
48 #include <dw/core/Context.h>
49 #include <dw/sensors/Sensors.h>
50 #include <dw/image/Image.h>
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
60 typedef struct dwFrameCaptureObject *dwFrameCaptureHandle_t;
61 
65 typedef struct {
67  uint32_t width;
68 
70  uint32_t height;
71 
74 
77 
81 
94 dwStatus dwFrameCapture_initialize(dwFrameCaptureHandle_t *obj,
95  const dwFrameCaptureParams *params,
96  dwSALHandle_t sal,
97  dwContextHandle_t ctx);
98 
108 dwStatus dwFrameCapture_release(dwFrameCaptureHandle_t *framecapture);
109 
124 dwStatus dwFrameCapture_screenCapture(const dwImageGL** imageGL, const dwRect roi,
125  dwFrameCaptureHandle_t framecapture);
126 
137 dwStatus dwFrameCapture_appendFrameCUDA(const dwImageCUDA* img, dwFrameCaptureHandle_t framecapture);
138 
149 dwStatus dwFrameCapture_appendFrameGL(const dwImageGL* img, dwFrameCaptureHandle_t framecapture);
150 
151 
152 #ifdef __cplusplus
153 }
154 #endif
155 
156 #endif // DW_FRAMECAPTURE_H__
uint32_t height
Height of the GL window / image.
Definition: FrameCapture.h:70
DW_API_PUBLIC dwStatus dwFrameCapture_initialize(dwFrameCaptureHandle_t *obj, const dwFrameCaptureParams *params, dwSALHandle_t sal, dwContextHandle_t ctx)
Create a new frame capture module.
DW_API_PUBLIC dwStatus dwFrameCapture_appendFrameGL(const dwImageGL *img, dwFrameCaptureHandle_t framecapture)
Append a dwImageGL frame to the capture and it&#39;s serialized.
Defines a rectangle.
Definition: Types.h:151
DW_API_PUBLIC dwStatus dwFrameCapture_release(dwFrameCaptureHandle_t *framecapture)
Releases the frame capture module.
NVIDIA DriveWorks API: Sensor Serializer
Defines a CUDA image.
Definition: Image.h:263
DW_API_PUBLIC dwStatus dwFrameCapture_appendFrameCUDA(const dwImageCUDA *img, dwFrameCaptureHandle_t framecapture)
Append a dwImageCUDA frame to the capture and it&#39;s serialized.
NVIDIA DriveWorks API: Core Methods
Holds the parameters for sensor serializer creation.
NVIDIA DriveWorks API: Image Conversion and Streaming Functionality
dwBool disableSerialization
Set DW_TRUE to disable setup for serialization and setup only screen capture.
Definition: FrameCapture.h:73
dwSerializerParams params
SensorSerializer parameters, see SensorSerializer.h.
Definition: FrameCapture.h:79
dwStatus
Status definition.
Definition: Status.h:167
NVIDIA DriveWorks API: Sensors
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...
dwImageType
Specifies the image type.
Definition: Image.h:83
struct dwSALObject * dwSALHandle_t
Handle representing the Sensor Abstraction Layer interface.
Definition: Sensors.h:77
uint8_t dwBool
Definition: Types.h:79
Defines a GL texture image.
Definition: Image.h:251
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:78
struct dwFrameCaptureObject * dwFrameCaptureHandle_t
Handle to a Frame Capture module object.
Definition: FrameCapture.h:60
uint32_t width
Width of the GL window / image.
Definition: FrameCapture.h:67
dwImageType type
Type, either DW_IMAGE_GL or DW_IMAGE_CUDA for the type of image serializaion.
Definition: FrameCapture.h:76
#define DW_API_PUBLIC
Definition: Exports.h:76
Initialization parameters for the frame capture module.
Definition: FrameCapture.h:65