grab.h File Reference

#include "gui/Gimage.h"
#include "gui/Gpreview.h"
#include "dacs.h"
#include "tools/tools.h"
#include "plugin.h"

Go to the source code of this file.

Data Structures
struct	grabImageData
struct	grabParameter

Macros
#define	IW_DACSNAME   "icewing"
#define	IW_PAL_WIDTH   768
#define	IW_PAL_HEIGHT   576
#define	IW_OUTPUT_NONE   0
#define	IW_OUTPUT_FUNCTION   (1<<0)
#define	IW_OUTPUT_STREAM   (1<<1)
#define	IW_OUTPUT_STATUS   (1<<2)
#define	IW_GRAB_IDENT   "image"
#define	IW_GRAB_RGB_IDENT   "imageRGB"
#define	iw_grab_protos_H

Typedefs
typedef struct grabImageData	grabImageData
typedef struct grabParameter	grabParameter

Functions
prevBuffer *	grab_get_inputBuf (void)
void	grab_image_free (grabImageData *img)
grabImageData *	grab_image_new (void)
grabImageData *	grab_image_duplicate (const grabImageData *img)
grabImageData *	grab_get_image (int img_num, const struct timeval *time)
grabImageData *	grab_get_image_from_plug (plugDefinition *plug, int img_num, const struct timeval *time)
void	grab_release_image (const grabImageData *img)
void	grab_release_image_from_plug (plugDefinition *plug, const grabImageData *img)

---

Macro Definition Documentation

#define IW_DACSNAME   "icewing"

Default DACS name

#define IW_PAL_WIDTH   768

Used as a source for the default preview window size

#define IW_PAL_HEIGHT   576

#define IW_OUTPUT_NONE   0

#define IW_OUTPUT_FUNCTION   (1<<0)

#define IW_OUTPUT_STREAM   (1<<1)

#define IW_OUTPUT_STATUS   (1<<2)

#define IW_GRAB_IDENT   "image"

#define IW_GRAB_RGB_IDENT   "imageRGB"

#define iw_grab_protos_H

---

Typedef Documentation

typedef struct grabImageData grabImageData

Type of the data the grabbing plugin is providing for other plugins under the identifiers "image" and "imageRGB"

typedef struct grabParameter grabParameter

---

Function Documentation

prevBuffer* grab_get_inputBuf

(

void

)

  The iceWing mainloop creates one preview window, where e.g. the grab
  plugin displays the first image. Return a pointer to this window,
  so that other plugins can display additional data in this window.

void grab_image_free

(

grabImageData *

img

)

  Free img including all substructures.

grabImageData* grab_image_new

(

void

)

  Allocate a new image and init everything. -> Do NOT allocate any
  image data.

grabImageData* grab_image_duplicate

(

const grabImageData *

img

)

  Return a deep copy of img.

grabImageData* grab_get_image	(	int	img_num,
		const struct timeval *	time
	)

  Return the grabbed image with
    time!=NULL: a grab-time most similar to time
    time==NULL: number img_num (0: last grabbed image) if still in
                memory or NULL otherwise.
    img_num<=0: return a full size image, if available
  grab_get_image(): Use the first registered grabbing plugin.

grabImageData* grab_get_image_from_plug	(	plugDefinition *	plug,
		int	img_num,
		const struct timeval *	time
	)

void grab_release_image

(

const grabImageData *

img

)

  Indicate that the img obtained with grab_get_image() is not needed
  any longer.
  grab_release_image(): Use the first registered grabbing plugin.

void grab_release_image_from_plug	(	plugDefinition *	plug,
		const grabImageData *	img
	)