libfreenect.h File Reference

#include <stdint.h>
#include <libusb-1.0/libusb.h>
Include dependency graph for libfreenect.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  freenect_raw_device_state

Defines

#define FREENECT_BAYER_SIZE   (FREENECT_FRAME_PIX)
#define FREENECT_COUNTS_PER_G   819
#define FREENECT_DEPTH_SIZE   (FREENECT_FRAME_PIX*sizeof(freenect_depth))
#define FREENECT_FRAME_H   480
#define FREENECT_FRAME_PIX   (FREENECT_FRAME_H*FREENECT_FRAME_W)
#define FREENECT_FRAME_W   640
#define FREENECT_RGB_SIZE   (FREENECT_FRAME_PIX*3)

Typedefs

typedef struct _freenect_context freenect_context
typedef uint16_t freenect_depth
typedef void(* freenect_depth_cb )(freenect_device *dev, void *depth, uint32_t timestamp)
typedef struct _freenect_device freenect_device
typedef void(* freenect_ir_cb )(freenect_device *dev, freenect_pixel_ir *rgb, uint32_t timestamp)
typedef void(* freenect_log_cb )(freenect_context *dev, freenect_loglevel level, const char *msg)
typedef uint8_t freenect_packed_depth
typedef uint8_t freenect_pixel
typedef uint16_t freenect_pixel_ir
typedef void(* freenect_rgb_cb )(freenect_device *dev, freenect_pixel *rgb, uint32_t timestamp)
typedef libusb_context freenect_usb_context

Enumerations

enum  freenect_depth_format { FREENECT_FORMAT_11_BIT = 0, FREENECT_FORMAT_10_BIT = 1, FREENECT_FORMAT_PACKED_11_BIT = 2, FREENECT_FORMAT_PACKED_10_BIT = 3 }
enum  freenect_led_options {
  LED_OFF = 0, LED_GREEN = 1, LED_RED = 2, LED_YELLOW = 3,
  LED_BLINK_YELLOW = 4, LED_BLINK_GREEN = 5, LED_BLINK_RED_YELLOW = 6
}
enum  freenect_loglevel {
  FREENECT_LOG_FATAL = 0, FREENECT_LOG_ERROR, FREENECT_LOG_WARNING, FREENECT_LOG_NOTICE,
  FREENECT_LOG_INFO, FREENECT_LOG_DEBUG, FREENECT_LOG_SPEW, FREENECT_LOG_FLOOD
}
enum  freenect_rgb_format { FREENECT_FORMAT_RGB = 0, FREENECT_FORMAT_BAYER = 1, FREENECT_FORMAT_IR = 2 }
enum  freenect_tilt_status_code { TILT_STATUS_STOPPED = 0x00, TILT_STATUS_LIMIT = 0x01, TILT_STATUS_MOVING = 0x04 }

Functions

int freenect_close_device (freenect_device *dev)
 Close the given device.
freenect_raw_device_statefreenect_get_device_state (freenect_device *dev)
void freenect_get_mks_accel (freenect_raw_device_state *state, double *x, double *y, double *z)
double freenect_get_tilt_degs (freenect_raw_device_state *state)
void * freenect_get_user (freenect_device *dev)
int freenect_init (freenect_context **ctx, freenect_usb_context *usb_ctx)
int freenect_num_devices (freenect_context *ctx)
 Get the list of devices for the current Freenect context. The method returns only the devices that satisfy the vendor ID (0x45e) and product ID (0x02ae).
int freenect_open_device (freenect_context *ctx, freenect_device **dev, int index)
 Open a device in the current Freenect context using a given index.
int freenect_process_events (freenect_context *ctx)
void freenect_set_depth_callback (freenect_device *dev, freenect_depth_cb cb)
int freenect_set_depth_format (freenect_device *dev, freenect_depth_format fmt)
void freenect_set_ir_callback (freenect_device *dev, freenect_ir_cb cb)
int freenect_set_led (freenect_device *dev, freenect_led_options option)
void freenect_set_log_callback (freenect_context *ctx, freenect_log_cb cb)
void freenect_set_log_level (freenect_context *ctx, freenect_loglevel level)
void freenect_set_rgb_callback (freenect_device *dev, freenect_rgb_cb cb)
int freenect_set_rgb_format (freenect_device *dev, freenect_rgb_format fmt)
int freenect_set_tilt_degs (freenect_device *dev, double angle)
void freenect_set_user (freenect_device *dev, void *user)
int freenect_shutdown (freenect_context *ctx)
 Shutdown the given Freenect context.
int freenect_start_depth (freenect_device *dev)
 Start the RGB stream acquisition for the given Freenect device.
int freenect_start_ir (freenect_device *dev)
 Start the IR stream acquisition for the given Freenect device.
int freenect_start_rgb (freenect_device *dev)
 Start the RGB stream acquisition for the given Freenect device.
int freenect_stop_depth (freenect_device *dev)
 Stop the depth stream for the given Freenect device.
int freenect_stop_ir (freenect_device *dev)
 Stop the IR stream for the given Freenect device.
int freenect_stop_rgb (freenect_device *dev)
 Stop the RGB stream for the given Freenect device.
int freenect_update_device_state (freenect_device *dev)

Define Documentation

#define FREENECT_BAYER_SIZE   (FREENECT_FRAME_PIX)

Definition at line 45 of file libfreenect.h.

#define FREENECT_COUNTS_PER_G   819

Definition at line 47 of file libfreenect.h.

#define FREENECT_DEPTH_SIZE   (FREENECT_FRAME_PIX*sizeof(freenect_depth))

Definition at line 46 of file libfreenect.h.

#define FREENECT_FRAME_H   480

Definition at line 42 of file libfreenect.h.

#define FREENECT_FRAME_PIX   (FREENECT_FRAME_H*FREENECT_FRAME_W)

Definition at line 43 of file libfreenect.h.

#define FREENECT_FRAME_W   640

Definition at line 41 of file libfreenect.h.

#define FREENECT_RGB_SIZE   (FREENECT_FRAME_PIX*3)

Definition at line 44 of file libfreenect.h.


Typedef Documentation

Definition at line 87 of file libfreenect.h.

typedef uint16_t freenect_depth

Definition at line 36 of file libfreenect.h.

typedef void(* freenect_depth_cb)(freenect_device *dev, void *depth, uint32_t timestamp)

Definition at line 125 of file libfreenect.h.

Definition at line 90 of file libfreenect.h.

typedef void(* freenect_ir_cb)(freenect_device *dev, freenect_pixel_ir *rgb, uint32_t timestamp)

Definition at line 127 of file libfreenect.h.

typedef void(* freenect_log_cb)(freenect_context *dev, freenect_loglevel level, const char *msg)

Definition at line 111 of file libfreenect.h.

typedef uint8_t freenect_packed_depth

Definition at line 37 of file libfreenect.h.

typedef uint8_t freenect_pixel

Definition at line 38 of file libfreenect.h.

typedef uint16_t freenect_pixel_ir

Definition at line 39 of file libfreenect.h.

typedef void(* freenect_rgb_cb)(freenect_device *dev, freenect_pixel *rgb, uint32_t timestamp)

Definition at line 126 of file libfreenect.h.

typedef libusb_context freenect_usb_context

Definition at line 94 of file libfreenect.h.


Enumeration Type Documentation

Enumerator:
FREENECT_FORMAT_11_BIT 
FREENECT_FORMAT_10_BIT 
FREENECT_FORMAT_PACKED_11_BIT 
FREENECT_FORMAT_PACKED_10_BIT 

Definition at line 65 of file libfreenect.h.

Enumerator:
LED_OFF 
LED_GREEN 
LED_RED 
LED_YELLOW 
LED_BLINK_YELLOW 
LED_BLINK_GREEN 
LED_BLINK_RED_YELLOW 

Definition at line 55 of file libfreenect.h.

Enumerator:
FREENECT_LOG_FATAL 
FREENECT_LOG_ERROR 
FREENECT_LOG_WARNING 
FREENECT_LOG_NOTICE 
FREENECT_LOG_INFO 
FREENECT_LOG_DEBUG 
FREENECT_LOG_SPEW 
FREENECT_LOG_FLOOD 

Definition at line 97 of file libfreenect.h.

Enumerator:
FREENECT_FORMAT_RGB 
FREENECT_FORMAT_BAYER 
FREENECT_FORMAT_IR 

Definition at line 49 of file libfreenect.h.

Enumerator:
TILT_STATUS_STOPPED 
TILT_STATUS_LIMIT 
TILT_STATUS_MOVING 

Definition at line 72 of file libfreenect.h.


Function Documentation

int freenect_close_device ( freenect_device dev  ) 

Close the given device.

Definition at line 117 of file core.c.

freenect_raw_device_state* freenect_get_device_state ( freenect_device dev  ) 

Definition at line 166 of file core.c.

void freenect_get_mks_accel ( freenect_raw_device_state state,
double *  x,
double *  y,
double *  z 
)

Definition at line 37 of file accel.c.

double freenect_get_tilt_degs ( freenect_raw_device_state state  ) 

Definition at line 62 of file tilt.c.

void* freenect_get_user ( freenect_device dev  ) 

Definition at line 128 of file core.c.

int freenect_init ( freenect_context **  ctx,
freenect_usb_context usb_ctx 
)

Definition at line 35 of file core.c.

int freenect_num_devices ( freenect_context ctx  ) 

Get the list of devices for the current Freenect context. The method returns only the devices that satisfy the vendor ID (0x45e) and product ID (0x02ae).

Definition at line 64 of file core.c.

int freenect_open_device ( freenect_context ctx,
freenect_device **  dev,
int  index 
)

Open a device in the current Freenect context using a given index.

Definition at line 90 of file core.c.

int freenect_process_events ( freenect_context ctx  ) 

Definition at line 55 of file core.c.

void freenect_set_depth_callback ( freenect_device dev,
freenect_depth_cb  cb 
)

Definition at line 648 of file cameras.c.

int freenect_set_depth_format ( freenect_device dev,
freenect_depth_format  fmt 
)

Definition at line 673 of file cameras.c.

void freenect_set_ir_callback ( freenect_device dev,
freenect_ir_cb  cb 
)

Definition at line 660 of file cameras.c.

int freenect_set_led ( freenect_device dev,
freenect_led_options  option 
)

Definition at line 54 of file tilt.c.

void freenect_set_log_callback ( freenect_context ctx,
freenect_log_cb  cb 
)

Definition at line 138 of file core.c.

void freenect_set_log_level ( freenect_context ctx,
freenect_loglevel  level 
)

Definition at line 133 of file core.c.

void freenect_set_rgb_callback ( freenect_device dev,
freenect_rgb_cb  cb 
)

Definition at line 654 of file cameras.c.

int freenect_set_rgb_format ( freenect_device dev,
freenect_rgb_format  fmt 
)

Definition at line 666 of file cameras.c.

int freenect_set_tilt_degs ( freenect_device dev,
double  angle 
)

Definition at line 42 of file tilt.c.

void freenect_set_user ( freenect_device dev,
void *  user 
)

Definition at line 123 of file core.c.

int freenect_shutdown ( freenect_context ctx  ) 

Shutdown the given Freenect context.

Definition at line 49 of file core.c.

int freenect_start_depth ( freenect_device dev  ) 

Start the RGB stream acquisition for the given Freenect device.

Definition at line 457 of file cameras.c.

int freenect_start_ir ( freenect_device dev  ) 

Start the IR stream acquisition for the given Freenect device.

Definition at line 541 of file cameras.c.

int freenect_start_rgb ( freenect_device dev  ) 

Start the RGB stream acquisition for the given Freenect device.

Definition at line 502 of file cameras.c.

int freenect_stop_depth ( freenect_device dev  ) 

Stop the depth stream for the given Freenect device.

Definition at line 580 of file cameras.c.

int freenect_stop_ir ( freenect_device dev  ) 

Stop the IR stream for the given Freenect device.

Definition at line 626 of file cameras.c.

int freenect_stop_rgb ( freenect_device dev  ) 

Stop the RGB stream for the given Freenect device.

Definition at line 603 of file cameras.c.

int freenect_update_device_state ( freenect_device dev  ) 

Definition at line 171 of file core.c.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


freenect
Author(s): Ivan Dryanovski
autogenerated on Fri Jan 11 09:12:32 2013