ARLib Namespace Reference

The main ARLib namespace. More...

Enumerations
enum	KeyState { KEY_EXTENDED = 1, KEY_CTRL = 2, KEY_SHIFT = 4, KEY_ALT = 8 }
	Values used to determine additional state information of a keyboard action. More...
enum	Mode { MODE_VIDEO = 1, MODE_IMAGE = 2, MODE_SEQUENCE = 3 }
	Values denoting source of images i.e. streaming video or static images. More...
enum	Help { HELP_TEXT = 1, HELP_KEYS = 2, HELP_SWITCHES = 3 }
	Values used to indicate the help elements that should be displayed. More...
enum	Channel {   CHANNEL_ALPHA = 1, CHANNEL_RED = 2, CHANNEL_GREEN = 3, CHANNEL_BLUE = 4,   CHANNEL_RGB = 5 }
	Values used to indicate the various colour channels of a pixel. More...

---

Detailed Description

The main ARLib namespace.

---

Enumeration Type Documentation

enum Channel

Values used to indicate the various colour channels of a pixel. Enumeration values: CHANNEL_ALPHA  = (1) Alpha channel. CHANNEL_RED  = (2) Red channel. CHANNEL_GREEN  = (3) Green channel. CHANNEL_BLUE  = (4) Blue channel. CHANNEL_RGB  = (5) Colour channel.

enum Help

Values used to indicate the help elements that should be displayed. Enumeration values: HELP_TEXT  = (1) Description of the functionality. HELP_KEYS  = (2) List of supported keys. HELP_SWITCHES  = (3) List of additional command-line switches.

enum KeyState

Values used to determine additional state information of a keyboard action. Enumeration values: KEY_EXTENDED  = (1) Key is extended i.e. F1, F2, PAGE_UP etc. KEY_CTRL  = (2) Control key is pressed. KEY_SHIFT  = (4) Shift key is pressed. KEY_ALT  = (8) Alt key is pressed.

enum Mode

Values denoting source of images i.e. streaming video or static images. Enumeration values: MODE_VIDEO  = (1) Images are being streamed from a video source. MODE_IMAGE  = (2) A single image is being displayed. MODE_SEQUENCE  = (3) A sequences of images are being displayed in a loop.

---