RenderMan API  23.0
RixRiCtl Class Referenceabstract

#include <RixRiCtl.h>

Inheritance diagram for RixRiCtl:
RixInterface

Public Member Functions

virtual int PRManBegin (int argc, char *argv[])=0
 
virtual int PRManGo ()=0
 
virtual int PRManEnd ()=0
 
virtual RiGetRiCtx ()=0
 
virtual void Flush (RtString marker, RtBoolean synchronous, RtUString flushmode)=0
 Flush the renderer to the given stream marker. More...
 
virtual int GetProgress ()=0
 
virtual RtInt SetWantsProgress (RtInt wantsProgress)=0
 
virtual void ProcessCallbacks ()=0
 Process outstanding callback requests (display, exception) More...
 
virtual void Option (RtString name, RtPointer value)=0
 Configure Ric. More...
 
virtual void SetRifEditMode (RixRifEditMode m)=0
 Set Rif behavior. More...
 
virtual void RifInit (int argc, const char *argv[])=0
 Configure Rifs. Would only work in main thread. More...
 
virtual void InvalidateTexture (RtUString const name)=0
 
- Public Member Functions inherited from RixInterface
virtual int GetVersion () const
 

Protected Member Functions

 RixRiCtl ()
 
virtual ~RixRiCtl ()
 
- Protected Member Functions inherited from RixInterface
 RixInterface (int version)
 Interfaces should not be constructed by users. More...
 
virtual ~RixInterface ()
 Interfaces should not be deleted by users. More...
 

Additional Inherited Members

- Public Types inherited from RixInterface
enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 
- Protected Attributes inherited from RixInterface
int m_version
 Version number of this interface. More...
 

Detailed Description

Definition at line 74 of file RixRiCtl.h.

Constructor & Destructor Documentation

◆ RixRiCtl()

RixRiCtl::RixRiCtl ( )
inlineprotected

Definition at line 128 of file RixRiCtl.h.

◆ ~RixRiCtl()

virtual RixRiCtl::~RixRiCtl ( )
inlineprotectedvirtual

Definition at line 129 of file RixRiCtl.h.

Member Function Documentation

◆ Flush()

virtual void RixRiCtl::Flush ( RtString  marker,
RtBoolean  synchronous,
RtUString  flushmode 
)
pure virtual

Flush the renderer to the given stream marker.

Ric (Ri Control) methods --------------------------------—— These should be used ether to control an external rendering session. Or to signal direct rendering abort.

◆ GetProgress()

virtual int RixRiCtl::GetProgress ( )
pure virtual

Return the percentage done of the current render. If there is no current render underway, this returns 100 (done).

◆ GetRiCtx()

virtual Ri* RixRiCtl::GetRiCtx ( )
pure virtual

Ri methods -------------------------------------------------— Return a pointer to Ri generator, or NULL of there is an error. In direct-rendering situations these calls communicate directly with the renderer (albeit through the Rif layer). In external-render mode, these calls produce RIB which is written to stdin of the child prman process.

◆ InvalidateTexture()

virtual void RixRiCtl::InvalidateTexture ( RtUString const  name)
pure virtual

◆ Option()

virtual void RixRiCtl::Option ( RtString  name,
RtPointer  value 
)
pure virtual

Configure Ric.

◆ PRManBegin()

virtual int RixRiCtl::PRManBegin ( int  argc,
char *  argv[] 
)
pure virtual

PRMan methods ---------------------------------------------— These entrypoints are useful to initiate a direct-linked prman session and intialized it with prman-standard commandline arguments. It is an error to invoke these methods in any other execution context.

◆ PRManEnd()

virtual int RixRiCtl::PRManEnd ( )
pure virtual

◆ PRManGo()

virtual int RixRiCtl::PRManGo ( )
pure virtual

◆ ProcessCallbacks()

virtual void RixRiCtl::ProcessCallbacks ( )
pure virtual

Process outstanding callback requests (display, exception)

◆ RifInit()

virtual void RixRiCtl::RifInit ( int  argc,
const char *  argv[] 
)
pure virtual

Configure Rifs. Would only work in main thread.

◆ SetRifEditMode()

virtual void RixRiCtl::SetRifEditMode ( RixRifEditMode  m)
pure virtual

Set Rif behavior.

◆ SetWantsProgress()

virtual RtInt RixRiCtl::SetWantsProgress ( RtInt  wantsProgress)
pure virtual

Set whether the renderer should return progress messages Returns the previous value.


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