RenderManAPI  24.0
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RixRenderState Class Referenceabstract

An interface for discovering the current state of the renderer. More...

#include <RixInterfaces.h>

Inherits RixInterface.

Classes

struct  DspyInfo
 
struct  FrameInfo
 
struct  RayCtxInfo
 
struct  RendererInfo
 

Public Types

enum  ShadingIntent {
  k_siInvalid = 0, k_siShadeGrid, k_siShadeRay, k_siCache,
  k_siNumShadingIntents
}
 
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 int GetRendererInfo (RendererInfo *)=0
 Provides information about the renderer. More...
 
virtual int GetFrameInfo (FrameInfo *)=0
 Provides information about the current frame. More...
 
virtual int GetDspyInfo (int dspyId, DspyInfo *)=0
 Returns details about a given dspy. More...
 
virtual int GetRayCtxInfo (RayCtxInfo *)=0
 Provides information about the current shading context's ray tracing state. More...
 
virtual int GetOption (RtUString const name, void *result, int resultLength, Type *resultType, int *resultCount)=0
 GetAttribute, GetOption, return the current values of the named Attribute or Option. More...
 
virtual int GetAttribute (RtUString const name, void *result, int resultLength, Type *resultType, int *resultCount)=0
 
virtual int GetRIBFileContext (int *linenumber, char **filename)=0
 Retrieve the RIB context. More...
 
virtual int GetRIBArchive (RtUString const filename, const char **archive)=0
 Public interface for obtaining the contents of an in-memory archive, useful to serialize a sequence of Ri calls. More...
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixRenderState ()
 

Protected Attributes

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

Detailed Description

An interface for discovering the current state of the renderer.

Member Enumeration Documentation

◆ ShadingIntent

enum RixRenderState::ShadingIntent
Enumerator
k_siInvalid 
k_siShadeGrid 
k_siShadeRay 
k_siCache 
k_siNumShadingIntents 

◆ 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

◆ RixRenderState()

RixRenderState::RixRenderState ( )
inlineprotected

Member Function Documentation

◆ GetAttribute()

virtual int RixRenderState::GetAttribute ( RtUString const  name,
void *  result,
int  resultLength,
Type *  resultType,
int *  resultCount 
)
pure virtual

Referenced by RixProcPrimInstanceHash().

◆ GetDspyInfo()

virtual int RixRenderState::GetDspyInfo ( int  dspyId,
DspyInfo *   
)
pure virtual

Returns details about a given dspy.

dspyId must be between 0 and FrameInfo::displayState.nDisplays-1.

◆ GetFrameInfo()

virtual int RixRenderState::GetFrameInfo ( FrameInfo *  )
pure virtual

Provides information about the current frame.

Returns 0 on success and a non-zero error code indicating failure.

◆ GetOption()

virtual int RixRenderState::GetOption ( RtUString const  name,
void *  result,
int  resultLength,
Type *  resultType,
int *  resultCount 
)
pure virtual

GetAttribute, GetOption, return the current values of the named Attribute or Option.

The caller passes in a buffer and it is filled-in with the resulting requested info. Return value is 0 on success, or -1 if name can't be found, or N if the supplied buffer was too short and needs to be at least N bytes long. Caller supplies the addresses of several other return values which are filled in:

  • resultType is the RixInterface::Type of the values put into the result buffer
  • resultCount is the number of those (multibyte) items. Note: for vector types (normal, vector, point, color), and for matrices, resultCount is the total number of float values

Referenced by PxrGeoAOV::disableIntegratorAOVs(), and RixGetSceneColorSpace().

◆ GetRayCtxInfo()

virtual int RixRenderState::GetRayCtxInfo ( RayCtxInfo *  )
pure virtual

Provides information about the current shading context's ray tracing state.

Returns 0 on success and a non-zero error code indicating failure.

◆ GetRendererInfo()

virtual int RixRenderState::GetRendererInfo ( RendererInfo *  )
pure virtual

Provides information about the renderer.

◆ GetRIBArchive()

virtual int RixRenderState::GetRIBArchive ( RtUString const  filename,
const char **  archive 
)
pure virtual

Public interface for obtaining the contents of an in-memory archive, useful to serialize a sequence of Ri calls.

returns 0 if successful, 1 otherwise. Resulting archive data must be copied-out, since the lifetime of the referenced data is undefined. RiArchiveBegin(":memory/ascii:yourarchivename"); .. misc ri calls .. RiArchiveEnd() const char *rib; if(0 == GetRIBArchive("yourarchivename", &rib)) { // archive found, we need to strdup it }

◆ GetRIBFileContext()

virtual int RixRenderState::GetRIBFileContext ( int *  linenumber,
char **  filename 
)
pure virtual

Retrieve the RIB context.

Copies the linenumber of the current position in the input RIB to the int at location pointed to by linenumber. Copies the address of a string containing the current RIB filename to the pointer at the location pointed to by filename. This string memory is owned by the renderer and should not be deallocated by a DSO. If no RIB file name is available, *filename is set to NULL. Returns 0 if successful, 1 otherwise.

◆ 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.

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: