optixu_traversal.h

Go to the documentation of this file.

/****************************************************************************\
 *
 * Traversal API
 *
\****************************************************************************/


#ifndef _optixu_optux_traversal_h_
#define _optixu_optux_traversal_h_

#include "../optix.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct {
    int   prim_id;  
    float t;        
  } RTUtraversalresult;


  typedef enum { 
    RTU_QUERY_TYPE_ANY_HIT = 0,  
    RTU_QUERY_TYPE_CLOSEST_HIT,  
    RTU_QUERY_TYPE_COUNT         
  } RTUquerytype;

  typedef enum  {
    RTU_RAYFORMAT_ORIGIN_DIRECTION_TMIN_TMAX_INTERLEAVED = 0, 
    RTU_RAYFORMAT_ORIGIN_DIRECTION_INTERLEAVED,               
    RTU_RAYFORMAT_COUNT                                       
  } RTUrayformat;

  typedef enum  {
    RTU_TRIFORMAT_MESH= 0,        
    RTU_TRIFORMAT_TRIANGLE_SOUP,  
    RTU_TRIFORMAT_COUNT           
  } RTUtriformat;

  typedef enum  {
    RTU_INITOPTION_NONE          = 0,       
    RTU_INITOPTION_GPU_ONLY      = 1 << 0,  
    RTU_INITOPTION_CPU_ONLY      = 1 << 1,  
    RTU_INITOPTION_CULL_BACKFACE = 1 << 2   
  } RTUinitoptions;

  typedef enum  {
    RTU_OUTPUT_NONE        = 0,      
    RTU_OUTPUT_NORMAL      = 1 << 0, 
    RTU_OUTPUT_BARYCENTRIC = 1 << 1, 
    RTU_OUTPUT_BACKFACING  = 1 << 2  
  } RTUoutput;

  typedef enum  {
    RTU_OPTION_INT_NUM_THREADS=0  
  } RTUoption;


  typedef struct RTUtraversal_api*  RTUtraversal;


  RTresult RTAPI rtuTraversalCreate( RTUtraversal* traversal,
                                     RTUquerytype  query_type,
                                     RTUrayformat  ray_format,
                                     RTUtriformat  tri_format,
                                     unsigned int  outputs,
                                     unsigned int  options,
                                     RTcontext     context );

  RTresult RTAPI rtuTraversalGetErrorString( RTUtraversal traversal,
                                             RTresult code,
                                             const char** return_string);
  RTresult RTAPI rtuTraversalSetOption( RTUtraversal traversal,
                                        RTUoption    option,
                                        void*        value );

  RTresult RTAPI rtuTraversalSetMesh( RTUtraversal    traversal,
                                      unsigned int    num_verts,
                                      const float*    verts,
                                      unsigned int    num_tris,
                                      const unsigned* indices );

  RTresult RTAPI rtuTraversalSetTriangles( RTUtraversal traversal,
                                           unsigned int num_tris,
                                           const float* tris );

  RTresult RTAPI rtuTraversalSetAccelData( RTUtraversal traversal,
                                           const void*  data,
                                           RTsize       data_size );

  RTresult RTAPI rtuTraversalGetAccelDataSize( RTUtraversal traversal,
                                               RTsize*      data_size );
  
  RTresult RTAPI rtuTraversalGetAccelData( RTUtraversal traversal,
                                           void*        data );

  RTresult RTAPI rtuTraversalMapRays( RTUtraversal traversal,
                                      unsigned int num_rays,
                                      float** rays );

  RTresult RTAPI rtuTraversalUnmapRays( RTUtraversal traversal );

  RTresult RTAPI rtuTraversalPreprocess( RTUtraversal traversal );

  RTresult RTAPI rtuTraversalTraverse( RTUtraversal traversal );

  RTresult RTAPI rtuTraversalMapResults( RTUtraversal         traversal,
                                         RTUtraversalresult** results );

  RTresult RTAPI rtuTraversalUnmapResults( RTUtraversal         traversal );
  
  RTresult RTAPI rtuTraversalMapOutput( RTUtraversal traversal,
                                        RTUoutput    which,
                                        void**       output );
  RTresult RTAPI rtuTraversalUnmapOutput( RTUtraversal traversal,
                                          RTUoutput    which );
  RTresult RTAPI rtuTraversalDestroy( RTUtraversal traversal );

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* _optixu_optux_traversal.h */