AURobotServers  4
Public Attributes | List of all members
freenect_frame_mode Struct Reference

#include <libfreenect.h>

Public Attributes

union {
   freenect_depth_format   depth_format
 
   int32_t   dummy
 
   freenect_video_format   video_format
 
}; 
 
int32_t bytes
 
int8_t data_bits_per_pixel
 
int8_t framerate
 
int16_t height
 
int8_t is_valid
 
int8_t padding_bits_per_pixel
 
uint32_t reserved
 
freenect_resolution resolution
 
int16_t width
 

Detailed Description

Structure to give information about the width, height, bitrate, framerate, and buffer size of a frame in a particular mode, as well as the total number of bytes needed to hold a single frame.

Member Data Documentation

union { ... }

The video or depth format that this freenect_frame_mode describes. The caller should know which of video_format or depth_format to use, since they called freenect_get_*_frame_mode()

int32_t freenect_frame_mode::bytes

Total buffer size in bytes to hold a single frame of data. Should be equivalent to width * height * (data_bits_per_pixel+padding_bits_per_pixel) / 8

Referenced by freenect_start_depth(), and freenect_start_video().

int8_t freenect_frame_mode::data_bits_per_pixel

Number of bits of information needed for each pixel

freenect_depth_format freenect_frame_mode::depth_format
int32_t freenect_frame_mode::dummy
int8_t freenect_frame_mode::framerate

Approximate expected frame rate, in Hz

Referenced by freenect_fetch_reg_const_shift(), freenect_fetch_reg_info(), and freenect_fetch_reg_pad_info().

int16_t freenect_frame_mode::height

Height of the frame, in pixels

Referenced by convert_bayer_to_rgb(), convert_uyvy_to_rgb(), and video_process().

int8_t freenect_frame_mode::is_valid

If 0, this freenect_frame_mode is invalid and does not describe a supported mode. Otherwise, the frame_mode is valid.

Referenced by freenect_find_depth_mode(), freenect_find_video_mode(), freenect_get_depth_mode(), and freenect_get_video_mode().

int8_t freenect_frame_mode::padding_bits_per_pixel

Number of bits of padding for alignment used for each pixel

uint32_t freenect_frame_mode::reserved

unique ID used internally. The meaning of values may change without notice. Don't touch or depend on the contents of this field. We mean it.

Referenced by freenect_set_depth_mode(), and freenect_set_video_mode().

freenect_resolution freenect_frame_mode::resolution

Resolution this freenect_frame_mode describes, should you want to find it again with freenect_find_*_frame_mode().

Referenced by freenect_fetch_reg_const_shift(), freenect_fetch_reg_info(), and freenect_fetch_reg_pad_info().

freenect_video_format freenect_frame_mode::video_format
int16_t freenect_frame_mode::width

Width of the frame, in pixels

Referenced by convert_bayer_to_rgb(), convert_uyvy_to_rgb(), and video_process().


The documentation for this struct was generated from the following file: