|
Description
Returns a numerical code that identifies the reason why a ray stopped tracing. Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long. Please see Multi-threaded Raytracing for more information.
Syntax
code = GetRayFailCode ( id )
Parameters
code (Long)
The numeric code that represents the error for the ray.
id as Long (or Huge_)
The identifier of the ray in the ray buffer.
Remarks
This function returns a numerical code that identifies the reason a ray stopped tracing. The possible reasons for failure are:
|
Value
|
Error
|
|
-1
|
Unknown error
|
|
0
|
no failure
|
|
256
|
too many total intersections
|
|
512
|
too many consecutive intersections
|
|
768
|
bad position
|
|
1024
|
bad direction
|
|
1280
|
below absolute transmitted power cutoff
|
|
1536
|
below absolute reflected power cutoff
|
|
1792
|
below relative transmitted power cutoff
|
|
2048
|
below relative reflected power cutoff
|
|
2304
|
irresolvable material
|
|
2560
|
exceeded specular ancestry cutoff
|
|
2816
|
exceeded scatter ancestry cutoff
|
|
3072
|
forbidden evanescent
|
|
3328
|
forbidden total internal reflection (TIR)
|
|
3584
|
surface interface specification stops ray
|
|
3840
|
too many steps in material
|
|
4096
|
secondary ray intersection failure
|
|
4352
|
secondary ray refraction error
|
|
4608
|
glue intersection failure in transmission
|
|
4864
|
glue intersection failure in reflection
|
See Also
GetRayIsFailed
GetRayStatus
|
Copyright © Photon Engineering, LLC
|
|