RenderManAPI  24.0
RixInterfaces.h File Reference
#include <cstddef>
#include <utility>
#include "RiTypesHelper.h"
#include "stats/Roz.h"

Go to the source code of this file.

Classes

class  RixInterface
 Base class for all Rix interfaces. More...
 
class  RixContext
 Rix interfaces are obtained from an RixContext. More...
 
class  RixXcpt
 The primary means to comprehend exceptional conditions within Rix is to handle messages generated by the library components. More...
 
class  RixXcpt::XcptHandler
 A base class characterizing the required interface for xcpt handlers. More...
 
class  RixHashUtils
 A wrapper for provided hash functions. More...
 
class  RixMessages
 An object that can be used to print warnings, errors, or info in a thread safe way from within the renderer. More...
 
class  RixTexture
 RixTexture performs filtered texture map lookups using a texture coordinate and a region over which to filter. More...
 
class  RixTexture::TxProperties
 
struct  RixTexture::TxParams
 
class  RixTexture3d
 RixTexture3d provides a general interface containing functions useful for looking up 3D texture data. More...
 
class  RixShadeFunctions
 RixShadeFunctions provides a general interface containing functions useful for developing patterns for shading. More...
 
class  RixTransform
 RixTransform provides transformation routines that operate over named coordinate systems in the renderer. More...
 
class  RixRenderState
 An interface for discovering the current state of the renderer. More...
 
struct  RixRenderState::RendererInfo
 
struct  RixRenderState::FrameInfo
 
struct  RixRenderState::DspyInfo
 
struct  RixRenderState::RayCtxInfo
 
class  RixSymbolResolver
 
class  RixGeoDebugger
 
class  RixLPEInfo
 An interface to find out information related to light path expressions (LPEs). More...
 
class  RixCustomLPE
 An interface to lookup and match custom light path expressions (LPEs). More...
 
class  RixXmlFile
 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...
 
class  RixTimer
 NOTE: This interface will be deprecated when a new interface comes in the next release Interface for sampling a high-resolution representation of the current time. More...
 
class  RixStats
 NOTE: This interface will be deprecated when a new interface comes in the next release Interface for including user statistics in XML file. More...
 
class  RixStats::SimpleStat
 Add a generic statistic via a subclass of the SimpleStat class interface. More...
 
class  RixResourceResolver
 
class  RixStorage
 NOTE: This interface is deprecated and will be removed in a future release. More...
 
class  RixFunction< _Signature >
 RixFunction is a template class similar to std::function. More...
 
class  RixFunction< _Res(_ArgTypes...)>
 
class  RixMutex
 NOTE: This interface is deprecated and will be removed in a future release A class that encapsulates a mutual exclusion object. More...
 
class  RixThreadUtils
 NOTE: This interface is deprecated and will be removed in a future release This object is used to create a RixMutex object that can be used for locking access to shared global memory. More...
 
class  RixColorManager
 The color manager wraps the active OpenColorIO configuration (if any) to provide color management functions exclusively to shading plugins. More...
 

Typedefs

typedef int RixLPEToken
 
typedef void(* RixLPECallback) (void *userData, RixLPEState *lpeState, RixShadingContext const *sCtx, int sCtxIndex, RtColorRGB const &thruput, RtColorRGB const *lightTrans, bool firstContribution)
 
typedef void(* RixCleanupFunc) (RixContext *context, void *data)
 A cleanup function can be associated with data in RixStorage. More...
 

Enumerations

enum  RixInterfaceId {
  k_RixThreadUtils = 0, k_RixMessages, k_RixGlobalData = 3, k_RixThreadData,
  k_RixLocalData, k_RixSessionData = 8, k_RixXcpt, k_RixRIB,
  k_RixDeepTexture, k_RixRIBParser = 13, k_RixStats, k_RixTimer,
  k_RixRenderState = 18, k_RixRiCtl = 20, k_RixSymbolResolver, k_RixGeoDebugger = 23,
  k_RixTexture, k_RixShadeFunctions, k_RixTransform, k_RixResourceResolver,
  k_RixLPEInfo, k_RixCustomLPE, k_RixTexture3d, k_RixDspy,
  k_RixShaderInfo, k_RixHashUtils, k_RixSGManager, k_RixEventCallbacks,
  k_RixColorManager
}
 Identifiers for Rix interfaces. More...
 

Typedef Documentation

◆ RixCleanupFunc

typedef void(* RixCleanupFunc) (RixContext *context, void *data)

A cleanup function can be associated with data in RixStorage.

◆ RixLPECallback

typedef void(* RixLPECallback) (void *userData, RixLPEState *lpeState, RixShadingContext const *sCtx, int sCtxIndex, RtColorRGB const &thruput, RtColorRGB const *lightTrans, bool firstContribution)

◆ RixLPEToken

typedef int RixLPEToken

Enumeration Type Documentation

◆ RixInterfaceId

Identifiers for Rix interfaces.

Enumerator
k_RixThreadUtils 

Id for RixThreadUtils interface.

k_RixMessages 

Id for RixMessages interface.

k_RixGlobalData 

Id for global (per frame) RixStorage interface.

k_RixThreadData 

Id for per-thread RixStorage interface.

k_RixLocalData 

Id for local RixStorage interface.

k_RixSessionData 

Id for per session RixStorage interface.

k_RixXcpt 

Id for interface to exception handling.

k_RixRIB 

Id for RixRIB interface.

k_RixDeepTexture 

Id for RixDeepTexture interface.

k_RixRIBParser 

Id for RIB Parser interface.

k_RixStats 

Id for RixStats interface.

k_RixTimer 

Id for RixTimer interface.

k_RixRenderState 

Id for RixRenderState interface.

k_RixRiCtl 

Id for Riinterface.

k_RixSymbolResolver 

Id for SymbolResolver interface.

k_RixGeoDebugger 

Id for geometric debugger interface.

k_RixTexture 

Id for New Texture-2D interface.

k_RixShadeFunctions 

Id for Shade functions interface.

k_RixTransform 

Id for Transformation interface.

k_RixResourceResolver 

Id for ResourceResolver interface.

k_RixLPEInfo 

Id for RixLPEInfo interface.

k_RixCustomLPE 

Id for RixCustomLPE interface.

k_RixTexture3d 

TODO: implement a new Texture-3D interface.

k_RixDspy 

Id for RixDspy interface.

k_RixShaderInfo 

Id for shader file query interface.

k_RixHashUtils 

Id for RixHashUtils interface to UtHash.

k_RixSGManager 

Id for RenderMan scene graph interface.

k_RixEventCallbacks 

Id for RenderMan event callbacks interface.

k_RixColorManager 

id for Color Manager interface