Navigation: Scripting Reference Manual > Functions & Subroutines > GetAuxRayBufferLiveRayCount

 

GetAuxRayBufferLiveRayCount

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the number of live rays in the specified auxiliary buffer.  Standard ray buffers are those resulting from a standard FRED raytrace or which have been created manually in the scripting language.  Auxiliary buffers cannot be created by the user but are the result of specialized raytrace functions such as the single raytrace and targeted raytrace.  Note that auxiliary ray buffers are tied to the GUI dialog that generates them and closing the dialog will delete the ray buffer.  Therefore, script commands which access auxiliary ray buffers must be run with the associated GUI dialog still open.

 

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

count = GetAuxRayBufferLiveRayCount( id )

 

Parameters

count (Long or Huge_)

Number of live rays in the auxiliary buffer specified by id.

 

id As Long

Index of the auxiliary ray buffer being queried.

 

See Also

IsRayLive

GetLiveRayCount

GetRayBufferLiveRayCount

 

 

 

 

 

Copyright © Photon Engineering, LLC