ai_ray.h

Go to the documentation of this file.

// Copyright 2021 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
 
#pragma once
#include "ai_vector.h"
#include <stdint.h> // uint32_t etc
#include "ai_shader_sample.h"
#ifdef AI_CPU_COMPILER
#include "ai_string.h"
#include "ai_matrix.h"
#else
#include <ai_color.h>
#endif
 
// forward declaration
struct AtShaderGlobals;
struct AtLightSample;
 
#define AI_RAY_UNDEFINED         0x00  
#define AI_RAY_CAMERA            0x01  
#define AI_RAY_SHADOW            0x02  
#define AI_RAY_DIFFUSE_TRANSMIT  0x04  
#define AI_RAY_SPECULAR_TRANSMIT 0x08  
#define AI_RAY_VOLUME            0x10  
#define AI_RAY_DIFFUSE_REFLECT   0x20  
#define AI_RAY_SPECULAR_REFLECT  0x40  
#define AI_RAY_SUBSURFACE        0x80  
/*\}*/
 
#define AI_RAY_ALL_DIFFUSE  (AI_RAY_DIFFUSE_TRANSMIT | AI_RAY_DIFFUSE_REFLECT)   
#define AI_RAY_ALL_SPECULAR (AI_RAY_SPECULAR_TRANSMIT| AI_RAY_SPECULAR_REFLECT)  
#define AI_RAY_ALL_REFLECT  (AI_RAY_DIFFUSE_REFLECT  | AI_RAY_SPECULAR_REFLECT)  
#define AI_RAY_ALL_TRANSMIT (AI_RAY_DIFFUSE_TRANSMIT | AI_RAY_SPECULAR_TRANSMIT) 
#define AI_RAY_ALL          uint8_t(-1)                                          
/*\}*/
 
struct AtRay {
   uint8_t      type;                   
   uint8_t      bounces;                
   uint8_t      bounces_diffuse;        
   uint8_t      bounces_specular;       
   uint8_t      bounces_reflect;        
   uint8_t      bounces_transmit;       
   uint8_t      bounces_volume;         
#ifdef AI_CPU_COMPILER
   bool         inclusive_traceset;     
   AtString     traceset;               
   uint16_t     tid;                    
#endif
   uint16_t     sindex;                 
   int          x;                      
   int          y;                      
   float        px;                     
   float        py;                     
   AtVector     origin;                 
   AtVector     dir;                    
   float        mindist;                
   float        maxdist;                
   const AtShaderGlobals* psg;          
   const AtLightSample* light_sample;   
   AtRGB        weight;                 
   float        time;                   
   AtVector     dOdx;                   
   AtVector     dOdy;                   
   AtVector     dDdx;                   
   AtVector     dDdy;                   
};
 
AI_API AI_DEVICE AtRay AiMakeRay(uint8_t type, const AtVector& origin, const AtVector* dir, float maxdist, const AtShaderGlobals* sg);
 
#ifdef AI_CPU_COMPILER
AI_API void  AiReflectRay(AtRay& ray, const AtVector& normal, const AtShaderGlobals* sg);
#endif
AI_API AI_DEVICE bool  AiRefractRay(AtRay& ray, const AtVector& normal, float n1, float n2, const AtShaderGlobals* sg);
#ifdef AI_CPU_COMPILER
AI_API bool  AiTrace          (const AtRay& ray, const AtRGB& weight, AtScrSample& sample);
#endif
AI_API AI_DEVICE void  AiTraceBackground(const AtRay& ray, AtScrSample& sample);
#ifdef AI_CPU_COMPILER
AI_API bool  AiTraceProbe     (const AtRay& ray, AtShaderGlobals* sgout);
#endif
 
/*\}*/