Navigation: Scripting Reference Manual > Functions & Subroutines > GetRaySpecularDepth

 

GetRaySpecularDepth

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the specular ancestry depth for a specified ray.  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

specdepth = GetRaySpecularDepth ( id )

 

Parameters

specdepth (Long)

Returns the specular ancestry depth for the specific ray.

 

id As Long (or Huge_)

Identifier for the ray.

 

Remarks

This function retrieves the specular ancestry depth for a specified ray.  If there is a problem, the function toggles an error and returns -1.

 

The specular ancestry depth is the number of generations of specular splitting for the ray.  For example, if the ray has split once from a specular ray, then its specular ancestry depth is 1.  If the ray has specularly split from a ray that has specularly split once, then the specular ancestry depth is 2.  And so on.

 

See Also

GetRayScatterDepth

GetRayIntersects

GetRaySource

GetRayParent

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC