FBX SDK Reference Guide > Class List > 
KFbxThumbnail
#include<kfbxthumbnail.h>

Inheritance diagram for KFbxThumbnail:

Inheritance graph
[legend]

List of all members.

Detailed Description

Simple class to hold RGBA values of a thumbnail image.

Definition at line54of filekfbxthumbnail.h.


Thumbnail properties

enum EDataFormat
 Data format.More...
enum EImageSize
 Image size.More...
KFbxTypedProperty<fbxInteger1> CustomHeight
 Pixel height of the thumbnail image.
KFbxTypedProperty<fbxInteger1> CustomWidth
 Pixel width of the thumbnail image.
void SetDataFormat(EDataFormatpDataFormat)
 Set the data format.
EDataFormat GetDataFormat() const
 Get the data format.
void SetSize(EImageSizepImageSize)
 Set the thumbnail dimensions.
EImageSize GetSize() const
 Get the thumbnail dimensions.
unsigned long GetSizeInBytes() const
 Get the thumbnail dimensions in bytes.

Thumbnail data access

bool SetThumbnailImage(const kUByte *pImage)
 Fill the thumbnail image.
kUByte * GetThumbnailImage() const
 Get the thumbnail image.

Member Enumeration Documentation

enumEDataFormat

Data format.

  • eRGB_24
  • eRGBA_32

Definition at line75of filekfbxthumbnail.h.

enumEImageSize

Image size.

  • eNOT_SET
  • e64x64
  • e128x128
  • eCUSTOM_SIZE

Definition at line98of filekfbxthumbnail.h.

Member Function Documentation

void SetDataFormat(EDataFormat pDataFormat ) 

Set the data format.

Parameters:
pDataFormat Data format identifier.

EDataFormatGetDataFormat( ) const

Get the data format.

Returns:
Data format identifier for the thumbnail.

void SetSize(EImageSize pImageSize ) 

Set the thumbnail dimensions.

Parameters:
pImageSize Image size identifier.

EImageSizeGetSize( ) const

Get the thumbnail dimensions.

Returns:
Image size identifier.

unsigned long GetSizeInBytes( ) const

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. If the image size is set to eCUSTOM_SIZE the CustomHeight and CustomWidth properties must be set before calling this function.

Returns:
trueif the thumbnail properties were set before calling this funtion.falseotherwise.

kUByte* GetThumbnailImage( ) const

Get the thumbnail image.

Returns:
Pointer to the image data, orNULLif the thumbnail is empty.

Member Data Documentation

KFbxTypedProperty<fbxInteger1>CustomHeight

Pixel height of the thumbnail image.

Definition at line66of filekfbxthumbnail.h.

KFbxTypedProperty<fbxInteger1>CustomWidth

Pixel width of the thumbnail image.

Definition at line69of filekfbxthumbnail.h.