From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/_n_p_client_8h.html | 1229 ++++++++++++++++++++++++++++++++++ 1 file changed, 1229 insertions(+) create mode 100644 Doc/doxygen/html/_n_p_client_8h.html (limited to 'Doc/doxygen/html/_n_p_client_8h.html') diff --git a/Doc/doxygen/html/_n_p_client_8h.html b/Doc/doxygen/html/_n_p_client_8h.html new file mode 100644 index 0000000..858be42 --- /dev/null +++ b/Doc/doxygen/html/_n_p_client_8h.html @@ -0,0 +1,1229 @@ + + + + + +Starshatter_Open: D:/SRC/StarshatterSVN/Stars45/NPClient.h File Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Classes | +Macros | +Typedefs | +Enumerations | +Functions
+
+
NPClient.h File Reference
+
+
+ +

Go to the source code of this file.

+ + + + +

+Classes

struct  tagTrackIRSignature
struct  tagTrackIRData
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define VERSION_MAJOR   1
#define VERSION_MINOR   0
#define VERSION_BUILD   1
#define lita(arg)   #arg
#define xlita(arg)   lita(arg)
#define cat3(w, x, z)   w##.##x##.##z##\000
#define xcat3(w, x, z)   cat3(w,x,z)
#define VERSION_STRING   xlita(xcat3(VERSION_MAJOR,VERSION_MINOR,VERSION_BUILD))
#define NPQUERYVERSION   1040
#define NPSTATUS_REMOTEACTIVE   0
#define NPSTATUS_REMOTEDISABLED   1
#define NPVERSIONMAJOR   1
#define NPVERSIONMINOR   2
#define NPControl   8
#define NPRoll   1
#define NPPitch   2
#define NPYaw   4
#define NPX   16
#define NPY   32
#define NPZ   64
#define NPRawX   128
#define NPRawY   256
#define NPRawZ   512
#define NPDeltaX   1024
#define NPDeltaY   2048
#define NPDeltaZ   4096
#define NPSmoothX   8192
#define NPSmoothY   16384
#define NPSmoothZ   32768
+ + + + + + + + + + + + + + + + + + + + + +

+Typedefs

typedef enum tagNPResult NPRESULT
typedef struct tagTrackIRSignature SIGNATUREDATA
typedef struct
+tagTrackIRSignature * 		LPTRACKIRSIGNATURE
typedef struct tagTrackIRData TRACKIRDATA
typedef struct tagTrackIRData * LPTRACKIRDATA
typedef NPRESULT(__stdcall * PF_NOTIFYCALLBACK )(unsigned short, unsigned short)
typedef NPRESULT(__stdcall * PF_NP_REGISTERWINDOWHANDLE )(HWND)
typedef NPRESULT(__stdcall * PF_NP_UNREGISTERWINDOWHANDLE )(void)
typedef NPRESULT(__stdcall * PF_NP_REGISTERPROGRAMPROFILEID )(unsigned short)
typedef NPRESULT(__stdcall * PF_NP_QUERYVERSION )(unsigned short *)
typedef NPRESULT(__stdcall * PF_NP_REQUESTDATA )(unsigned short)
typedef NPRESULT(__stdcall * PF_NP_GETSIGNATURE )(LPTRACKIRSIGNATURE)
typedef NPRESULT(__stdcall * PF_NP_GETDATA )(LPTRACKIRDATA)
typedef NPRESULT(__stdcall * PF_NP_REGISTERNOTIFY )(PF_NOTIFYCALLBACK)
typedef NPRESULT(__stdcall * PF_NP_UNREGISTERNOTIFY )(void)
typedef NPRESULT(__stdcall * PF_NP_STARTCURSOR )(void)
typedef NPRESULT(__stdcall * PF_NP_STOPCURSOR )(void)
typedef NPRESULT(__stdcall * PF_NP_RECENTER )(void)
typedef NPRESULT(__stdcall * PF_NP_STARTDATATRANSMISSION )(void)
typedef NPRESULT(__stdcall * PF_NP_STOPDATATRANSMISSION )(void)
+ + +

+Enumerations

enum  tagNPResult {
+  NP_OK = 0, +NP_ERR_DEVICE_NOT_PRESENT, +NP_ERR_UNSUPPORTED_OS, +NP_ERR_INVALID_ARG, +
+  NP_ERR_DLL_NOT_FOUND, +NP_ERR_NO_DATA, +NP_ERR_INTERNAL_DATA +
+ }
+ + + + + + + + + + + + + + + +

+Functions

NPRESULT __stdcall NP_RegisterWindowHandle (HWND hWnd)
NPRESULT __stdcall NP_UnregisterWindowHandle (void)
NPRESULT __stdcall NP_RegisterProgramProfileID (unsigned short wPPID)
NPRESULT __stdcall NP_QueryVersion (unsigned short *pwVersion)
NPRESULT __stdcall NP_RequestData (unsigned short wDataReq)
NPRESULT __stdcall NP_GetSignature (LPTRACKIRSIGNATURE pSignature)
NPRESULT __stdcall NP_GetData (LPTRACKIRDATA pTID)
NPRESULT __stdcall NP_RegisterNotify (PF_NOTIFYCALLBACK pfNotify)
NPRESULT __stdcall NP_UnregisterNotify (void)
NPRESULT __stdcall NP_StartCursor (void)
NPRESULT __stdcall NP_StopCursor (void)
NPRESULT __stdcall NP_ReCenter (void)
NPRESULT __stdcall NP_StartDataTransmission (void)
NPRESULT __stdcall NP_StopDataTransmission (void)
+

Macro Definition Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
#define cat3( w,
 x,
 z 
)   w##.##x##.##z##\000
+
+ +

Definition at line 32 of file NPClient.h.

+ +
+
+ +
+
+ + + + + + + + +
#define lita( arg)   #arg
+
+ +

Definition at line 30 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPControl   8
+
+ +

Definition at line 56 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPDeltaX   1024
+
+ +

Definition at line 75 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPDeltaY   2048
+
+ +

Definition at line 76 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPDeltaZ   4096
+
+ +

Definition at line 77 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPPitch   2
+
+ +

Definition at line 61 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPQUERYVERSION   1040
+
+ +

Definition at line 46 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPRawX   128
+
+ +

Definition at line 70 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPRawY   256
+
+ +

Definition at line 71 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPRawZ   512
+
+ +

Definition at line 72 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPRoll   1
+
+ +

Definition at line 60 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPSmoothX   8192
+
+ +

Definition at line 80 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPSmoothY   16384
+
+ +

Definition at line 81 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPSmoothZ   32768
+
+ +

Definition at line 82 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPSTATUS_REMOTEACTIVE   0
+
+ +

Definition at line 48 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPSTATUS_REMOTEDISABLED   1
+
+ +

Definition at line 49 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPVERSIONMAJOR   1
+
+ +

Definition at line 52 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPVERSIONMINOR   2
+
+ +

Definition at line 53 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPX   16
+
+ +

Definition at line 65 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPY   32
+
+ +

Definition at line 66 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPYaw   4
+
+ +

Definition at line 62 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define NPZ   64
+
+ +

Definition at line 67 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define VERSION_BUILD   1
+
+ +

Definition at line 27 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define VERSION_MAJOR   1
+
+

Defines //////////////////////////////////////////////////////////////////////

+ +

Definition at line 25 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define VERSION_MINOR   0
+
+ +

Definition at line 26 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
#define VERSION_STRING   xlita(xcat3(VERSION_MAJOR,VERSION_MINOR,VERSION_BUILD))
+
+ +

Definition at line 34 of file NPClient.h.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
#define xcat3( w,
 x,
 z 
)   cat3(w,x,z)
+
+ +

Definition at line 33 of file NPClient.h.

+ +
+
+ +
+
+ + + + + + + + +
#define xlita( arg)   lita(arg)
+
+ +

Definition at line 31 of file NPClient.h.

+ +
+
+

Typedef Documentation

+ +
+
+ + + + +
typedef struct tagTrackIRData * LPTRACKIRDATA
+
+ +
+
+ +
+
+ + + + +
typedef struct tagTrackIRSignature * LPTRACKIRSIGNATURE
+
+ +
+
+ +
+
+ + + + +
typedef enum tagNPResult NPRESULT
+
+

Typedefs /////////////////////////////////////////////////////////////////////

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NOTIFYCALLBACK)(unsigned short, unsigned short)
+
+ +

Definition at line 139 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_GETDATA)(LPTRACKIRDATA)
+
+ +

Definition at line 150 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_GETSIGNATURE)(LPTRACKIRSIGNATURE)
+
+ +

Definition at line 149 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_QUERYVERSION)(unsigned short *)
+
+ +

Definition at line 147 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_RECENTER)(void)
+
+ +

Definition at line 155 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_REGISTERNOTIFY)(PF_NOTIFYCALLBACK)
+
+ +

Definition at line 151 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_REGISTERPROGRAMPROFILEID)(unsigned short)
+
+ +

Definition at line 146 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_REGISTERWINDOWHANDLE)(HWND)
+
+ +

Definition at line 144 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_REQUESTDATA)(unsigned short)
+
+ +

Definition at line 148 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_STARTCURSOR)(void)
+
+ +

Definition at line 153 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_STARTDATATRANSMISSION)(void)
+
+ +

Definition at line 156 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_STOPCURSOR)(void)
+
+ +

Definition at line 154 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_STOPDATATRANSMISSION)(void)
+
+ +

Definition at line 157 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_UNREGISTERNOTIFY)(void)
+
+ +

Definition at line 152 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef NPRESULT(__stdcall * PF_NP_UNREGISTERWINDOWHANDLE)(void)
+
+ +

Definition at line 145 of file NPClient.h.

+ +
+
+ +
+
+ + + + +
typedef struct tagTrackIRSignature SIGNATUREDATA
+
+ +
+
+ +
+
+ + + + +
typedef struct tagTrackIRData TRACKIRDATA
+
+ +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum tagNPResult
+
+

Typedefs /////////////////////////////////////////////////////////////////////

+
Enumerator:
+ + + + + + + +
NP_OK  +
NP_ERR_DEVICE_NOT_PRESENT  +
NP_ERR_UNSUPPORTED_OS  +
NP_ERR_INVALID_ARG  +
NP_ERR_DLL_NOT_FOUND  +
NP_ERR_NO_DATA  +
NP_ERR_INTERNAL_DATA  +
+
+
+ +

Definition at line 91 of file NPClient.h.

+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_GetData (LPTRACKIRDATA pTID)
+
+ +

Definition at line 124 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_GetSignature (LPTRACKIRSIGNATURE pSignature)
+
+ +

Definition at line 113 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_QueryVersion (unsigned short * pwVersion)
+
+ +

Definition at line 92 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_ReCenter (void )
+
+ +

Definition at line 157 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_RegisterNotify (PF_NOTIFYCALLBACK pfNotify)
+
+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_RegisterProgramProfileID (unsigned short wPPID)
+
+ +

Definition at line 81 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_RegisterWindowHandle (HWND hWnd)
+
+ +

Definition at line 59 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_RequestData (unsigned short wDataReq)
+
+ +

Definition at line 103 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_StartCursor (void )
+
+ +

Definition at line 135 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_StartDataTransmission (void )
+
+ +

Definition at line 168 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_StopCursor (void )
+
+ +

Definition at line 146 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_StopDataTransmission (void )
+
+ +

Definition at line 179 of file NPClientWraps.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_UnregisterNotify (void )
+
+ +
+
+ +
+
+ + + + + + + + +
NPRESULT __stdcall NP_UnregisterWindowHandle (void )
+
+ +

Definition at line 70 of file NPClientWraps.cpp.

+ +
+
+
+
+ + + + -- cgit v1.1