urbi::UImage Class Reference

Class encapsulating an image. More...

#include <uimage.hh>

Collaboration diagram for urbi::UImage:

List of all members.

Public Member Functions
void	init ()
	Initialize.
const char *	format_string () const
	Return a legible definition of imageFormat.
Static Public Member Functions
static UImage	make ()
	Return an empty UImage.
Public Attributes
unsigned char *	data
	Pointer to image data.
size_t	size
	Image size in byte.
size_t	width
	Dimensions of the image.
size_t	height
UImageFormat	imageFormat
Private Member Functions
std::string	headers_ () const
Friends
class	UBinary

---

Detailed Description

Class encapsulating an image.

This class does not handle its memory: the data field msut be freed manualy.

Definition at line 58 of file uimage.hh.

---

Member Function Documentation

const char * urbi::UImage::format_string

(

)

const

Return a legible definition of imageFormat.

Definition at line 87 of file uimage.cc.

References imageFormat.

Referenced by headers_().

std::string urbi::UImage::headers_

(

)

const [private]

Definition at line 93 of file uimage.cc.

References format_string(), height, and width.

Referenced by urbi::UBinary::getMessage().

void urbi::UImage::init

(

)

Initialize.

Not a constructor so that we can still put it in a union.

Definition at line 71 of file uimage.cc.

References data, height, urbi::IMAGE_UNKNOWN, imageFormat, size, and width.

Referenced by make().

UImage urbi::UImage::make

(

)

[static]

Return an empty UImage.

Not a constructor so that we can still put it in a union.

Definition at line 79 of file uimage.cc.

References init().

Referenced by urbi::UValue::operator UImage().

---

Friends And Related Function Documentation

friend class UBinary [friend]

Definition at line 82 of file uimage.hh.

---

Member Data Documentation

unsigned char* urbi::UImage::data

Pointer to image data.

Definition at line 73 of file uimage.hh.

Referenced by init(), urbi::USyncClient::syncGetImage(), and urbi::UBinary::UBinary().

size_t urbi::UImage::height

Definition at line 77 of file uimage.hh.

Referenced by headers_(), init(), urbi::UBinary::parse(), and urbi::USyncClient::syncGetImage().

UImageFormat urbi::UImage::imageFormat

Definition at line 79 of file uimage.hh.

Referenced by format_string(), init(), urbi::UBinary::parse(), and urbi::USyncClient::syncGetImage().

size_t urbi::UImage::size

Image size in byte.

Definition at line 75 of file uimage.hh.

Referenced by init(), urbi::UBinary::parse(), urbi::USyncClient::syncGetImage(), and urbi::UBinary::UBinary().

size_t urbi::UImage::width

Dimensions of the image.

Definition at line 77 of file uimage.hh.

Referenced by headers_(), init(), urbi::UBinary::parse(), and urbi::USyncClient::syncGetImage().

---

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

• uimage.hh
• uimage.cc