Vertices Engine  v1.9.2.92
A Cross Platform game engine developed by Virtex Edge Design.
Loading...
Searching...
No Matches
VerticesEngine.Graphics.vxLightEntity Class Reference

Base class for a 3D Light Entity used in Defferred Rendering. More...

Inheritance diagram for VerticesEngine.Graphics.vxLightEntity:
VerticesEngine.Graphics.vxDirectionalLight

Public Member Functions

 vxLightEntity (vxGameplayScene3D Scene, Vector3 StartPosition, LightType LightType, Color Colour, float lightRadius, float lightIntensity)
 Initializes a new instance of the T:VerticesEngine.Graphics.vxLightEntity class.
 
virtual void Dispose ()
 
virtual void Update ()
 
virtual void Draw (vxCamera3D Camera)
 

Public Attributes

LightType LightType
 
Vector3 Position
 Location of Entity in world space.
 
Color Color
 The Light Colour.
 
float lightRadius
 
float lightIntensity
 
bool FadeOnDistance = true
 Whether or not the light should fade out at a given distance defined by the NearPlane and FarPlane variables in this class. This is to help with performance. In some instsances though, it may be required or beneficial to keep the light visible always. In those cases, this variable should be set to 'false'.
 
float NearPlane = 50
 The Near Plane of when the Light will being to dim if it get's further away.
 
float FarPlane = 200
 The Far Plane of where after the light will not show.
 
vxGameplayScene3D Scene
 

Detailed Description

Base class for a 3D Light Entity used in Defferred Rendering.

Constructor & Destructor Documentation

◆ vxLightEntity()

VerticesEngine.Graphics.vxLightEntity.vxLightEntity ( vxGameplayScene3D Scene,
Vector3 StartPosition,
LightType LightType,
Color Colour,
float lightRadius,
float lightIntensity )

Initializes a new instance of the T:VerticesEngine.Graphics.vxLightEntity class.

Parameters
EngineEngine.
StartPositionStart position.
LightTypeLight type.
ColourColour.
lightRadiusLight radius.
lightIntensityLight intensity.

The documentation for this class was generated from the following file: