Main Page | Directories | File List | Globals | Related Pages

VideoWrapperTypes.h File Reference

Declares types and symbols used by VideoWrapper and VideoWrapper Library Adapters. More...

Go to the source code of this file.

Function Result Codes

VideoWrapper functions return a VWResut indicating the success or failure of the operation.
Successful functions should return VW_SUCCESS (0), while failed functions should return a descriptive error code (>0).

#define VW_SUCCESS   0

The function succeeded.

#define VW_E_ERROR   1

Unspecified error.

#define VW_E_NOT_IMPLEMENTED   100

The function is not implemented.

#define VW_E_INVALID_HANDLE   101

The handle is unknown.

#define VW_E_INVALID_CONFIG_STRING   102

The configuration string is invalid.

#define VW_E_LIB_NOT_LOADED   103

The requested library is not loaded.

#define VW_E_LIB_ALREADY_LOADED   104

The requested library is already loaded.

#define VW_E_LIB_LOAD_FAILED   105

The library failed to load.

#define VW_E_INVALID_CAMERA_ID   106

The camera id specified in the initialization string is not valid.

#define VW_E_MEMORY_ALLOCATION   107

Memory allocation failed.

#define VW_E_CAM_NOT_INITIALIZED   108

The camera has not been initialized.

#define VW_E_STRING_OVERFLOW   109

The string has exceeded its alocated buffer.

#define VW_E_NOT_STARTED   110

The camera has not been started.

#define VW_E_PLAYING   300

Operation can not complete because playback is in progress.

#define VW_E_NOT_PLAYING   301

Operation can not complete because playback is not in progress.

#define VW_E_CAPTURING   302

Operation can not complete because capture is in progress.

#define VW_E_NOT_CAPTURING   303

Operation can not complete because capture is not in progress.

#define VW_E_NO_CAPTURE_DATA   304

No captured data exists.

#define VW_E_CANT_CAPTURE_REPLAY   305

Can not capture a replay camera.

#define VW_E_WRITE_FAILED   400

Failed to write to file.

#define VW_E_READ_FAILED   401

Failed to read from file.

#define VW_E_NOT_REPLAY_CAM   402

The camera is not a replay camera.

#define VW_E_UNSUPPORTED_PROPERTY   500

The camera property is unsupported.

#define VW_E_AUTO_UNSUPPORTED   501

The camera property doesn't support automatic control.

#define VW_E_OUT_OF_RANGE   502

The camera property value is out of range.

#define VW_E_INTERNAL_ERROR   900

An unexpected, internal error has occurred within the API.

#define VW_SUCCEEDED(code)   (code == VW_SUCCESS)

Tests result code for success.

typedef int VWResult

Indicates the success or failure of a VideoWrapper function.

Pixel Formats

These symbols identify the pixel format of a frame buffer.
They mirror the pixel format constants used by OpenGL.

Note:
These identifiers are value-compatible with their OpenGL counterparts shipped with Microsoft Visual Studio 2003. They may not be value-compatible with other implementations.

See also:
VIDEO_getPixelFormat

#define VW_PF_COLOR_INDEX   0x1900

OpenGL compatible pixel format.

#define VW_PF_STENCIL_INDEX   0x1901

OpenGL compatible pixel format.

#define VW_PF_DEPTH_COMPONENT   0x1902

OpenGL compatible pixel format.

#define VW_PF_RED   0x1903

OpenGL compatible pixel format.

#define VW_PF_GREEN   0x1904

OpenGL compatible pixel format.

#define VW_PF_BLUE   0x1905

OpenGL compatible pixel format.

#define VW_PF_ALPHA   0x1906

OpenGL compatible pixel format.

#define VW_PF_RGB   0x1907

OpenGL compatible pixel format.

#define VW_PF_RGBA   0x1908

OpenGL compatible pixel format.

#define VW_PF_LUMINANCE   0x1909

OpenGL compatible pixel format.

#define VW_PF_LUMINANCE_ALPHA   0x190A

OpenGL compatible pixel format.

#define VW_PF_BGR_EXT   0x80E0

OpenGL compatible pixel format.

#define VW_PF_BGRA_EXT   0x80E1

OpenGL compatible pixel format.

typedef int VWPixelFormat

Indicates the success or failure of a VideoWrapper function.

Camera Image Properties

These identifiers may be used to manipulate image properties of the camera.
A given camera is likely to support only a subset of these properties, and some may not not support any at all.

See also:
VIDEO_setPropertyLong
VIDEO_getPropertyLong
VIDEO_setPropertyString
VIDEO_getPropertyString

#define VWCAMPROP_BRIGHTNESS   100

The brightness property of the camera.

#define VWCAMPROP_CONTRAST   101

The contrast property of the camera.

#define VWCAMPROP_HUE   102

The hue property of the camera.

#define VWCAMPROP_SATURATION   103

The saturation property of the camera.

#define VWCAMPROP_SHARPNESS   104

The sharpness property of the camera.

#define VWCAMPROP_GAMMA   105

The gamma property of the camera.

#define VWCAMPROP_COLORENABLE   106

Property to enable color on the camera.

#define VWCAMPROP_WHITEBALANCE   107

The white balance property of the camera.

#define VWCAMPROP_BACKLIGHTCOMPENSATION   108

The backlight compensation property of the camera.

#define VWCAMPROP_GAIN   109

The gain property of the camera.

#define VWCAMPROP_EXPOSURE   110

The exposure property of the camera.

#define VWCAMPROP_IRIS   111

The iris property of the camera.

#define VWCAMPROP_FOCUS   112

The focus property of the camera.

#define VWCAMPROP_ZOOM   113

The zoom property of the camera.

#define VWCAMPROP_PAN   114

The pan property of the camera.

#define VWCAMPROP_TILT   115

The tilt property of the camera.

#define VWCAMPROP_SHUTTER   116

The shutter property of the camera.

#define VWCAMPROP_TRIGGER_DELAY   117

The trigger delay property of the camera.

#define VWCAMPROP_CUSTOM   1000

VWCAMPROP_CUSTOM provides a base value for defining custom properties.

typedef int VWCamProp

Identifies a camera image property.

Defines

#define TRUE   1

TRUE macro definition.

#define FALSE   0

FALSE macro definition.

#define VW_UNLIMITED_BUFFER   -1

Symbol indicating no buffer limits for VIDEO_StartCapture.

Typedefs

typedef int VWBool

Boolean type definition.

typedef unsigned short VWHVideo

Type definition for a handle to a video camera.

typedef unsigned char VWHCamera

Type definition for camera handles.

Detailed Description

Declares types and symbols used by VideoWrapper and VideoWrapper Library Adapters.

Define Documentation

#define FALSE 0

FALSE macro definition.

#define TRUE 1

TRUE macro definition.

#define VWCAMPROP_CUSTOM 1000

VWCAMPROP_CUSTOM provides a base value for defining custom properties.
Custom properties must have a value greater-than-or-equal-to VWCAMPROP_CUSTOM.
Example:
#define MYCUSTOMPROP_FOO VWCAMPROP_CUSTOM + 1 #define MYCUSTOMPROP_BAR VWCAMPROP_CUSTOM + 2

Typedef Documentation

typedef unsigned char VWHCamera

Type definition for camera handles.
Identifies a camera instance within a video wrapper library. When a video wrapper library is wrapped by VideoWrapper, the VWHCamera becomes the HIGHBYTE( bits 8-15) of a VWHVideo.

See also:
VWHVideo

typedef unsigned short VWHVideo

Type definition for a handle to a video camera.
This handle identifies both the library instance and the camera instance within the library. The low byte (bits 0-7) identifies the library. The high byte (bits 8-15) identifies the camera and is passed to the library as a VWHCamera.

See also:
VWHCamera

Generated on Tue Oct 18 12:18:51 2005 for VideoWrapper API by

1.4.1


Function Result Codes
VideoWrapper functions return a VWResut indicating the success or failure of the operation. Successful functions should return VW_SUCCESS (0), while failed functions should return a descriptive error code (>0).
#define	VW_SUCCESS 0
	The function succeeded.
#define	VW_E_ERROR 1
	Unspecified error.
#define	VW_E_NOT_IMPLEMENTED 100
	The function is not implemented.
#define	VW_E_INVALID_HANDLE 101
	The handle is unknown.
#define	VW_E_INVALID_CONFIG_STRING 102
	The configuration string is invalid.
#define	VW_E_LIB_NOT_LOADED 103
	The requested library is not loaded.
#define	VW_E_LIB_ALREADY_LOADED 104
	The requested library is already loaded.
#define	VW_E_LIB_LOAD_FAILED 105
	The library failed to load.
#define	VW_E_INVALID_CAMERA_ID 106
	The camera id specified in the initialization string is not valid.
#define	VW_E_MEMORY_ALLOCATION 107
	Memory allocation failed.
#define	VW_E_CAM_NOT_INITIALIZED 108
	The camera has not been initialized.
#define	VW_E_STRING_OVERFLOW 109
	The string has exceeded its alocated buffer.
#define	VW_E_NOT_STARTED 110
	The camera has not been started.
#define	VW_E_PLAYING 300
	Operation can not complete because playback is in progress.
#define	VW_E_NOT_PLAYING 301
	Operation can not complete because playback is not in progress.
#define	VW_E_CAPTURING 302
	Operation can not complete because capture is in progress.
#define	VW_E_NOT_CAPTURING 303
	Operation can not complete because capture is not in progress.
#define	VW_E_NO_CAPTURE_DATA 304
	No captured data exists.
#define	VW_E_CANT_CAPTURE_REPLAY 305
	Can not capture a replay camera.
#define	VW_E_WRITE_FAILED 400
	Failed to write to file.
#define	VW_E_READ_FAILED 401
	Failed to read from file.
#define	VW_E_NOT_REPLAY_CAM 402
	The camera is not a replay camera.
#define	VW_E_UNSUPPORTED_PROPERTY 500
	The camera property is unsupported.
#define	VW_E_AUTO_UNSUPPORTED 501
	The camera property doesn't support automatic control.
#define	VW_E_OUT_OF_RANGE 502
	The camera property value is out of range.
#define	VW_E_INTERNAL_ERROR 900
	An unexpected, internal error has occurred within the API.
#define	VW_SUCCEEDED(code) (code == VW_SUCCESS)
	Tests result code for success.
typedef int	VWResult
	Indicates the success or failure of a VideoWrapper function.
Pixel Formats
These symbols identify the pixel format of a frame buffer. They mirror the pixel format constants used by OpenGL. Note: These identifiers are value-compatible with their OpenGL counterparts shipped with Microsoft Visual Studio 2003. They may not be value-compatible with other implementations. See also: VIDEO_getPixelFormat
#define	VW_PF_COLOR_INDEX 0x1900
	OpenGL compatible pixel format.
#define	VW_PF_STENCIL_INDEX 0x1901
	OpenGL compatible pixel format.
#define	VW_PF_DEPTH_COMPONENT 0x1902
	OpenGL compatible pixel format.
#define	VW_PF_RED 0x1903
	OpenGL compatible pixel format.
#define	VW_PF_GREEN 0x1904
	OpenGL compatible pixel format.
#define	VW_PF_BLUE 0x1905
	OpenGL compatible pixel format.
#define	VW_PF_ALPHA 0x1906
	OpenGL compatible pixel format.
#define	VW_PF_RGB 0x1907
	OpenGL compatible pixel format.
#define	VW_PF_RGBA 0x1908
	OpenGL compatible pixel format.
#define	VW_PF_LUMINANCE 0x1909
	OpenGL compatible pixel format.
#define	VW_PF_LUMINANCE_ALPHA 0x190A
	OpenGL compatible pixel format.
#define	VW_PF_BGR_EXT 0x80E0
	OpenGL compatible pixel format.
#define	VW_PF_BGRA_EXT 0x80E1
	OpenGL compatible pixel format.
typedef int	VWPixelFormat
	Indicates the success or failure of a VideoWrapper function.
Camera Image Properties
These identifiers may be used to manipulate image properties of the camera. A given camera is likely to support only a subset of these properties, and some may not not support any at all. See also: VIDEO_setPropertyLong VIDEO_getPropertyLong VIDEO_setPropertyString VIDEO_getPropertyString
#define	VWCAMPROP_BRIGHTNESS 100
	The brightness property of the camera.
#define	VWCAMPROP_CONTRAST 101
	The contrast property of the camera.
#define	VWCAMPROP_HUE 102
	The hue property of the camera.
#define	VWCAMPROP_SATURATION 103
	The saturation property of the camera.
#define	VWCAMPROP_SHARPNESS 104
	The sharpness property of the camera.
#define	VWCAMPROP_GAMMA 105
	The gamma property of the camera.
#define	VWCAMPROP_COLORENABLE 106
	Property to enable color on the camera.
#define	VWCAMPROP_WHITEBALANCE 107
	The white balance property of the camera.
#define	VWCAMPROP_BACKLIGHTCOMPENSATION 108
	The backlight compensation property of the camera.
#define	VWCAMPROP_GAIN 109
	The gain property of the camera.
#define	VWCAMPROP_EXPOSURE 110
	The exposure property of the camera.
#define	VWCAMPROP_IRIS 111
	The iris property of the camera.
#define	VWCAMPROP_FOCUS 112
	The focus property of the camera.
#define	VWCAMPROP_ZOOM 113
	The zoom property of the camera.
#define	VWCAMPROP_PAN 114
	The pan property of the camera.
#define	VWCAMPROP_TILT 115
	The tilt property of the camera.
#define	VWCAMPROP_SHUTTER 116
	The shutter property of the camera.
#define	VWCAMPROP_TRIGGER_DELAY 117
	The trigger delay property of the camera.
#define	VWCAMPROP_CUSTOM 1000
	VWCAMPROP_CUSTOM provides a base value for defining custom properties.
typedef int	VWCamProp
	Identifies a camera image property.
Defines
#define	TRUE 1
	TRUE macro definition.
#define	FALSE 0
	FALSE macro definition.
#define	VW_UNLIMITED_BUFFER -1
	Symbol indicating no buffer limits for VIDEO_StartCapture.
Typedefs
typedef int	VWBool
	Boolean type definition.
typedef unsigned short	VWHVideo
	Type definition for a handle to a video camera.
typedef unsigned char	VWHCamera
	Type definition for camera handles.