Public Attributes

freenect_frame_mode Struct Reference

#include <libfreenect.h>

List of all members.

Public Attributes

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

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()

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

Number of bits of information needed for each pixel

Approximate expected frame rate, in Hz

Height of the frame, in pixels

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

Number of bits of padding for alignment used for each pixel

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.

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

Width of the frame, in pixels


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