Navigation: Scripting Reference Manual > Functions & Subroutines > IsRayLive

 

IsRayLive

 

Contact Us: fredsupport@photonengr.com

 

Description

Tests whether a ray is "Live".  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

live = IsRayLive( id )

 

Parameters

live (Boolean)

Returns True if ray is "Live", False otherwise.

 

id As Long (or Huge_)

Ray identifier number.

 

Remarks

Queries a ray's "Live" attribute. See Multi-threaded Raytrace for a detailed explanation of the meaning of a "Live" ray. This attribute is related to the allocation of rays to different CPUs during multi-threaded raytracing and their subsequent splitting. 

 

See Also

GetLiveRayCount

GetAuxRayBufferLiveRayCount

GetRayBufferLiveRayCount

Multi-threaded Raytrace

 

 

 

 

 

Copyright © Photon Engineering, LLC