Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayIsFailed

 

GetRayIsFailed

 

Contact Us: fredsupport@photonengr.com

 

Description

Determines if a specified ray has failed with a warning or error during the raytrace.  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

failed = GetRayIsFailed ( id )

 

Parameters

failed (Boolean)

Indicates if the ray failed (True) or not (False).

 

id As Long (or Huge_)

The identifier of the ray.

 

Remarks

This function determines if a particular ray number has failed for some reason. If the ray has failed the function returns True, if not, False. If ray is not a valid ray identifier, the function returns False.

 

See Also

GetRayFailCode

GetRayWhyFailed

Examples

 

 

 

 

 

Copyright © Photon Engineering, LLC