ImageStreamer.h

Go to the documentation of this file.

//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2019-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//

#ifndef DWVISUALIZATION_IMAGE_IMAGESTREAMER_H_
#define DWVISUALIZATION_IMAGE_IMAGESTREAMER_H_

#include <dw/interop/streamer/ImageStreamer.h>
#include <dwvisualization/image/Image.h>

#ifdef __cplusplus
extern "C" {
#endif

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_initialize(dwImageStreamerHandle_t* streamer,
                                      const dwImageProperties* from, dwImageType to,
                                      dwContextHandle_t ctx);

#ifdef VIBRANTE

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_initializeCrossProcess(dwImageStreamerHandle_t* streamer,
                                                  const dwImageProperties* from, dwImageType to,
                                                  dwImageStreamerCrossProcessModeParams params,
                                                  dwContextHandle_t ctx);
#endif

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_producerSend(dwImageHandle_t image, dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_producerReturn(dwImageHandle_t* image, dwTime_t timeout_us,
                                          dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_consumerReceive(dwImageHandle_t* image, dwTime_t timeout_us,
                                           dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_consumerReturn(dwImageHandle_t* image, dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_getOutputProperties(dwImageProperties* props, dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_setCUDAStream(cudaStream_t stream, dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_getCUDAStream(cudaStream_t* stream, dwImageStreamerHandle_t streamer);

DW_VIZ_API_PUBLIC
dwStatus dwImageStreamerGL_release(dwImageStreamerHandle_t streamer);

#ifdef __cplusplus
}
#endif

#endif // DWGL_IMAGE_IMAGESSTREAMER_H_