NVIDIA DRIVE OS Linux SDK API Reference Release
For Test and Development only
nvsipl::INvSIPLClient::INvSIPLNvMBuffer Class Referenceabstract

Detailed Description

Describes a SIPL buffer containing an NvMediaImage or NvMediaImageGroup.

INvSIPLNvMBuffer holds either NvMediaImage or NvMediaImageGroup at a time.

Definition at line 135 of file NvSIPLClient.hpp.

Inheritance diagram for nvsipl::INvSIPLClient::INvSIPLNvMBuffer:
Collaboration diagram for nvsipl::INvSIPLClient::INvSIPLNvMBuffer:

Public Member Functions

virtual NvMediaImageGetImage ()=0
 Gets a handle to NvMediaImage. More...
virtual NvMediaImageGroupGetImageGroup ()=0
 Gets a handle to NvMediaImageGroup. More...
virtual ImageMetaData GetImageData ()=0
 Gets an nvsipl::INvSIPLClient::ImageMetaData associated with NvMediaImage or NvMediaImageGroup. More...
virtual void AddRef (void)=0
 Adds a reference. More...
virtual SIPLStatus Release (void)=0
 Release a reference. More...
virtual SIPLStatus AddNvSciSyncPrefence (NvSciSyncFence &prefence)=0
 Add an NvSciSync prefence. More...
virtual SIPLStatus GetEOFNvSciSyncFence (NvSciSyncFence *postfence)=0
 Retrieve the latest NvSciSync EOF fence. More...

Data Fields

NvSciStreamCookie cookie
 NvSciStreamCookie associated with the buffer. More...

Member Function Documentation

◆ AddNvSciSyncPrefence()

virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::AddNvSciSyncPrefence ( NvSciSyncFence prefence)
pure virtualinherited

Add an NvSciSync prefence.

Add an NvSciSync prefence to be used with the next ISP or ICP operation.

[in]prefencePrefence to be added.
SIPLStatus The completion status of the operation.

◆ AddRef()

virtual void nvsipl::INvSIPLClient::INvSIPLBuffer::AddRef ( void  )
pure virtualinherited

Adds a reference.

Adding a reference to the buffer ensures that this buffer is not re-used by another producer/consumer of the buffer.

◆ GetEOFNvSciSyncFence()

virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::GetEOFNvSciSyncFence ( NvSciSyncFence postfence)
pure virtualinherited

Retrieve the latest NvSciSync EOF fence.

Retrieve the buffer's latest NvSciSync EOF fence associated with the engine's set NvSciSync EOF object.

This method should only be called after nvsipl::INvSIPLCamera::Start().

[out]postfenceEOF fence being returned.
SIPLStatus The completion status of the operation.

◆ GetImage()

virtual NvMediaImage* nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImage ( )
pure virtual

Gets a handle to NvMediaImage.

A pointer to NvMediaImage.

◆ GetImageData()

virtual ImageMetaData nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageData ( )
pure virtual

◆ GetImageGroup()

virtual NvMediaImageGroup* nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageGroup ( )
pure virtual

Gets a handle to NvMediaImageGroup.

This function holds the output of an image sensor in HDR mode.

A pointer to NvMediaImageGroup.

◆ Release()

virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::Release ( void  )
pure virtualinherited

Release a reference.

Releasing reference implies that the user has finished working with the buffer and the buffer is available for re-use.

SIPLStatus The completion status of the operation.

Field Documentation

◆ cookie

NvSciStreamCookie nvsipl::INvSIPLClient::INvSIPLBuffer::cookie

NvSciStreamCookie associated with the buffer.

Definition at line 126 of file NvSIPLClient.hpp.

The documentation for this class was generated from the following file: