RixDeepTexture::DeepMetadata Class Reference

DeepMetadata. More...

#include <RixDeepTexture.h>

Public Member Functions
virtual int	Set (char const *token, void const *value)=0
	Add or update a metadata field. More...
virtual int	Count ()=0
	Return how many metadata fields this list has. More...
virtual int	GetByIndex (int index, char const **token, void const **value)=0
	Metadata fields are indexed in no particular order; this function is simply a convenience for enumerating all attached metadata. More...
virtual int	GetByName (char const *name, char const **token, void const **value)=0
	Metadata fields may also be retrieved by an unadorned name. More...

Protected Member Functions
virtual	~DeepMetadata ()
	Internal only. More...

Detailed Description

DeepMetadata.

This object contains a list of key/value pairs that can be associated with a file or image and will be persisted on disk.

The token is a string specifying the type and name of the field and is given in the standard RenderMan style, e.g., float bbox[6]. Supported types are: float, int, point, color, vector, normal, hpoint, matrix, and string.

The associated data to write is given by the value pointer. In the case of string data, this should point to char * pointers that point to the strings themselves (i.e., argv style).

Constructor & Destructor Documentation

~DeepMetadata()

virtual RixDeepTexture::DeepMetadata::~DeepMetadata ( )

inlineprotectedvirtual

Internal only.

Member Function Documentation

Count()

virtual int RixDeepTexture::DeepMetadata::Count ( )

pure virtual

Return how many metadata fields this list has.

GetByIndex()

virtual int RixDeepTexture::DeepMetadata::GetByIndex ( int  index, char const **  token, void const **  value  )

pure virtual

Metadata fields are indexed in no particular order; this function is simply a convenience for enumerating all attached metadata.

Returns k_ErrNOMETADATA if the given field doesn't exists. The resulting pointers are valid until either the file is closed or Set() modifies this field. Data behind these pointers must not be changed.

GetByName()

virtual int RixDeepTexture::DeepMetadata::GetByName ( char const *  name, char const **  token, void const **  value  )

pure virtual

Metadata fields may also be retrieved by an unadorned name.

Set()

virtual int RixDeepTexture::DeepMetadata::Set ( char const *  token, void const *  value  )

pure virtual

Add or update a metadata field.

If the value is null, the metadata field will be removed.

---

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

• RixDeepTexture.h