Describes a SIPL buffer containing an NvSciBufObj.
Definition at line 289 of file NvSIPLClient.hpp.
◆ ~INvSIPLNvMBuffer()
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::~INvSIPLNvMBuffer |
( |
| ) |
|
|
overridedefault |
◆ INvSIPLNvMBuffer() [1/3]
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer |
( |
INvSIPLNvMBuffer & |
other | ) |
|
|
delete |
◆ INvSIPLNvMBuffer() [2/3]
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer |
( |
INvSIPLNvMBuffer && |
other | ) |
|
|
delete |
◆ INvSIPLNvMBuffer() [3/3]
| nvsipl::INvSIPLClient::INvSIPLNvMBuffer::INvSIPLNvMBuffer |
( |
| ) |
|
|
protecteddefault |
◆ AddNvSciSyncPrefence()
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().
ICP operations support up to 3 unique pre-fences per pipeline ISP operations support up to 8 unique pre-fences per pipeline
Users need to ensure that the number of unique pre-fences for ISP does not exceed 8 across the all output buffers if using more than one ISP outputs for the pipeline.
- Precondition
- None.
- Parameters
-
| [in] | prefence | Prefence to be added. |
AddNvSciSyncPrefence() originates the following SIPLStatus return values:
- Return values
-
| NVSIPL_STATUS_OK | The function succeeds. |
| NVSIPL_STATUS_ERROR | If internal NvSci fence operations fail. |
| SIPLStatus | Other values of SIPLStatus are propagated. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
◆ 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 the producer of the buffer.
- Precondition
- None.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes, with the following conditions:
- There is no active release operation that results in the buffer available for re-use.
- Re-entrant: No
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
◆ GetEOFNvSciSyncFence()
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().
- Precondition
- None.
- Parameters
-
| [out] | postfence | EOF fence being returned. |
GetEOFNvSciSyncFence() originates the following SIPLStatus return values:
- Return values
-
| NVSIPL_STATUS_OK | The function succeeds. |
| NVSIPL_STATUS_ERROR | If internal NvSci fence operations fail. |
| SIPLStatus | Other values of SIPLStatus are propagated. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
◆ GetImageData()
| virtual ImageMetaData const& nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageData |
( |
| ) |
const |
|
pure virtual |
Gets an nvsipl::INvSIPLClient::ImageMetaData associated with NvSciBufObj.
- Returns
- A const reference to nvsipl::INvSIPLClient::ImageMetaData.
- Precondition
- None.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
◆ GetImageEmbeddedData()
| virtual ImageEmbeddedData const& nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetImageEmbeddedData |
( |
| ) |
const |
|
pure virtual |
Gets an nvsipl::INvSIPLClient::ImageEmbeddedData this is the RAW data associated with the captured image from the sensor before it is parsed to ImageMetaData structure.
- Precondition
- None.
- Returns
- A const reference to nvsipl::INvSIPLClient::ImageEmbeddedData.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
◆ GetNvSciBufImage()
| virtual NvSciBufObj nvsipl::INvSIPLClient::INvSIPLNvMBuffer::GetNvSciBufImage |
( |
| ) |
const |
|
pure virtual |
Gets a handle to NvSciBufObj.
- Precondition
- None.
- Returns
- A NvSciBufObj.
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ Release()
| virtual SIPLStatus nvsipl::INvSIPLClient::INvSIPLBuffer::Release |
( |
| ) |
|
|
pure virtualinherited |
Release a reference.
Once the reference has been released as many times as the reference was added, it implies that the user has finished working with the buffer and the buffer is available for re-use by SIPL.
- Precondition
- None.
Release() originates the following SIPLStatus return values:
- Return values
-
| NVSIPL_STATUS_OK | The releasing operation succeeds. |
| NVSIPL_STATUS_BAD_ARGUMENT | If the buffer is already released. |
| SIPLStatus | Other values of SIPLStatus are propagated. |
Usage considerations
- Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
- Required privileges: Yes, with the following conditions:
- Grants: nonroot, allow
- Abilities: public_channel
- Application needs to have access to the SGIDs that SIPL depends on as mentioned in the NVIDIA DRIVE OS Safety Developer Guide
- API group
- Init: No
- Runtime: Yes
- De-Init: No
The documentation for this class was generated from the following file:
