NV_ENC_LOCK_INPUT_BUFFER Struct Reference

#include <nvEncodeAPI.h>

Data Fields
uint32_t	version
	[in]: Struct version. More...
uint32_t	doNotWait:1
	[in]: Set to 1 to make NvEncLockInputBuffer() a unblocking call. More...
uint32_t	reservedBitFields:31
	[in]: Reserved bitfields and must be set to 0 More...
NV_ENC_INPUT_PTR	inputBuffer
	[in]: Pointer to the input buffer to be locked, client should pass the pointer obtained from NvEncCreateInputBuffer() or NvEncMapInputResource API. More...
void *	bufferDataPtr
	[out]: Pointed to the locked input buffer data. More...
uint32_t	pitch
	[out]: Pitch of the locked input buffer. More...
uint32_t	reserved1 [251]
	[in]: Reserved and must be set to 0 More...
void *	reserved2 [64]
	[in]: Reserved and must be set to NULL More...

Detailed Description

Definition at line 1595 of file nvEncodeAPI.h.

Field Documentation

uint32_t NV_ENC_LOCK_INPUT_BUFFER::version

[in]: Struct version.

Must be set to NV_ENC_LOCK_INPUT_BUFFER_VER.

Definition at line 1597 of file nvEncodeAPI.h.

Referenced by nvenc_upload_frame().

uint32_t NV_ENC_LOCK_INPUT_BUFFER::doNotWait

[in]: Set to 1 to make NvEncLockInputBuffer() a unblocking call.

If the encoding is not completed, driver will return NV_ENC_ERR_ENCODER_BUSY error code.

Definition at line 1598 of file nvEncodeAPI.h.

uint32_t NV_ENC_LOCK_INPUT_BUFFER::reservedBitFields

[in]: Reserved bitfields and must be set to 0

Definition at line 1599 of file nvEncodeAPI.h.

NV_ENC_INPUT_PTR NV_ENC_LOCK_INPUT_BUFFER::inputBuffer

[in]: Pointer to the input buffer to be locked, client should pass the pointer obtained from NvEncCreateInputBuffer() or NvEncMapInputResource API.

Definition at line 1600 of file nvEncodeAPI.h.

Referenced by nvenc_upload_frame().

void* NV_ENC_LOCK_INPUT_BUFFER::bufferDataPtr

[out]: Pointed to the locked input buffer data.

Client can only access input buffer using the bufferDataPtr.

Definition at line 1601 of file nvEncodeAPI.h.

Referenced by nvenc_copy_frame().

uint32_t NV_ENC_LOCK_INPUT_BUFFER::pitch

[out]: Pitch of the locked input buffer.

Definition at line 1602 of file nvEncodeAPI.h.

Referenced by nvenc_copy_frame(), and nvenc_upload_frame().

uint32_t NV_ENC_LOCK_INPUT_BUFFER::reserved1[251]

[in]: Reserved and must be set to 0

Definition at line 1603 of file nvEncodeAPI.h.

void* NV_ENC_LOCK_INPUT_BUFFER::reserved2[64]

[in]: Reserved and must be set to NULL

Definition at line 1604 of file nvEncodeAPI.h.

---

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

• compat/nvenc/nvEncodeAPI.h