Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoVideoMsg Class Reference

Description

Represents a data message containing a video image.

Inherits kObject.

Public Member Functions

kSize GoVideoMsg_CameraIndex (GoVideoMsg msg)
 Gets the camera index that the video data originates from. More...
 
kCfa GoVideoMsg_Cfa (GoVideoMsg msg)
 Gets the image color filter array. More...
 
k32u GoVideoMsg_Exposure (GoVideoMsg msg)
 Gets the exposure. More...
 
kSize GoVideoMsg_ExposureIndex (GoVideoMsg msg)
 Gets the exposure index. More...
 
kSize GoVideoMsg_Height (GoVideoMsg msg)
 Gets the image height, in pixels. More...
 
kPixelFormat GoVideoMsg_PixelFormat (GoVideoMsg msg)
 Gets the pixel format descriptor. More...
 
kSize GoVideoMsg_PixelSize (GoVideoMsg msg)
 Gets the image pixel size, in bytes. More...
 
kType GoVideoMsg_PixelType (GoVideoMsg msg)
 Gets the data type used to represent an image pixel. More...
 
void * GoVideoMsg_RowAt (GoVideoMsg msg, kSize rowIndex)
 Gets a pointer to a row within the image. More...
 
GoDataSource GoVideoMsg_Source (GoVideoMsg msg)
 Gets the video source. More...
 
kSize GoVideoMsg_Width (GoVideoMsg msg)
 Gets the image width, in pixels. More...
 

Member Function Documentation

kSize GoVideoMsg_CameraIndex ( GoVideoMsg  msg)

Gets the camera index that the video data originates from.

Parameters
msgMessage object.
Returns
Camera index.
kCfa GoVideoMsg_Cfa ( GoVideoMsg  msg)

Gets the image color filter array.

Parameters
msgMessage object.
Returns
Color filter array.
k32u GoVideoMsg_Exposure ( GoVideoMsg  msg)

Gets the exposure.

Parameters
msgMessage object.
Returns
Exposure in uS.
kSize GoVideoMsg_ExposureIndex ( GoVideoMsg  msg)

Gets the exposure index.

Parameters
msgMessage object.
Returns
Exposure index.
kSize GoVideoMsg_Height ( GoVideoMsg  msg)

Gets the image height, in pixels.

Parameters
msgMessage object.
Returns
Image height, in pixels.
kPixelFormat GoVideoMsg_PixelFormat ( GoVideoMsg  msg)

Gets the pixel format descriptor.

Parameters
msgMessage object.
Returns
Pixel format.
kSize GoVideoMsg_PixelSize ( GoVideoMsg  msg)

Gets the image pixel size, in bytes.

Parameters
msgMessage object.
Returns
Pixel size, in bytes.
kType GoVideoMsg_PixelType ( GoVideoMsg  msg)

Gets the data type used to represent an image pixel.

Parameters
msgMessage object.
Returns
Pixel size, in bytes.
void * GoVideoMsg_RowAt ( GoVideoMsg  msg,
kSize  rowIndex 
)

Gets a pointer to a row within the image.

Parameters
msgMessage object.
rowIndexRow index.
Returns
Row pointer.
GoDataSource GoVideoMsg_Source ( GoVideoMsg  msg)

Gets the video source.

Parameters
msgMessage object.
Returns
Video source.
kSize GoVideoMsg_Width ( GoVideoMsg  msg)

Gets the image width, in pixels.

Parameters
msgMessage object.
Returns
Image width, in pixels.

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