NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
EGL Utilities

Detailed Description

Defines enums, structs and a class for EGL related utility functions.

Data Structures

struct  nvros::_EglUtilOptions
 Holds required window system related parameters when initializing EGLStream. More...
 
struct  nvros::_EglUtilState
 Holds EGL related parameters. More...
 
struct  nvros::_CudaEglParams
 Holds CUDA EGL related parameters. More...
 
class  nvros::NvRosEglUtil
 Class to initialize the EGLStream for the following roles: EGLOUTPUT_CONSUMER, CUDA_CONSUMER, CUDA_PRODUCER, IMAGE_PRODUCER. More...
 

Typedefs

typedef enum nvros::_ConsumerType nvros::ConsumerType
 Declares all EGL consumer types supported by NvMedia EGLStream library. More...
 
typedef enum nvros::_ProducerType nvros::ProducerType
 Declares all EGL producer types supported by NvMedia EGLStream library. More...
 
typedef enum nvros::_WinSys nvros::WinSys
 Declares all window systems supported by NvMedia EGLStream library. More...
 
typedef enum nvros::_OpMode nvros::OpMode
 Declares modes of operation for EGLStream. More...
 
typedef struct
nvros::_EglUtilOptions 
nvros::EglUtilOptions
 Holds required window system related parameters when initializing EGLStream. More...
 
typedef struct nvros::_EglUtilState nvros::EglUtilState
 Holds EGL related parameters. More...
 
typedef struct
nvros::_CudaEglParams 
nvros::CudaEglParams
 Holds CUDA EGL related parameters. More...
 

Enumerations

enum  nvros::_ConsumerType {
  nvros::VIDEO_CONSUMER,
  nvros::IMAGE_CONSUMER,
  nvros::GL_CONSUMER,
  nvros::CUDA_CONSUMER,
  nvros::EGLOUTPUT_CONSUMER,
  nvros::DEFAULT_CONSUMER = EGLOUTPUT_CONSUMER,
  nvros::INVALID_CONSUMER = -1
}
 Declares all EGL consumer types supported by NvMedia EGLStream library. More...
 
enum  nvros::_ProducerType {
  nvros::VIDEO_PRODUCER = 0,
  nvros::IMAGE_PRODUCER,
  nvros::GL_PRODUCER,
  nvros::CUDA_PRODUCER,
  nvros::DEFAULT_PRODUCER = IMAGE_PRODUCER,
  nvros::INVALID_PRODUCER = -1
}
 Declares all EGL producer types supported by NvMedia EGLStream library. More...
 
enum  nvros::_WinSys {
  nvros::X11 = 0,
  nvros::WAYLAND,
  nvros::EGLDEVICE,
  nvros::NONE,
  nvros::DEFAULT_WINSYS = EGLDEVICE
}
 Declares all window systems supported by NvMedia EGLStream library. More...
 
enum  nvros::_OpMode {
  nvros::MAILBOX = 0,
  nvros::FIFO,
  nvros::DEFAULT_OP_MODE = MAILBOX
}
 Declares modes of operation for EGLStream. More...
 

Typedef Documentation

Declares all EGL consumer types supported by NvMedia EGLStream library.

Holds CUDA EGL related parameters.

You must pass a valid pointer of this structure when initializing CUDA consumer EGLStream. InitConsumer API, on successful execution, populates members of this structure. This structure is only required for CUDA consumer or CUDA producer.

Holds required window system related parameters when initializing EGLStream.

You must populate valid data inside this structure while initializing EGLStream. This structure is only used when initializing EGLOutput consumer.

Holds EGL related parameters.

You must pass a valid pointer of this structure when initializing EGLStream. EglStreamInit API, on successful execution, populates members of this structure.

Declares modes of operation for EGLStream.

Declares all EGL producer types supported by NvMedia EGLStream library.

Declares all window systems supported by NvMedia EGLStream library.

Enumeration Type Documentation

Declares all EGL consumer types supported by NvMedia EGLStream library.

Enumerator
VIDEO_CONSUMER 

Video consumer.

This EGL consumer type is not yet supported in NvROS.

IMAGE_CONSUMER 

Image consumer.

This EGL consumer type is not yet supported in NvROS.

GL_CONSUMER 

GL consumer.

This EGL consumer type is not yet supported in NvROS.

CUDA_CONSUMER 

CUDA® consumer.

This EGL consumer type allows the contents in the EGLStream to be received as a CUDA compatible data type and processes it through a CUDA based algorithm.

EGLOUTPUT_CONSUMER 

EGL output consumer.

This EGL consumer type allows the contents in the EGLStream to be displayed on EGL output.

DEFAULT_CONSUMER 

Default consumer.

This is set to EGLOUTPUT_CONSUMER.

INVALID_CONSUMER 

Invalid consumer type.

Definition at line 49 of file nvros_egl_utils.h.

Declares modes of operation for EGLStream.

Enumerator
MAILBOX 

EGLStream in mailbox mode.

FIFO 

EGLStream in FIFO mode.

DEFAULT_OP_MODE 

Default EGLStream mode.

It is set to MAILBOX.

Definition at line 147 of file nvros_egl_utils.h.

Declares all EGL producer types supported by NvMedia EGLStream library.

Enumerator
VIDEO_PRODUCER 

Video producer.

This EGL producer type is not yet supported in NvROS.

IMAGE_PRODUCER 

Image producer.

This EGL producer type is primarily used to transport image data captured from a camera subsystem.

GL_PRODUCER 

GL producer.

This EGL producer type is not yet supported in NvROS.

CUDA_PRODUCER 

CUDA producer.

This EGL producer type transports image data from a CUDA processing subsystem.

DEFAULT_PRODUCER 

Default producer.

This is set to IMAGE_PRODUCER.

INVALID_PRODUCER 

Invalid producer type.

Definition at line 90 of file nvros_egl_utils.h.

Declares all window systems supported by NvMedia EGLStream library.

Enumerator
X11 

X11 window system.

WAYLAND 

Wayland window system.

EGLDEVICE 

Egldevice window system.

NONE 

No window system.

DEFAULT_WINSYS 

Default window system.

It is set to EGLDEVICE.

Definition at line 125 of file nvros_egl_utils.h.