RenderManAPI  24.0
RixMessages Class Referenceabstract

An object that can be used to print warnings, errors, or info in a thread safe way from within the renderer. More...

#include <RixInterfaces.h>

Inherits RixInterface.

Public Types

enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual void Error (const char *format,...)=0
 Report error/warning/info, with printf-style formatting. More...
 
virtual void ErrorAlways (const char *format,...)=0
 Report an error, with no suppression of duplicate messages. More...
 
virtual void Warning (const char *format,...)=0
 Report a warning, suppressing duplicate messages. More...
 
virtual void WarningAlways (const char *format,...)=0
 Report a warning, with no suppression of duplicate messages. More...
 
virtual void Info (const char *format,...)=0
 Report information, suppressing duplicate messages. More...
 
virtual void InfoAlways (const char *format,...)=0
 Report information, with no suppression of duplicate messages. More...
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixMessages ()
 Constructor is for internal use only. More...
 

Protected Attributes

int m_version
 Version number of this interface. More...
 

Detailed Description

An object that can be used to print warnings, errors, or info in a thread safe way from within the renderer.

Member Enumeration Documentation

◆ Type

enum RixInterface::Type
inherited
Enumerator
k_Float 
k_Integer 
k_StringV 
k_Color 
k_Normal 
k_Vector 
k_Point 
k_HPoint 
k_MPoint 
k_Matrix 

Constructor & Destructor Documentation

◆ RixMessages()

RixMessages::RixMessages ( )
inlineprotected

Constructor is for internal use only.

Member Function Documentation

◆ Error()

virtual void RixMessages::Error ( const char *  format,
  ... 
)
pure virtual

Report error/warning/info, with printf-style formatting.

For example:

msgs->Error("Plugin failed, status %d", status);

Report an error, suppressing duplicate messages.

Referenced by RixGetSceneColorSpace().

◆ ErrorAlways()

virtual void RixMessages::ErrorAlways ( const char *  format,
  ... 
)
pure virtual

Report an error, with no suppression of duplicate messages.

◆ GetVersion()

virtual int RixInterface::GetVersion ( ) const
inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

◆ Info()

virtual void RixMessages::Info ( const char *  format,
  ... 
)
pure virtual

Report information, suppressing duplicate messages.

◆ InfoAlways()

virtual void RixMessages::InfoAlways ( const char *  format,
  ... 
)
pure virtual

Report information, with no suppression of duplicate messages.

◆ Warning()

virtual void RixMessages::Warning ( const char *  format,
  ... 
)
pure virtual

Report a warning, suppressing duplicate messages.

◆ WarningAlways()

virtual void RixMessages::WarningAlways ( const char *  format,
  ... 
)
pure virtual

Report a warning, with no suppression of duplicate messages.

Member Data Documentation

◆ m_version

int RixInterface::m_version
protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().


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