Navigation: Scripting Reference Manual > Functions & Subroutines > GetRaySourceRayNumber

 

GetRaySourceRayNumber

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the Source Ray Number for a specified Ray in the Ray Buffer.  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

rayNum = GetRaySourceRayNumber ( id )

 

Parameters

rayNum (Long or Huge_)

The Source Ray Number for the specified Ray, or -1 if there is a problem.

 

id As Long (or Huge_)

Identifier of the ray.

 

Remarks

This subroutine retrieves the Source Ray Number for a specified Ray in the Ray Buffer.  If there is a problem, the function sets an error and returns -1.

 

The Source Ray Number, rayNum, is the n'th ray created by the ray's parent source.

 

See Also

GetRayConsecutiveIntersects

GetRayInitialPower

GetRayPath

ReadRayFile

Examples

Raydata GetSet

Sources

 

 

 

 

 

 

Copyright © Photon Engineering, LLC