/[rtss_sdk]/trunk/Include/RTSSSharedMemory.h
ViewVC logotype

Diff of /trunk/Include/RTSSSharedMemory.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

--- trunk/Include/RTSSSharedMemory.h	2014/08/08 12:09:18	10
+++ trunk/Include/RTSSSharedMemory.h	2014/08/09 05:49:59	11
@@ -1,457 +1,469 @@
-/////////////////////////////////////////////////////////////////////////////
+
 //
 // This header file defines statistics server's shared memory format
 //
-/////////////////////////////////////////////////////////////////////////////
+
 #ifndef _RTSS_SHARED_MEMORY_INCLUDED_
 #define _RTSS_SHARED_MEMORY_INCLUDED_
-/////////////////////////////////////////////////////////////////////////////
+
+#pragma region OSD FLAGS
+	enum OSDFLAGS 
+	{
+		//use this flag to force the server to update OSD
+		OSDFLAG_UPDATED		=	0x00000001,
+	};
+#pragma endregion
+
+#pragma region STAT FLAGS
+	enum STATFLAGS
+	{
+		STATFLAG_RECORD		=	0x00000001,
+	};
+#pragma endregion
+
+#pragma region APPLICATION FLAGS
+	enum APPFLAGS
+	{
+		APPFLAG_DD							=	0x00000010,
+		APPFLAG_D3D8						=	0x00000100,
+		APPFLAG_D3D9						=	0x00001000,
+		APPFLAG_D3D9EX						=	0x00002000,
+		APPFLAG_OGL							=	0x00010000,
+		APPFLAG_D3D10						=	0x00100000,
+		APPFLAG_D3D11						=	0x01000000,
+		APPFLAG_API_USAGE_MASK				=	(APPFLAG_DD | APPFLAG_D3D8 | APPFLAG_D3D9 | APPFLAG_D3D9EX | APPFLAG_OGL | APPFLAG_D3D10  | APPFLAG_D3D11),
+		APPFLAG_PROFILE_UPDATE_REQUESTED	=	0x10000000,
+	};
+#pragma endregion
+
+#pragma region SCREEN CAPTURE FLAGS
+	enum SCREEENCAPFLAGS
+	{
+		SCREENCAPTUREFLAG_REQUEST_CAPTURE		=	0x00000001,
+		SCREENCAPTUREFLAG_REQUEST_CAPTURE_OSD	=	0x00000010,
+	};
+#pragma endregion
+
+#pragma region VIDEO CAPTURE FLAGS
+	enum VIDEOCAPFLAGS
+	{
+		VIDEOCAPTUREFLAG_REQUEST_CAPTURE_START		=	0x00000001,
+		VIDEOCAPTUREFLAG_REQUEST_CAPTURE_PROGRESS	=	0x00000002,
+		VIDEOCAPTUREFLAG_REQUEST_CAPTURE_STOP		=	0x00000004,
+		VIDEOCAPTUREFLAG_REQUEST_CAPTURE_MASK		=	0x00000007,
+		VIDEOCAPTUREFLAG_REQUEST_CAPTURE_OSD		=	0x00000010,
+		VIDEOCAPTUREFLAG_INTERNAL_RESIZE			=	0x00010000,
+	};
+#pragma endregion
+
+#pragma region RTSS_SHARED_MEMORY V1_0 struture
 // v1.0 memory structure
 typedef struct RTSS_SHARED_MEMORY_V_1_0
 {
-	DWORD	dwSignature;
-		//signature allows applications to verify status of shared memory
-
-		//The signature can be set to:
-		//'RTSS'	- statistics server's memory is initialized and contains 
-		//			valid data 
-		//0xDEAD	- statistics server's memory is marked for deallocation and
-		//			no longer contain valid data
-		//otherwise	the memory is not initialized
-	DWORD	dwVersion;
-		//structure version ((major<<16) + minor)
-		//must be set to 0x00010000 for v1.0 structure
+	//signature allows applications to verify status of shared memory
+	//The signature can be set to:
+	//'RTSS'	- statistics server's memory is initialized and contains 
+	//			valid data 
+	//0xDEAD	- statistics server's memory is marked for deallocation and
+	//			no longer contain valid data
+	//otherwise	the memory is not initialized
+	DWORD	dwSignature;		
+	//structure version ((major<<16) + minor)
+	//must be set to 0x00010000 for v1.0 structure
+	DWORD	dwVersion;		
+	//start time of framerate measurement period (in milliseconds)
+	//Take a note that this field must contain non-zero value to calculate 
+	//framerate properly!
 	DWORD	dwTime0;
-		//start time of framerate measurement period (in milliseconds)
-
-		//Take a note that this field must contain non-zero value to calculate 
-		//framerate properly!
+	//end time of framerate measurement period (in milliseconds)
 	DWORD	dwTime1;
-		//end time of framerate measurement period (in milliseconds)
-	DWORD	dwFrames;
-		//amount of frames rendered during (dwTime1 - dwTime0) period 
-
-		//to calculate framerate use the following formula:
-		//1000.0f * dwFrames / (dwTime1 - dwTime0)
+	//amount of frames rendered during (dwTime1 - dwTime0) period 
+	//to calculate framerate use the following formula:
+	//1000.0f * dwFrames / (dwTime1 - dwTime0)
+	DWORD	dwFrames;		
 
 } RTSS_SHARED_MEMORY_V_1_0, *LPRTSS_SHARED_MEMORY_V_1_0;
-/////////////////////////////////////////////////////////////////////////////
-#define OSDFLAG_UPDATED			0x00000001
-	//use this flag to force the server to update OSD
-/////////////////////////////////////////////////////////////////////////////
+#pragma endregion
+
+#pragma region RTSS_SHARED_MEMORY V1_1 struture
 // v1.1 memory structure
 typedef struct RTSS_SHARED_MEMORY_V_1_1
 {
+	//signature allows applications to verify status of shared memory
+	//The signature can be set to:
+	//'RTSS'	- statistics server's memory is initialized and contains 
+	//			valid data 
+	//0xDEAD	- statistics server's memory is marked for deallocation and
+	//			no longer contain valid data
+	//otherwise	the memory is not initialized
 	DWORD	dwSignature;
-		//signature allows applications to verify status of shared memory
-
-		//The signature can be set to:
-		//'RTSS'	- statistics server's memory is initialized and contains 
-		//			valid data 
-		//0xDEAD	- statistics server's memory is marked for deallocation and
-		//			no longer contain valid data
-		//otherwise	the memory is not initialized
-	DWORD	dwVersion;
-		//structure version ((major<<16) + minor)
-		//must be set to 0x00010001 for v1.1 structure
-	DWORD	dwTime0;
-		//start time of framerate measurement period (in milliseconds)
-
-		//Take a note that this field must contain non-zero value to calculate 
-		//framerate properly!
+	//structure version ((major<<16) + minor)
+	//must be set to 0x00010001 for v1.1 structure
+	DWORD	dwVersion;		
+	//start time of framerate measurement period (in milliseconds)
+	//Take a note that this field must contain non-zero value to calculate 
+	//framerate properly!
+	DWORD	dwTime0;		
+	//end time of framerate measurement period (in milliseconds)
 	DWORD	dwTime1;
-		//end time of framerate measurement period (in milliseconds)
-	DWORD	dwFrames;
-		//amount of frames rendered during (dwTime1 - dwTime0) period
-
-		//to calculate framerate use the following formula:
-		//1000.0f * dwFrames / (dwTime1 - dwTime0)
-
+	//amount of frames rendered during (dwTime1 - dwTime0) period
+	//to calculate framerate use the following formula:
+	//1000.0f * dwFrames / (dwTime1 - dwTime0)
+	DWORD	dwFrames;	
+	//bitmask, containing combination of OSDFLAG_... flags
+	//Note: set OSDFLAG_UPDATED flag as soon as you change any OSD related field
 	DWORD	dwOSDFlags;
-		//bitmask, containing combination of OSDFLAG_... flags
-
-		//Note: set OSDFLAG_UPDATED flag as soon as you change any OSD related
-		//field
+	//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+	//pixel offset from the right side of the screen)
 	DWORD	dwOSDX;
-		//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-		//pixel offset from the right side of the screen)
+	//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+	//pixel offset from the bottom side of the screen)
 	DWORD	dwOSDY;
-		//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-		//pixel offset from the bottom side of the screen)
+	//OSD pixel zooming ratio
 	DWORD	dwOSDPixel;
-		//OSD pixel zooming ratio
+	//OSD color in RGB format
 	DWORD	dwOSDColor;
-		//OSD color in RGB format
-	char	szOSD[256];
-		//OSD text
+	//OSD text
+	char	szOSD[256];		
+	//OSD owner ID
+	//Use this field to capture OSD and prevent other applications from
+	//using OSD when it is already in use by your application.
+	//You should change this field only if it is empty (i.e. when OSD is
+	//not owned by any application) or if it is set to your own application's
+	//ID (i.e. when you own OSD)
+	//You shouldn't change any OSD related feilds until you own OSD
 	char	szOSDOwner[32];
-		//OSD owner ID
-
-		//Use this field to capture OSD and prevent other applications from
-		//using OSD when it is already in use by your application.
-		//You should change this field only if it is empty (i.e. when OSD is
-		//not owned by any application) or if it is set to your own application's
-		//ID (i.e. when you own OSD)
-		//You shouldn't change any OSD related feilds until you own OSD
-
 } RTSS_SHARED_MEMORY_V_1_1, *LPRTSS_SHARED_MEMORY_V_1_1;
-/////////////////////////////////////////////////////////////////////////////
+#pragma endregion
+
+#pragma region RTSS_SHARED_MEMORY V1_2 struture
 // v1.2 memory structure
 typedef struct RTSS_SHARED_MEMORY_V_1_2
 {
-	DWORD	dwSignature;
-		//signature allows applications to verify status of shared memory
-
-		//The signature can be set to:
-		//'RTSS'	- statistics server's memory is initialized and contains 
-		//			valid data 
-		//0xDEAD	- statistics server's memory is marked for deallocation and
-		//			no longer contain valid data
-		//otherwise	the memory is not initialized
+	//signature allows applications to verify status of shared memory
+	//The signature can be set to:
+	//'RTSS'	- statistics server's memory is initialized and contains 
+	//			valid data 
+	//0xDEAD	- statistics server's memory is marked for deallocation and
+	//			no longer contain valid data
+	//otherwise	the memory is not initialized
+	DWORD	dwSignature;		
+	//structure version ((major<<16) + minor)
+	//must be set to 0x00010002 for v1.2 structure
 	DWORD	dwVersion;
-		//structure version ((major<<16) + minor)
-		//must be set to 0x00010002 for v1.2 structure
+	//start time of framerate measurement period (in milliseconds)
+	//Take a note that this field must contain non-zero value to calculate 
+	//framerate properly!
 	DWORD	dwTime0;
-		//start time of framerate measurement period (in milliseconds)
-
-		//Take a note that this field must contain non-zero value to calculate 
-		//framerate properly!
+	//end time of framerate measurement period (in milliseconds)
 	DWORD	dwTime1;
-		//end time of framerate measurement period (in milliseconds)
-	DWORD	dwFrames;
-		//amount of frames rendered during (dwTime1 - dwTime0) period
-
-		//to calculate framerate use the following formula:
-		//1000.0f * dwFrames / (dwTime1 - dwTime0)
-
+	//amount of frames rendered during (dwTime1 - dwTime0) period
+	//to calculate framerate use the following formula:
+	//1000.0f * dwFrames / (dwTime1 - dwTime0)
+	DWORD	dwFrames;	
+	//bitmask, containing combination of OSDFLAG_... flags
+	//Note: set OSDFLAG_UPDATED flag as soon as you change any OSD related field
 	DWORD	dwOSDFlags;
-		//bitmask, containing combination of OSDFLAG_... flags
-
-		//Note: set OSDFLAG_UPDATED flag as soon as you change any OSD related
-		//field
+	//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+	//pixel offset from the right side of the screen)
 	DWORD	dwOSDX;
-		//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-		//pixel offset from the right side of the screen)
+	//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+	//pixel offset from the bottom side of the screen)
 	DWORD	dwOSDY;
-		//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-		//pixel offset from the bottom side of the screen)
+	//OSD pixel zooming ratio
 	DWORD	dwOSDPixel;
-		//OSD pixel zooming ratio
+	//OSD color in RGB format
 	DWORD	dwOSDColor;
-		//OSD color in RGB format
-	char	szOSD[256];
-		//primary OSD slot text
+	//primary OSD slot text
+	char	szOSD[256];		
+	//primary OSD slot owner ID
+	//Use this field to capture OSD slot and prevent other applications from
+	//using OSD when it is already in use by your application.
+	//You should change this field only if it is empty (i.e. when OSD slot is
+	//not owned by any application) or if it is set to your own application's
+	//ID (i.e. when you own OSD slot)
+	//You shouldn't change any OSD related feilds until you own OSD slot
 	char	szOSDOwner[32];
-		//primary OSD slot owner ID
-
-		//Use this field to capture OSD slot and prevent other applications from
-		//using OSD when it is already in use by your application.
-		//You should change this field only if it is empty (i.e. when OSD slot is
-		//not owned by any application) or if it is set to your own application's
-		//ID (i.e. when you own OSD slot)
-		//You shouldn't change any OSD related feilds until you own OSD slot
-
-	char	szOSD1[256];
-		//OSD slot 1 text
-	char	szOSD1Owner[32];
-		//OSD slot 1 owner ID
-	char	szOSD2[256];
-		//OSD slot 2 text
-	char	szOSD2Owner[32];
-		//OSD slot 2 owner ID
-	char	szOSD3[256];
-		//OSD slot 3 text
-	char	szOSD3Owner[32];
-		//OSD slot 3 owner ID
+	//OSD slot 1 text
+	char	szOSD1[256];	
+	//OSD slot 1 owner ID
+	char	szOSD1Owner[32];		
+	//OSD slot 2 text
+	char	szOSD2[256];	
+	//OSD slot 2 owner ID
+	char	szOSD2Owner[32];		
+	//OSD slot 3 text
+	char	szOSD3[256];	
+	//OSD slot 3 owner ID
+	char	szOSD3Owner[32];		
 } RTSS_SHARED_MEMORY_V_1_2, *LPRTSS_SHARED_MEMORY_V_1_2;
-/////////////////////////////////////////////////////////////////////////////
-#define STATFLAG_RECORD			0x00000001
-/////////////////////////////////////////////////////////////////////////////
+#pragma endregion
+
+#pragma region RTSS_SHARED_MEMORY V1_3 struture
 // v1.3 memory structure
 typedef struct RTSS_SHARED_MEMORY_V_1_3
 {
-	DWORD	dwSignature;
-		//signature allows applications to verify status of shared memory
-
-		//The signature can be set to:
-		//'RTSS'	- statistics server's memory is initialized and contains 
-		//			valid data 
-		//0xDEAD	- statistics server's memory is marked for deallocation and
-		//			no longer contain valid data
-		//otherwise	the memory is not initialized
+	//signature allows applications to verify status of shared memory
+	//The signature can be set to:
+	//'RTSS'	- statistics server's memory is initialized and contains 
+	//			valid data 
+	//0xDEAD	- statistics server's memory is marked for deallocation and
+	//			no longer contain valid data
+	//otherwise	the memory is not initialized
+	DWORD	dwSignature;		
+	//structure version ((major<<16) + minor)
+	//must be set to 0x00010003 for v1.3 structure
 	DWORD	dwVersion;
-		//structure version ((major<<16) + minor)
-		//must be set to 0x00010003 for v1.3 structure
+	//start time of framerate measurement period (in milliseconds)
+	//Take a note that this field must contain non-zero value to calculate 
+	//framerate properly!
 	DWORD	dwTime0;
-		//start time of framerate measurement period (in milliseconds)
-
-		//Take a note that this field must contain non-zero value to calculate 
-		//framerate properly!
+	//end time of framerate measurement period (in milliseconds)
 	DWORD	dwTime1;
-		//end time of framerate measurement period (in milliseconds)
-	DWORD	dwFrames;
-		//amount of frames rendered during (dwTime1 - dwTime0) period
-
-		//to calculate framerate use the following formula:
-		//1000.0f * dwFrames / (dwTime1 - dwTime0)
-
+	//amount of frames rendered during (dwTime1 - dwTime0) period
+	//to calculate framerate use the following formula:
+	//1000.0f * dwFrames / (dwTime1 - dwTime0)
+	DWORD	dwFrames;	
+	//bitmask, containing combination of OSDFLAG_... flags
+	//Note: set OSDFLAG_UPDATED flag as soon as you change any OSD related field
 	DWORD	dwOSDFlags;
-		//bitmask, containing combination of OSDFLAG_... flags
-
-		//Note: set OSDFLAG_UPDATED flag as soon as you change any OSD related
-		//field
+	//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+	//pixel offset from the right side of the screen)
 	DWORD	dwOSDX;
-		//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-		//pixel offset from the right side of the screen)
+	//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+	//pixel offset from the bottom side of the screen)
 	DWORD	dwOSDY;
-		//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-		//pixel offset from the bottom side of the screen)
+	//OSD pixel zooming ratio
 	DWORD	dwOSDPixel;
-		//OSD pixel zooming ratio
+	//OSD color in RGB format
 	DWORD	dwOSDColor;
-		//OSD color in RGB format
-	char	szOSD[256];
-		//primary OSD slot text
+	//primary OSD slot text
+	char	szOSD[256];		
+	//primary OSD slot owner ID
+	//Use this field to capture OSD slot and prevent other applications from
+	//using OSD when it is already in use by your application.
+	//You should change this field only if it is empty (i.e. when OSD slot is
+	//not owned by any application) or if it is set to your own application's
+	//ID (i.e. when you own OSD slot)
+	//You shouldn't change any OSD related feilds until you own OSD slot
 	char	szOSDOwner[32];
-		//primary OSD slot owner ID
-
-		//Use this field to capture OSD slot and prevent other applications from
-		//using OSD when it is already in use by your application.
-		//You should change this field only if it is empty (i.e. when OSD slot is
-		//not owned by any application) or if it is set to your own application's
-		//ID (i.e. when you own OSD slot)
-		//You shouldn't change any OSD related feilds until you own OSD slot
-
-	char	szOSD1[256];
-		//OSD slot 1 text
-	char	szOSD1Owner[32];
-		//OSD slot 1 owner ID
-	char	szOSD2[256];
-		//OSD slot 2 text
-	char	szOSD2Owner[32];
-		//OSD slot 2 owner ID
-	char	szOSD3[256];
-		//OSD slot 3 text
-	char	szOSD3Owner[32];
-		//OSD slot 3 owner ID
-
+	//OSD slot 1 text
+	char	szOSD1[256];	
+	//OSD slot 1 owner ID
+	char	szOSD1Owner[32];		
+	//OSD slot 2 text
+	char	szOSD2[256];	
+	//OSD slot 2 owner ID
+	char	szOSD2Owner[32];		
+	//OSD slot 3 text
+	char	szOSD3[256];	
+	//OSD slot 3 owner ID
+	char	szOSD3Owner[32];		
+	//bitmask containing combination of STATFLAG_... flags
 	DWORD	dwStatFlags;
-		//bitmask containing combination of STATFLAG_... flags
+	//statistics record period start time
 	DWORD	dwStatTime0;
-		//statistics record period start time
+	//statistics record period end time
 	DWORD	dwStatTime1;
-		//statistics record period end time
-	DWORD	dwStatFrames;
-		//total amount of frames rendered during statistics record period
-	DWORD	dwStatCount;
-		//amount of min/avg/max measurements during statistics record period 
-	DWORD	dwStatFramerateMin;
-		//minimum instantaneous framerate measured during statistics record period 
+	//total amount of frames rendered during statistics record period
+	DWORD	dwStatFrames;		
+	//amount of min/avg/max measurements during statistics record period 
+	DWORD	dwStatCount;		
+	//minimum instantaneous framerate measured during statistics record period 
+	DWORD	dwStatFramerateMin;	
+	//average instantaneous framerate measured during statistics record period 
 	DWORD	dwStatFramerateAvg;
-		//average instantaneous framerate measured during statistics record period 
-	DWORD	dwStatFramerateMax;
-		//maximum instantaneous framerate measured during statistics record period 
+	//maximum instantaneous framerate measured during statistics record period 
+	DWORD	dwStatFramerateMax;		
 } RTSS_SHARED_MEMORY_V_1_3, *LPRTSS_SHARED_MEMORY_V_1_3;
-/////////////////////////////////////////////////////////////////////////////
-#define APPFLAG_DD												0x00000010
-#define APPFLAG_D3D8											0x00000100
-#define APPFLAG_D3D9											0x00001000
-#define APPFLAG_D3D9EX											0x00002000
-#define APPFLAG_OGL												0x00010000
-#define APPFLAG_D3D10											0x00100000
-#define APPFLAG_D3D11											0x01000000
-
-#define APPFLAG_API_USAGE_MASK									(APPFLAG_DD | APPFLAG_D3D8 | APPFLAG_D3D9 | APPFLAG_D3D9EX | APPFLAG_OGL | APPFLAG_D3D10  | APPFLAG_D3D11)
-
-#define APPFLAG_PROFILE_UPDATE_REQUESTED						0x10000000
-/////////////////////////////////////////////////////////////////////////////
-#define SCREENCAPTUREFLAG_REQUEST_CAPTURE						0x00000001
-#define SCREENCAPTUREFLAG_REQUEST_CAPTURE_OSD					0x00000010
-/////////////////////////////////////////////////////////////////////////////
-#define VIDEOCAPTUREFLAG_REQUEST_CAPTURE_START					0x00000001
-#define VIDEOCAPTUREFLAG_REQUEST_CAPTURE_PROGRESS				0x00000002
-#define VIDEOCAPTUREFLAG_REQUEST_CAPTURE_STOP					0x00000004
-#define VIDEOCAPTUREFLAG_REQUEST_CAPTURE_MASK					0x00000007
-#define VIDEOCAPTUREFLAG_REQUEST_CAPTURE_OSD					0x00000010
-
-#define VIDEOCAPTUREFLAG_INTERNAL_RESIZE						0x00010000
-/////////////////////////////////////////////////////////////////////////////
+#pragma endregion
 
+#pragma region RTSS_SHARED_MEMORY V2_0 struture
 // v2.0 memory structure
 typedef struct RTSS_SHARED_MEMORY
 {
-	DWORD	dwSignature;
-		//signature allows applications to verify status of shared memory
-
-		//The signature can be set to:
-		//'RTSS'	- statistics server's memory is initialized and contains 
-		//			valid data 
-		//0xDEAD	- statistics server's memory is marked for deallocation and
-		//			no longer contain valid data
-		//otherwise	the memory is not initialized
+	//signature allows applications to verify status of shared memory
+	//The signature can be set to:
+	//'RTSS'	- statistics server's memory is initialized and contains 
+	//			valid data 
+	//0xDEAD	- statistics server's memory is marked for deallocation and
+	//			no longer contain valid data
+	//otherwise	the memory is not initialized
+	DWORD	dwSignature;		
+	//structure version ((major<<16) + minor)
+	//must be set to 0x0002xxxx for v2.x structure 
 	DWORD	dwVersion;
-		//structure version ((major<<16) + minor)
-		//must be set to 0x0002xxxx for v2.x structure 
-
+	//size of RTSS_SHARED_MEMORY_OSD_ENTRY for compatibility with future versions
 	DWORD	dwAppEntrySize;
-		//size of RTSS_SHARED_MEMORY_OSD_ENTRY for compatibility with future versions
-	DWORD	dwAppArrOffset;
-		//offset of arrOSD array for compatibility with future versions
+	//offset of arrOSD array for compatibility with future versions
+	DWORD	dwAppArrOffset;		
+	//size of arrOSD array for compatibility with future versions
 	DWORD	dwAppArrSize;
-		//size of arrOSD array for compatibility with future versions
-
+	//size of RTSS_SHARED_MEMORY_APP_ENTRY for compatibility with future versions
 	DWORD	dwOSDEntrySize;
-		//size of RTSS_SHARED_MEMORY_APP_ENTRY for compatibility with future versions
-	DWORD	dwOSDArrOffset;
-		//offset of arrApp array for compatibility with future versions
-	DWORD	dwOSDArrSize;
-		//size of arrOSD array for compatibility with future versions
-
-	DWORD	dwOSDFrame;
-		//Global OSD frame ID. Increment it to force the server to update OSD for all currently active 3D
-		//applications.
-
-	//OSD slot descriptor structure
+	//offset of arrApp array for compatibility with future versions
+	DWORD	dwOSDArrOffset;		
+	//size of arrOSD array for compatibility with future versions
+	DWORD	dwOSDArrSize;		
+	//Global OSD frame ID. Increment it to force the server to update OSD for all currently active 3D applications.
+	DWORD	dwOSDFrame;		
 
+#pragma region OSD Descriptor
+	//OSD descriptor structure
 	typedef struct RTSS_SHARED_MEMORY_OSD_ENTRY
 	{
-		char	szOSD[256];
-			//OSD slot text
+		/* osd related related fields */
+		//OSD slot text
+		char	szOSD[256];		
+		//OSD slot owner ID
 		char	szOSDOwner[256];
-			//OSD slot owner ID
-
-		//next fields are valid for v2.7 and newer shared memory format only
-
+		/* the next fields are valid for v2.7 and newer shared memory format only */
+		//extended OSD slot text
 		char	szOSDEx[4096];
-			//extended OSD slot text
-
 	} RTSS_SHARED_MEMORY_OSD_ENTRY, *LPRTSS_SHARED_MEMORY_OSD_ENTRY;
+#pragma endregion
 
+#pragma region Application Descriptor
 	//application descriptor structure
-
 	typedef struct RTSS_SHARED_MEMORY_APP_ENTRY
 	{
-		//application identification related fields
-
-		DWORD	dwProcessID;
-			//process ID
-		char	szName[MAX_PATH];
-			//process executable name
-		DWORD	dwFlags;
-			//application specific flags
-
-		//instantaneous framerate related fields
+		/* application identification related fields */
+		//process ID
+		DWORD	dwProcessID;			
+		//process executable name
+		char	szName[MAX_PATH];			
+		//application specific flags
+		DWORD	dwFlags;		
 
-		DWORD	dwTime0;
-			//start time of framerate measurement period (in milliseconds)
+		/* instantaneous framerate related fields */
 
+		//start time of framerate measurement period (in milliseconds)
 			//Take a note that this field must contain non-zero value to calculate 
 			//framerate properly!
+		DWORD	dwTime0;
+		//end time of framerate measurement period (in milliseconds)
 		DWORD	dwTime1;
-			//end time of framerate measurement period (in milliseconds)
-		DWORD	dwFrames;
-			//amount of frames rendered during (dwTime1 - dwTime0) period
-		DWORD	dwFrameTime;
-			//frame time (in microseconds)
-
-
+		//amount of frames rendered during (dwTime1 - dwTime0) period
+		DWORD	dwFrames;	
+		//frame time (in microseconds)
 			//to calculate framerate use the following formulas:
-
 			//1000.0f * dwFrames / (dwTime1 - dwTime0) for framerate calculated once per second
-			//or
-			//1000000.0f / dwFrameTime for framerate calculated once per frame 
+			//or 1000000.0f / dwFrameTime for framerate calculated once per frame 
+		DWORD	dwFrameTime;			
 
-		//framerate statistics related fields
+		/* framerate statistics related fields */
 
+		//bitmask containing combination of STATFLAG_... flags
 		DWORD	dwStatFlags;
-			//bitmask containing combination of STATFLAG_... flags
+		//statistics record period start time
 		DWORD	dwStatTime0;
-			//statistics record period start time
+		//statistics record period end time
 		DWORD	dwStatTime1;
-			//statistics record period end time
+		//total amount of frames rendered during statistics record period
 		DWORD	dwStatFrames;
-			//total amount of frames rendered during statistics record period
-		DWORD	dwStatCount;
-			//amount of min/avg/max measurements during statistics record period 
+		//amount of min/avg/max measurements during statistics record period 
+		DWORD	dwStatCount;		
+		//minimum instantaneous framerate measured during statistics record period 
 		DWORD	dwStatFramerateMin;
-			//minimum instantaneous framerate measured during statistics record period 
+		//average instantaneous framerate measured during statistics record period 
 		DWORD	dwStatFramerateAvg;
-			//average instantaneous framerate measured during statistics record period 
-		DWORD	dwStatFramerateMax;
-			//maximum instantaneous framerate measured during statistics record period 
+		//maximum instantaneous framerate measured during statistics record period 
+		DWORD	dwStatFramerateMax;			
 
-		//OSD related fields
+		/* OSD related fields */
 
+		//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+		//pixel offset from the right side of the screen)
 		DWORD	dwOSDX;
-			//OSD X-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-			//pixel offset from the right side of the screen)
+		//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
+		//pixel offset from the bottom side of the screen)
 		DWORD	dwOSDY;
-			//OSD Y-coordinate (coordinate wrapping is allowed, i.e. -5 defines 5
-			//pixel offset from the bottom side of the screen)
+		//OSD pixel zooming ratio
 		DWORD	dwOSDPixel;
-			//OSD pixel zooming ratio
+		//OSD color in RGB format
 		DWORD	dwOSDColor;
-			//OSD color in RGB format
-		DWORD	dwOSDFrame;
-			//application specific OSD frame ID. Don't change it directly!
-
+		//application specific OSD frame ID. Don't change it directly!
+		DWORD	dwOSDFrame;			
+		// Screen capture flags
 		DWORD	dwScreenCaptureFlags;
+		// Screen capture path
 		char	szScreenCapturePath[MAX_PATH];
 
-		//next fields are valid for v2.1 and newer shared memory format only
-
+		/* the next fields are valid for v2.1 and newer shared memory format only */
+		//OSD background color in RGB format
 		DWORD	dwOSDBgndColor;
-			//OSD background color in RGB format
-
-		//next fields are valid for v2.2 and newer shared memory format only
+			
 
+		/* next fields are valid for v2.2 and newer shared memory format only */
+		// Video capture flags
 		DWORD	dwVideoCaptureFlags;
+		// Video capture path
 		char	szVideoCapturePath[MAX_PATH];
+		// Video capture framerate
 		DWORD	dwVideoFramerate;
+		// Video capture framesize
 		DWORD	dwVideoFramesize;
+		// Video capture format
 		DWORD	dwVideoFormat;
+		// Video capture quality
 		DWORD	dwVideoQuality;
+		// Video capture thread count
 		DWORD	dwVideoCaptureThreads;
 
+		// Screen capture Quality
 		DWORD	dwScreenCaptureQuality;
+		// Screen capture thread count
 		DWORD	dwScreenCaptureThreads;
 
-		//next fields are valid for v2.3 and newer shared memory format only
-
+		/* the next fields are valid for v2.3 and newer shared memory format only */
+		// Audio capture flags
 		DWORD	dwAudioCaptureFlags;
 
-		//next fields are valid for v2.4 and newer shared memory format only
-
+		//next fields are valid for v2.4 and newer shared memory format only */
+		// Video capture extended flags
 		DWORD	dwVideoCaptureFlagsEx;
 
-		//next fields are valid for v2.5 and newer shared memory format only
-
+		/* the next fields are valid for v2.5 and newer shared memory format only */
+		// Audio capture extended flags
 		DWORD	dwAudioCaptureFlags2;
 
+		//minimum instantaneous frametime measured during statistics record period 
 		DWORD	dwStatFrameTimeMin;
+		//average instantaneous frametime measured during statistics record period 
 		DWORD	dwStatFrameTimeAvg;
+		//maximum instantaneous frametime measured during statistics record period 
 		DWORD	dwStatFrameTimeMax;
+		//number of frames measured during statistics record period 
 		DWORD	dwStatFrameTimeCount;
 
+		// Statiscs FrameTime buffer
 		DWORD	dwStatFrameTimeBuf[1024];
+		// Statiscs FrameTime buffer current position
 		DWORD	dwStatFrameTimeBufPos;
+		// Statiscs FrameTime buffer framerate
 		DWORD	dwStatFrameTimeBufFramerate;
 
-		//next fields are valid for v2.6 and newer shared memory format only
+		/* the next fields are valid for v2.6 and newer shared memory format only */
 
+		// Audio capture PTTEvent Push
 		LARGE_INTEGER qwAudioCapturePTTEventPush;
+		// Audio capture PTTEvent Release
 		LARGE_INTEGER qwAudioCapturePTTEventRelease;
-
+		
+		// Audio capture PTTEvent Push2
 		LARGE_INTEGER qwAudioCapturePTTEventPush2;
+		// Audio capture PTTEvent Release2
 		LARGE_INTEGER qwAudioCapturePTTEventRelease2;
 
 	} RTSS_SHARED_MEMORY_APP_ENTRY, *LPRTSS_SHARED_MEMORY_APP_ENTRY;
+#pragma endregion
 
-	RTSS_SHARED_MEMORY_OSD_ENTRY arrOSD[8];
-		//array of OSD slots
-	RTSS_SHARED_MEMORY_APP_ENTRY arrApp[256];
-		//array of application descriptors
-
+	//array of OSD slots
+	RTSS_SHARED_MEMORY_OSD_ENTRY arrOSD[8];	
+	//array of application descriptors
+	RTSS_SHARED_MEMORY_APP_ENTRY arrApp[256];	
+	
 } RTSS_SHARED_MEMORY, *LPRTSS_SHARED_MEMORY;
-/////////////////////////////////////////////////////////////////////////////
+#pragma endregion
+
 #endif //_RTSS_SHARED_MEMORY_INCLUDED_
\ No newline at end of file

 

  ViewVC Help
Powered by ViewVC 1.1.22