Navigation: Scripting Reference Manual > Functions & Subroutines > GetLastRay

 

GetLastRay

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves ray data for the last "Live" ray.  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

success = GetLastRay( id, tr )

 

Parameters

success (Boolean)

Returns True is successful and False if a problem is encountered.

 

id As Long (or Huge_)

This variable is passed in without a value assigned by the user.  After the function executes, the variable value is the index of the last ray in the ray buffer.

 

tr As T_RAY

Structure to be loaded with ray data.

 

Example

The example below shows the standard ray buffer reverse looping construction.

 

Dim success As Boolean

Dim curRay As Long

Dim tRay as T_RAY

 

success = GetLastRay( curRay, tRay )

While success

          'Do something with tRay structure here...

          success = GetPreviousRay( curRay, tRay )

Wend

 

See Also

GetFirstRay

GetNextRay

GetPreviousRay

GetRay

SetRay

SetRayActive

Multi-Threaded Raytrace

 

 

 

 

 

 

Copyright © Photon Engineering, LLC