grab_prop.h File Reference

#include "tools/tools.h"

Go to the source code of this file.

Data Structures
struct	iwGrabPropertyEnum
struct	iwGrabProperty

Macros
#define	IW_GRAB_IDENT_PROPERTIES   "setProperties"

Typedefs
typedef struct plugDefinition	_plugDefinition
typedef iwGrabStatus(*	iwGrabPropertiesFunc )(_plugDefinition *plug_d,...)

Enumerations
enum	iwGrabControl {   IW_GRAB_LAST = 0, IW_GRAB_SET_ROI, IW_GRAB_GET_PROP, IW_GRAB_GET_PROPVALUES,   IW_GRAB_SET_PROP }
enum	iwGrabStatus {   IW_GRAB_STATUS_OK = 0, IW_GRAB_STATUS_UNSUPPORTED = -1, IW_GRAB_STATUS_ERR = -2, IW_GRAB_STATUS_NOTOPEN = -3,   IW_GRAB_STATUS_ARGUMENT = -4 }
enum	iwGrabPropertyType {   IW_GRAB_CATEGORY, IW_GRAB_COMMAND, IW_GRAB_BOOL, IW_GRAB_INT,   IW_GRAB_DOUBLE, IW_GRAB_ENUM, IW_GRAB_STRING }
enum	iwGrabPropertyFlags { IW_GRAB_READONLY }

---

Macro Definition Documentation

#define IW_GRAB_IDENT_PROPERTIES   "setProperties"

Ident of the function for setting grabbing properties

---

Typedef Documentation

typedef struct plugDefinition _plugDefinition

To prevent inclusion of "plugin.h"

typedef iwGrabStatus(* iwGrabPropertiesFunc)(_plugDefinition *plug_d,...)

---

Enumeration Type Documentation

enum iwGrabControl

Possible values for the iwGrabPropertiesFunc()

Enumerator:

IW_GRAB_LAST	Must be given as last argument to finalize the argument list
IW_GRAB_SET_ROI	Args: int x, int y, int width, int height Set ROI. If a value is -1, the current value is not changed.
IW_GRAB_GET_PROP	Args: iwGrabProperty **prop Get an array of all properties, finished with (*prop)[last].name == NULL
IW_GRAB_GET_PROPVALUES	Args: iwGrabProperty **prop Get an array of all properties and reacquire there values. The array is finished with (*prop)[last].name == NULL
IW_GRAB_SET_PROP	Args: char *propvals Set properties to new values, argument format: 'propX=val:propY=val:...'

enum iwGrabStatus

Possible results for setting grabbing properties

Enumerator:

IW_GRAB_STATUS_OK
IW_GRAB_STATUS_UNSUPPORTED	Unsupported property
IW_GRAB_STATUS_ERR	Another error
IW_GRAB_STATUS_NOTOPEN	No grabbing device is open
IW_GRAB_STATUS_ARGUMENT	Invalid argument

enum iwGrabPropertyType

Type of the property, which is stored in iwGrabProperty

Enumerator:

IW_GRAB_CATEGORY	Arranging the props in a tree structure. A sub tree is finished if name starts with '<'.
IW_GRAB_COMMAND
IW_GRAB_BOOL
IW_GRAB_INT
IW_GRAB_DOUBLE
IW_GRAB_ENUM
IW_GRAB_STRING

enum iwGrabPropertyFlags

Characteristics of properties

Enumerator:

IW_GRAB_READONLY

Property is read only