include/Nex/NexCommon.h File Reference

Header for common data structures and definitions. More...

Go to the source code of this file.

Classes
struct	NexEvent
	Structure describing a generic event. Use the NexEventType to determine event data format. More...
struct	NexMouseInfo
	Structure representing a mouse's information. More...
struct	NexKeyboardInfo
	Structure representing a keyboard's information. More...
Defines
#define	NEX_NAME_MAX   128
	Maximum size of a buffer containing a user-friendly, displayable name for a device.
Enumerations
enum	NexErrorCode {   NEX_OK, NEX_DEVICEINUSE, NEX_DEVICEUNPLUGGED, NEX_DEVICELOST,   NEX_OUTOFMEMORY, NEX_UNKNOWNERROR, NEX_INVALIDPARAM, NEX_INVALIDSTATE }
	Enumeration describing the error codes used throughout Nex. More...
enum	NexDeviceType { NEXDEV_MOUSE, NEXDEV_KEYBOARD, NEXDEV_MAX }
	Enumeration describing different types of devices. More...
enum	NexEventType {   NEXEVENT_MOUSEMOVE, NEXEVENT_BUTTONDOWN, NEXEVENT_BUTTONUP, NEXEVENT_WHEEL,   NEXEVENT_KEYDOWN, NEXEVENT_KEYUP, NEXEVENT_UNPLUGGED, NEXEVENT_REPLUGGED,   NEXEVENT_MAX }
	Enumeration describing different types of devies a device may generate. More...

---

Detailed Description

Header for common data structures and definitions.

---

Define Documentation

#define NEX_NAME_MAX   128

Maximum size of a buffer containing a user-friendly, displayable name for a device.

---

Enumeration Type Documentation

enum NexDeviceType

Enumeration describing different types of devices.

Enumerator:

NEXDEV_MOUSE
NEXDEV_KEYBOARD
NEXDEV_MAX

{
        NEXDEV_MOUSE,
        NEXDEV_KEYBOARD,
        NEXDEV_MAX
};

enum NexErrorCode

Enumeration describing the error codes used throughout Nex.

Enumerator:

NEX_OK	The operation was successful.
NEX_DEVICEINUSE	The device is already in use.
NEX_DEVICEUNPLUGGED	The input device was unplugged.
NEX_DEVICELOST	Lost software focus or grab.
NEX_OUTOFMEMORY	Out of memory.
NEX_UNKNOWNERROR	Unknown error occured.
NEX_INVALIDPARAM	Invalid parameter was given.
NEX_INVALIDSTATE	This function may not be called in this state.

{
        NEX_OK,                
        NEX_DEVICEINUSE,       
        NEX_DEVICEUNPLUGGED,   
        NEX_DEVICELOST,        
        NEX_OUTOFMEMORY,       
        NEX_UNKNOWNERROR,      
        NEX_INVALIDPARAM,      
        NEX_INVALIDSTATE       
};

enum NexEventType

Enumeration describing different types of devies a device may generate.

Enumerator:

NEXEVENT_MOUSEMOVE	The mouse has moved. Data: delta X, delta Y.
NEXEVENT_BUTTONDOWN	A mouse button has gone down. Data: One of the NEXMB_XXXX constants.
NEXEVENT_BUTTONUP	A mouse button has gone up. Data: One of the NEXMB_XXXX constants.
NEXEVENT_WHEEL	The mouse wheel has moved. Data: delta wheel motion.
NEXEVENT_KEYDOWN	A key is down. Data: virtual key code, character code (if any)
NEXEVENT_KEYUP	A key is up. Data: virtual key code, character code (if any)
NEXEVENT_UNPLUGGED	The device has been unplugged. Data: (none)
NEXEVENT_REPLUGGED	The device has been reattached. Data: (none)
NEXEVENT_MAX	Invalid value, constant defining number of events.

{
        NEXEVENT_MOUSEMOVE,             
        NEXEVENT_BUTTONDOWN,    
        NEXEVENT_BUTTONUP,              
        NEXEVENT_WHEEL,                 
        NEXEVENT_KEYDOWN,               
        NEXEVENT_KEYUP,                 
        NEXEVENT_UNPLUGGED,             
        NEXEVENT_REPLUGGED,             
        NEXEVENT_MAX                    
};