KFbxThumbnail Class Reference

#include <kfbxthumbnail.h>

Inherits KFbxObject.

Inheritance diagram for KFbxThumbnail:

List of all members.

---

Detailed Description

Simple class to hold RGBA values of a thumbnail image.

Definition at line 58 of file kfbxthumbnail.h.

Thumbnail properties
enum	EDataFormat
	Data format. More...
enum	EImageSize
	Data format. More...
void	SetDataFormat (EDataFormat pDataFormat)
	Set the data format.
EDataFormat	GetDataFormat ()
	Get the data format.
void	SetSize (EImageSize pImageSize)
	Set the thumbnail dimensions.
EImageSize	GetSize ()
	Get the thumbnail dimensions.
unsigned long	GetSizeInBytes ()
	Get the thumbnail dimensions in bytes.
Thumbnail data access
bool	SetThumbnailImage (const kUByte *pImage)
	Fill the thumbnail image.
kUByte *	GetThumbnailImage ()
	Get the thumbnail image.

---

Member Enumeration Documentation

enum EDataFormat

Data format.

• eRGB_24
• eRGBA_32

Definition at line 73 of file kfbxthumbnail.h.

enum EImageSize

Data format.

• eRGB_24
• eRGBA_32

Definition at line 95 of file kfbxthumbnail.h.

---

Member Function Documentation

void SetDataFormat

(

EDataFormat

pDataFormat

)

Set the data format.

Parameters:

pDataFormat

Data format identifier.

EDataFormat GetDataFormat

(

)

Get the data format.

Returns:

Data format identifier for the thumbnail.

void SetSize

(

EImageSize

pImageSize

)

Set the thumbnail dimensions.

Parameters:

pImageSize

Image size identifier.

EImageSize GetSize

(

)

Get the thumbnail dimensions.

Returns:

Image size identifier.

unsigned long GetSizeInBytes

(

)

Get the thumbnail dimensions in bytes.

Returns:

Thumbnail size in bytes.

bool SetThumbnailImage

(

const kUByte *

pImage

)

Fill the thumbnail image.

Parameters:

pImage

Pointer to the image data. A copy of the image data will be made.

Remarks:

This pointer must point to a buffer region that is at least Width * Height * Component count bytes long. This pointer points to the upper left corner of the image.

You must set the data format and the dimensions before calling this function.

Returns:

true if the thumbnail properties were set before calling this funtion. false otherwise.

kUByte* GetThumbnailImage

(

)

Get the thumbnail image.

Returns:

Pointer to the image data, or NULL if the thumbnail is empty.