RenderManAPI  24.0
RixProjection Class Referenceabstract

#include <RixProjection.h>

Public Types

enum  DicingHint { k_Orthographic, k_Perspective, k_Spherical }
 Dicing hint value, to be returned by GetProperty when ProjectionProperty == k_DicingHint. More...
 
enum  DeepMetric { k_cameraZ = 0, k_rayLength = 1 }
 Expresses depth metric to use for samples in deep output. More...
 
enum  ProjectionProperty {
  k_DicingHint, k_DeepMetric, k_FieldOfView, k_FStop,
  k_FocalLength, k_FocalDistance
}
 

Public Member Functions

virtual RixSCDetail GetProperty (ProjectionProperty, void const **result) const =0
 
virtual void Project (RixProjectionContext &pCtx)=0
 Project: is the primary entrypoint for this class. More...
 
virtual void RenderBegin (RixContext &ctx, RixProjectionEnvironment const &env, RixParameterList const *instanceParams)=0
 
virtual void RenderEnd (RixContext &rixCtx)
 

Protected Member Functions

virtual ~RixProjection ()
 

Member Enumeration Documentation

◆ DeepMetric

Expresses depth metric to use for samples in deep output.

Set to k_cameraZ for standard perspective or orthographic projections. Use k_rayLength for spherical, cylindrical, etc... with -Z rays. Default value (if no value is returned) will be: k_cameraZ

Enumerator
k_cameraZ 
k_rayLength 

◆ DicingHint

Dicing hint value, to be returned by GetProperty when ProjectionProperty == k_DicingHint.

Helps the renderer decide how to dice geometry

Enumerator
k_Orthographic 
k_Perspective 
k_Spherical 

◆ ProjectionProperty

Enumerator
k_DicingHint 
k_DeepMetric 
k_FieldOfView 
k_FStop 
k_FocalLength 
k_FocalDistance 

Constructor & Destructor Documentation

◆ ~RixProjection()

virtual RixProjection::~RixProjection ( )
inlineprotectedvirtual

Member Function Documentation

◆ GetProperty()

virtual RixSCDetail RixProjection::GetProperty ( ProjectionProperty  ,
void const **  result 
) const
pure virtual

◆ Project()

virtual void RixProjection::Project ( RixProjectionContext pCtx)
pure virtual

Project: is the primary entrypoint for this class.

Maps a set of samples onto rays. This will be invoked by the rendering threads and should be thread-safe and re-entrant.

◆ RenderBegin()

virtual void RixProjection::RenderBegin ( RixContext ctx,
RixProjectionEnvironment const &  env,
RixParameterList const *  instanceParams 
)
pure virtual

◆ RenderEnd()

virtual void RixProjection::RenderEnd ( RixContext rixCtx)
inlinevirtual

References PIXAR_ARGUSED.


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