RenderMan API  23.0
RixResourceResolver Class Referenceabstract

#include <RixInterfaces.h>

Inheritance diagram for RixResourceResolver:
RixInterface

Public Types

enum  ResourceType {
  k_Shader = 0, k_Texture, k_Archive, k_Display,
  k_Procedural, k_RifFilter, k_RixPlugin
}
 
- 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
}
 

Public Member Functions

virtual char const * GetResourcePaths (ResourceType)=0
 
virtual int ResolveResource (ResourceType, char const *nm, char result[], int maxlen)=0
 
- Public Member Functions inherited from RixInterface
virtual int GetVersion () const
 

Protected Member Functions

 RixResourceResolver ()
 
- 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

- Protected Attributes inherited from RixInterface
int m_version
 Version number of this interface. More...
 

Detailed Description

Definition at line 1259 of file RixInterfaces.h.

Member Enumeration Documentation

◆ ResourceType

Enumerator
k_Shader 
k_Texture 
k_Archive 
k_Display 
k_Procedural 
k_RifFilter 
k_RixPlugin 

Definition at line 1262 of file RixInterfaces.h.

Constructor & Destructor Documentation

◆ RixResourceResolver()

RixResourceResolver::RixResourceResolver ( )
inlineprotected

Definition at line 1295 of file RixInterfaces.h.

Member Function Documentation

◆ GetResourcePaths()

virtual char const* RixResourceResolver::GetResourcePaths ( ResourceType  )
pure virtual

GetResourcePaths returns a ':' separated string representing filesystem directories to search for the requested resource type.

◆ ResolveResource()

virtual int RixResourceResolver::ResolveResource ( ResourceType  ,
char const *  nm,
char  result[],
int  maxlen 
)
pure virtual

ResolveResource searches for the specified resource and returns the fully qualified filename of the resource. If the resource can't be found nonzero error code is returned. Note that we follow the same file extension inference rules as does the renderer. Thus nm can be a relative filepath and may or may not require a file extension according to standard RenderMan conventions. If it works in RIB it should work here. Result should be allocated large enough to contain a fully-qualified pathname... Should the resulting file be found but not fit in the provided buffer, we return a positive error code indicated the required length. We return a negative error code, if the file not be found.


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