NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NvScrncaptSurfaceMap Struct Reference

Detailed Description

Holds planes within the frame buffer.

Depending on the pixelFormat, access to certain planes may be invalid. Use the following guidance when accessing:

  • For RGB formats, pU & pV planes shall not be used. Both lengthU & lengthV fields will be set to 0.
  • For YUV formats, U and/or V planes may not be used. For example, in YUV420 Semiplanar:

    • pY points to Y values
    • PU points to U/V interleaved values
    • pV shall not be used (lengthV will be 0)

    In general, the lengthX parameter should be checked to see if a given plane is valid for accessing.

Definition at line 272 of file nvscrncapt.h.

Data Fields

NvScrncaptSurfaceLayout surfaceLayout
 Holds the surface layout. More...
 
NvScrncaptColorFormat pixelFormat
 Holds the pixel color format. More...
 
union {
   unsigned char *   pRGB
 
   unsigned char *   pY
 
}; 
 Holds the RGB/Y surface pointer. More...
 
union {
   unsigned int   lengthRGB
 
   unsigned int   lengthY
 
}; 
 Holds the RGB/Y buffer length. More...
 
union {
   unsigned int   strideRGB
 
   unsigned int   strideY
 
}; 
 RGB/Y surface stride. More...
 
unsigned char * pU
 Holds the U surface pointer. More...
 
unsigned int lengthU
 Holds the U buffer length. More...
 
unsigned int strideUV
 Holds the U/V surface stride. More...
 
unsigned char * pV
 Holds the V surface pointer. More...
 
unsigned int lengthV
 Holds the V buffer length. More...
 
unsigned char blockHeight
 Holds the block Height. More...
 

Field Documentation

union { ... }

RGB/Y surface stride.

union { ... }

Holds the RGB/Y surface pointer.

union { ... }

Holds the RGB/Y buffer length.

unsigned char NvScrncaptSurfaceMap::blockHeight

Holds the block Height.

Definition at line 303 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::lengthRGB

Definition at line 284 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::lengthU

Holds the U buffer length.

Definition at line 295 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::lengthV

Holds the V buffer length.

Definition at line 301 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::lengthY

Definition at line 285 of file nvscrncapt.h.

NvScrncaptColorFormat NvScrncaptSurfaceMap::pixelFormat

Holds the pixel color format.

Definition at line 276 of file nvscrncapt.h.

unsigned char* NvScrncaptSurfaceMap::pRGB

Definition at line 279 of file nvscrncapt.h.

unsigned char* NvScrncaptSurfaceMap::pU

Holds the U surface pointer.

Definition at line 293 of file nvscrncapt.h.

unsigned char* NvScrncaptSurfaceMap::pV

Holds the V surface pointer.

Definition at line 299 of file nvscrncapt.h.

unsigned char* NvScrncaptSurfaceMap::pY

Definition at line 280 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::strideRGB

Definition at line 289 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::strideUV

Holds the U/V surface stride.

Definition at line 297 of file nvscrncapt.h.

unsigned int NvScrncaptSurfaceMap::strideY

Definition at line 290 of file nvscrncapt.h.

NvScrncaptSurfaceLayout NvScrncaptSurfaceMap::surfaceLayout

Holds the surface layout.

Definition at line 274 of file nvscrncapt.h.


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