5.2.6 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 159 of file NvSIPLClient.hpp.

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

Public Member Functions

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

Member Function Documentation

◆ AddNvSciSyncPrefence()

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

Add an NvSciSync prefence.

Add an NvSciSync prefence to be used with the next ISP or ICP operation. This function creates its own duplicate of the fence, so the caller must clear their copy of the fence by calling NvSciSyncFenceClear().

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

◆ AddRef()

virtual void nvsipl::INvSIPLClient::INvSIPLBuffer::AddRef ( )
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. The caller must clear the returned fence by calling NvSciSyncFenceClear().

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 ( ) const
pure virtual

Gets a handle to NvMediaImage.

A pointer to NvMediaImage.

◆ GetImageData()

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

◆ GetImageGroup()

virtual NvMediaImageGroup* nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageGroup ( ) const
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 ( )
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.

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