Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayCoherent

 

GetRayCoherent

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves certain coherent information from a particular 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

GetRayCoherent id, secondaryRayScale, secondaryRayCount

 

Parameters

id As Long (or Huge_)

The identifier of the ray.

 

secondaryRayScale As Double

Returns the parabasal scale factor for the specified ray.

 

secondaryRayCount As Long

Returns the number of parabasal rays from the specified ray.

 

Remarks

This subroutine retrieves certain coherent information from a particular ray in the ray buffer. If there is a problem the subroutine does not set an error and returns without modifying the parameters. If the ray is not coherent, secondaryRayScale is set to 1.0 and secondaryRayCount is set to 0.

 

See Also

SetRayCoherent

T_RAYCOHERENT

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC