CamIL_Image Class Reference

Represents an image retrieved from the camera. More...

#import <CamIL_Image.h>

Inherits NSObject.

Instance Methods
(id)	- initWithWidth:andHeight:andPredefinedFormat:andData:
	Initializes the CamIL Image;.
(int)	- GetPlaneCount
	Retrieve the plane count from the image.
(CamIL_Plane *)	- getPlaneAt:
	Retrived the plane at the designated index.

Detailed Description

Represents an image retrieved from the camera.

Method Documentation

getPlaneAt:

- (CamIL_Plane *) getPlaneAt:

(int)

index

Retrived the plane at the designated index.

Parameters

index

index for retrieving the plane, valid values are from 0 to [img GetPlaneCount] - 1.

Returns

The plane at the provided index

GetPlaneCount

- (int) GetPlaneCount

Retrieve the plane count from the image.

Returns

The number of planes stored inside the image

initWithWidth:andHeight:andPredefinedFormat:andData:

- (id) initWithWidth:		(int)	width
andHeight:		(int)	height
andPredefinedFormat:		(Format)	format
andData:		(void **)	data

Initializes the CamIL Image;.

Parameters

width	width of the image
width	height of the image
format	the format of the image, bytes per pixel is infered from the format
data	the data pointer to the plains representing the image, for interleaved images like RGB or BGRA it should be a single plane. YUV formats are represented using multiple planes.

Returns

the id representing the object