nvscrncapt.h File Reference

Detailed Description

NVIDIA Tegra Screen Capture Interface

Description: This file contains the screen capture API for Tegra.

Definition in file nvscrncapt.h.

Go to the source code of this file.

Data Structures
struct	NvScrncaptPixel
	Holds a pixel value. More...
struct	NvScrncaptSurfaceMap
	Holds planes within the frame buffer. More...
struct	NvScrncaptAperture
	Holds the representation of a display aperture. More...
struct	NvScrncaptWindowState
	Holds the representation of a window's current state. More...
struct	NvScrncaptHeadState
	Holds a head's current state. More...
struct	NvScrncaptStatistics
	Holds statistics for a single capture. More...
struct	NvScrncaptResult
	Holds the screen capture result. More...

Macros
#define	NVSCRNCAPT_VERSION_MAJOR   1
	Major Version number. More...
#define	NVSCRNCAPT_VERSION_MINOR   0
	Minor Version number. More...
#define	NVSCRNCAPT_TRUE
	A true NvScrncaptBool value. More...
#define	NVSCRNCAPT_FALSE
	A false NvScrncaptBool value. More...
#define	NVSCRNCAPT_MAX_HEADS
	Max # of Display Heads. More...
#define	NVSCRNCAPT_MAX_WINS
	Max # of Windows. More...

Typedefs
typedef int	NvScrncaptBool
	A boolean value, holding NVSCRNCAPT_TRUE or NVSCRNCAPT_FALSE. More...

Enumerations
enum	NvScrncaptStatus {   NVSCRNCAPT_STATUS_OK,   NVSCRNCAPT_STATUS_BAD_PARAMETER,   NVSCRNCAPT_STATUS_BUSY,   NVSCRNCAPT_STATUS_TIMED_OUT,   NVSCRNCAPT_STATUS_OUT_OF_MEMORY,   NVSCRNCAPT_STATUS_NOT_INITIALIZED,   NVSCRNCAPT_STATUS_NOT_SUPPORTED,   NVSCRNCAPT_STATUS_ERROR,   NVSCRNCAPT_STATUS_INVALID_SIZE,   NVSCRNCAPT_STATUS_INCOMPATIBLE_VERSION }
	Defines the set of all possible error codes. More...
enum	NvScrncaptSurfaceLayout {   NvScrncaptSurfaceLayout_Tiled = 0,   NvScrncaptSurfaceLayout_PitchLinear,   NvScrncaptSurfaceLayout_BlockLinear }
	Defines the set of frame buffer memory layout types. More...
enum	NvScrncaptColorFormat {   NvScrncaptColorFormat_RGB_AUTO = ~0,   NvScrncaptColorFormat_P8 = 3,   NvScrncaptColorFormat_B4G4R4A4 = 4,   NvScrncaptColorFormat_B5G5R5A = 5,   NvScrncaptColorFormat_B5G6R5 = 6,   NvScrncaptColorFormat_AB5G5R5 = 7,   NvScrncaptColorFormat_B8G8R8A8 = 12,   NvScrncaptColorFormat_R8G8B8A8 = 13,   NvScrncaptColorFormat_B6x2G6x2R6x2A8 = 14,   NvScrncaptColorFormat_R6x2G6x2B6x2A8 = 15,   NvScrncaptColorFormat_YCbCr422 = 16,   NvScrncaptColorFormat_YUV422 = 17,   NvScrncaptColorFormat_YCbCr420P = 18,   NvScrncaptColorFormat_YUV420P = 19,   NvScrncaptColorFormat_YCbCr422P = 20,   NvScrncaptColorFormat_YUV422P = 21,   NvScrncaptColorFormat_YCbCr422R = 22,   NvScrncaptColorFormat_YUV422R = 23,   NvScrncaptColorFormat_YCbCr422RA = 24,   NvScrncaptColorFormat_YUV422RA = 25,   NvScrncaptColorFormat_R4G4B4A4 = 27,   NvScrncaptColorFormat_R5G5B5A = 28,   NvScrncaptColorFormat_AR5G5B5 = 29,   NvScrncaptColorFormat_B5G5R5X = 30,   NvScrncaptColorFormat_XB5G5R5 = 31,   NvScrncaptColorFormat_R5G5B5X = 32,   NvScrncaptColorFormat_XR5G5B5 = 33,   NvScrncaptColorFormat_R5G6B5 = 34,   NvScrncaptColorFormat_A8B8G8R8 = 36,   NvScrncaptColorFormat_B8G8R8X8 = 37,   NvScrncaptColorFormat_R8G8B8X8 = 38,   NvScrncaptColorFormat_YCbCr444P = 41,   NvScrncaptColorFormat_YCrCb420SP = 42,   NvScrncaptColorFormat_YCbCr420SP = 43,   NvScrncaptColorFormat_YCrCb422SP = 44,   NvScrncaptColorFormat_YCbCr422SP = 45,   NvScrncaptColorFormat_YCrCb422SPR = 46,   NvScrncaptColorFormat_YCbCr422SPR = 47,   NvScrncaptColorFormat_YCrCb444SP = 48,   NvScrncaptColorFormat_YCbCr444SP = 49,   NvScrncaptColorFormat_YUV444P = 52,   NvScrncaptColorFormat_YVU420SP = 53,   NvScrncaptColorFormat_YUV420SP = 54,   NvScrncaptColorFormat_YVU422SP = 55,   NvScrncaptColorFormat_YUV422SP = 56,   NvScrncaptColorFormat_YVU422SPR = 57,   NvScrncaptColorFormat_YUV422SPR = 58,   NvScrncaptColorFormat_YVU444SP = 59,   NvScrncaptColorFormat_YUV444SP = 60 }
	Defines the set of pixel color formats, which must be kept in sync with the kernel defines. More...
enum	NvScrncaptBlend {   NvScrncaptBlend_None,   NvScrncaptBlend_Premult,   NvScrncaptBlend_Coverage,   NvScrncaptBlend_Colorkey }
	Defines the set of blend modes possible for a window. More...

Functions
NvScrncaptStatus	NvScrncaptInit (NvScrncaptResult **pResult)
	Initializes data structures required for screen capture. More...
NvScrncaptStatus	NvScrncaptCapture (NvScrncaptResult *result, unsigned int headMask)
	Conducts screen capture on heads selected by input bitmask. More...
NvScrncaptStatus	NvScrncaptCleanup (NvScrncaptResult *result)
	Cleans up associated data structures and releases exclusive hold on screen capture functionality. More...
unsigned int	NvScrncaptGetBlocklinearOffset (unsigned int x, unsigned int y, unsigned int stride, unsigned int blockHeight)
	Auxiliary function to calculate byte offset for a pixel for NvScrncaptSurfaceLayout_BlockLinear surface format. More...