DriveWorks SDK Reference
5.12.103 Release
For Test and Development only

ImageStreamer.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2019-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
47#ifndef DWVISUALIZATION_IMAGE_IMAGESTREAMER_H_
48#define DWVISUALIZATION_IMAGE_IMAGESTREAMER_H_
49
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
79 const dwImageProperties* from, dwImageType to,
81
82#ifdef VIBRANTE
84
105DW_DEPRECATED("WARNING: will be removed in the next major release")
107 const dwImageProperties* from, dwImageType to,
110#endif
111
129
146 dwImageStreamerHandle_t streamer);
147
163 dwImageStreamerHandle_t streamer);
164
179
193
210
225
238
239#ifdef __cplusplus
240}
241#endif
242
244#endif // DWGL_IMAGE_IMAGESSTREAMER_H_
dwStatus
Status definition.
Definition: ErrorDefs.h:45
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:64
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:86
#define DW_DEPRECATED(msg)
Definition: Exports.h:66
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_producerReturn(dwImageHandle_t *image, dwTime_t timeout_us, dwImageStreamerHandle_t streamer)
The producer streamer waits for the image sent to be returned by the consumer.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_initializeCrossProcess(dwImageStreamerHandle_t *streamer, const dwImageProperties *from, dwImageType to, dwImageStreamerCrossProcessModeParams params, dwContextHandle_t ctx)
Creates and initializes the image streamer capable of moving images between GL and different API type...
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_setCUDAStream(cudaStream_t stream, dwImageStreamerHandle_t streamer)
Sets the CUDA stream for CUDA related streaming operations such as post and receive.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_getCUDAStream(cudaStream_t *stream, dwImageStreamerHandle_t streamer)
Get CUDA stream used by the image streamer.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_release(dwImageStreamerHandle_t streamer)
Releases the image streamer.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_producerSend(dwImageHandle_t image, dwImageStreamerHandle_t streamer)
Sends an image through the streamer acting as the producer.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_getOutputProperties(dwImageProperties *props, dwImageStreamerHandle_t streamer)
Get image properties of the image received from the streamer.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_consumerReceive(dwImageHandle_t *image, dwTime_t timeout_us, dwImageStreamerHandle_t streamer)
Receive a pointer to a dwImageHandle_t from the streamer, acting as a consumer.
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_initialize(dwImageStreamerHandle_t *streamer, const dwImageProperties *from, dwImageType to, dwContextHandle_t ctx)
Creates and initializes the image streamer capable of moving images between GL and different API type...
DW_VIZ_API_PUBLIC dwStatus dwImageStreamerGL_consumerReturn(dwImageHandle_t *image, dwImageStreamerHandle_t streamer)
Return the received image back to the producer.
struct dwImageObject * dwImageHandle_t
Definition: Image.h:111
dwImageType
Specifies the image type.
Definition: Image.h:99
Defines the properties of the image.
Definition: Image.h:460
struct dwImageStreamerObject * dwImageStreamerHandle_t
Definition: ImageStreamer.h:61
Sets of parameters for cross-process image streamer creation.
Definition: ImageStreamer.h:73
NVIDIA DriveWorks API: Image Streamer
#define DW_VIZ_API_PUBLIC
Definition: Exports.h:49
NVIDIA DriveWorks GL API: Image Conversion and Streaming Functionality