File Type Pattern Global Memory Globals Table of Contents

"LW Fog Info"

Availability:  LightWave 6.0
Component:  Layout

The fog info global returns information functions and data concerning the fog settings for the scene. The data structure is read-only.

Global Call

   LWFogInfo *foginfo;
   foginfo = global( "LW Fog Info", GFUSE_TRANSIENT );

The global function returns a pointer to an LWFogInfo.

   typedef struct st_LWFogInfo {
      int     type;
      int     flags;
      double (*minDist) (LWTime);
      double (*maxDist) (LWTime);
      double (*minAmt)  (LWTime);
      double (*maxAmt)  (LWTime);
      void   (*color)   (LWTime, double col[3]);
   } LWFogInfo;
type
Describes the kind of falloff for the fog effect. Possible types are

LWFOG_NONE
LWFOG_LINEAR
LWFOG_NONLINEAR1
LWFOG_NONLINEAR2

flags
Returns fog-related flags. Currently the only flag defined for this function is LWFOGF_BACKGROUND, which indicates that fog will affect the backdrop.

amount = minDist( time )
Returns the distance from the viewer (typically the camera) at which the fog effect is at a minimum.

amount = maxDist( time )
Returns the distance at which the fog effect reaches its maximum.

amount = minAmt( time )
Returns the minimum amount of fog (the amount at the minimum distance). Fog amounts range from 0.0 to 1.0.

amount = maxAmt( time )
Returns the maximum amount of fog.

color( time, rgb )
The color of the fog at a given time.