RenderManAPI  24.0
Public Member Functions | List of all members
RixXmlFile Class Referenceabstract

NOTE: This interface will be deprecated when a new interface comes in the next release An XML file handle, which is passed to a statistics reporter (see RixStats::AddReporter). More...

#include <RixInterfaces.h>

Public Member Functions

virtual void WriteXml (const char *format,...)=0
 Write arbitrary XML. More...
 
virtual void WriteText (const char *format,...)=0
 Write arbitrary text to XML file, encoding special characters like "&lt". More...
 
virtual ~RixXmlFile ()
 Virtual destructor. More...
 
void WriteStat (char const *name, char const *desc, int value)
 
void WriteStat (char const *name, char const *desc, uint64_t value)
 
void WriteStat (char const *name, char const *desc, float value)
 
void WriteStat (char const *name, char const *desc, char const *value)
 
void WriteTime (char const *name, char const *desc, float time)
 

Detailed Description

NOTE: This interface will be deprecated when a new interface comes in the next release An XML file handle, which is passed to a statistics reporter (see RixStats::AddReporter).

Constructor & Destructor Documentation

◆ ~RixXmlFile()

virtual RixXmlFile::~RixXmlFile ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ WriteStat() [1/4]

void RixXmlFile::WriteStat ( char const *  name,
char const *  desc,
int  value 
)
inline

References WriteXml().

◆ WriteStat() [2/4]

void RixXmlFile::WriteStat ( char const *  name,
char const *  desc,
uint64_t  value 
)
inline

References WriteXml().

◆ WriteStat() [3/4]

void RixXmlFile::WriteStat ( char const *  name,
char const *  desc,
float  value 
)
inline

References WriteXml().

◆ WriteStat() [4/4]

void RixXmlFile::WriteStat ( char const *  name,
char const *  desc,
char const *  value 
)
inline

References WriteXml().

◆ WriteText()

virtual void RixXmlFile::WriteText ( const char *  format,
  ... 
)
pure virtual

Write arbitrary text to XML file, encoding special characters like "&lt".

◆ WriteTime()

void RixXmlFile::WriteTime ( char const *  name,
char const *  desc,
float  time 
)
inline

References WriteXml().

◆ WriteXml()

virtual void RixXmlFile::WriteXml ( const char *  format,
  ... 
)
pure virtual

Write arbitrary XML.

No encoding is performed, so be careful to avoid the use of special characters (e.g. the less-than symbol). Users are encouraged to generate XML that matches the RenderMan statistics XML schema (e.g. to enable use of the default XML stylesheet). See Application Note #43 (Using XML Frame Statistics) for details.

Referenced by WriteStat(), and WriteTime().

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