VerticesEngine.Graphics.vxDirectionalLight Class Reference

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

Inheritance diagram for VerticesEngine.Graphics.vxDirectionalLight:

Public Member Functions
	vxDirectionalLight (vxGameplayScene3D scene, Vector3 LightDirection, Color Colour)
	Initializes a new instance of the VerticesEngine.Graphics.vxDirectionalLight class.
override void	Draw (vxCamera3D Camera)
Public Member Functions inherited from 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.
virtual void	Dispose ()
virtual void	Update ()

Public Attributes
Vector3	LightDirection
	Direction Entity is facing.
Public Attributes inherited from VerticesEngine.Graphics.vxLightEntity
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

vxDirectionalLight()

VerticesEngine.Graphics.vxDirectionalLight.vxDirectionalLight	(	vxGameplayScene3D	scene,
		Vector3	LightDirection,
		Color	Colour )

Initializes a new instance of the VerticesEngine.Graphics.vxDirectionalLight class.

Parameters

Engine	The Vertices Engine Reference.
LightDirection	Light direction.

Member Function Documentation

Draw()

override void VerticesEngine.Graphics.vxDirectionalLight.Draw ( vxCamera3D Camera )

virtual

Reimplemented from VerticesEngine.Graphics.vxLightEntity.

---

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

• /github/workspace/src/VerticesEngine/src.shared/Entities/Lights/vxDirectionalLight.cs