RixRenderState Class Reference

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

#include <RixInterfaces.h>

Inheritance diagram for RixRenderState:

Classes
struct	DspyInfo
struct	FrameInfo
struct	RayCtxInfo
struct	RendererInfo

Public Types
enum	RayType {   k_rtInvalid =0, k_rtCamera, k_rtLight, k_rtSpecular,   k_rtDiffuse, k_rtTransmission, k_rtDirectlight, k_rtNumRayTypes }
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.
virtual int	GetFrameInfo (FrameInfo *)=0
virtual int	GetDspyInfo (int dspyId, DspyInfo *)=0
virtual int	GetRayCtxInfo (RayCtxInfo *)=0
virtual int	GetOption (const char *name, void *result, int resultlen, Type *resulttype, int *resultcount)=0
virtual int	GetAttribute (const char *name, void *result, int resultlen, Type *resulttype, int *resultcount)=0
virtual int	GetAttrIdNameStack (char const *idstack[], unsigned maxlen)=0
Public Member Functions inherited from RixInterface
virtual int	GetVersion () const

Additional Inherited Members
Protected Member Functions inherited from RixInterface
	RixInterface (int version)
	Interfaces should not be constructed by users.
virtual	~RixInterface ()
	Interfaces should not be deleted by users.
Protected Attributes inherited from RixInterface
int	m_version
	Version number of this interface.

Detailed Description

An interface for discovering the current state of the renderer.

Member Enumeration Documentation

enum RixRenderState::Type

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 RixRenderState::Type of the values put into the result buffer, and resultcount is the number of those (multibyte) items.

Member Function Documentation

virtual int RixRenderState::GetAttrIdNameStack ( char const *  idstack[], unsigned  maxlen  )

pure virtual

GetAttrIdNameStack returns a list of names representing the attribute scopes enclosing the current Ri stream position. Caller provides memory into which the renderer writes the name at each level. Positive returncode represents success and will be less than the provided maximum length. idstack[0] is the 'innermost' scope. idstack[returnval-1] is the outermost scope. Nonpositive return codes represent failure, the magnitude of the result represents the size of the memory block needed to store a result. A return value of 0 indicates other exceptional (error) conditions.

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

pure virtual

Returns details about a given dspy. dspyid must be between 0 and FrameInfo::ndspy-1.

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.

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.

---

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

• RixInterfaces.h