CryEngine.RenderLight

Public Member Functions | Properties | List of all members

Public Member Functions
void	AcquireResources ()
	Safely acquires the data of this RenderLight. More...

void	DropResources ()
	Safely releases the data of this RenderLight. More...

Properties
Color	BaseColor `[get, set]`
	The base Color of this RenderLight. The alpha value is ignored. More...

Matrix3x4	BaseObjMatrix `[get, set]`
	The base object matrix of this RenderLight. More...

Vector3	BaseOrigin `[get, set]`
	The position of this RenderLight in world-space. More...

float	BaseSpecMult `[get, set]`
	The base specular multiplier. More...

Color	Color `[get, set]`
	The Color of this RenderLight. The alpha is ignored. More...

float	AreaHeight `[get, set]`
	The area height of this RenderLight. More...

float	AreaWidth `[get, set]`
	The area width of this RenderLight. More...

float	AttenuationBulbSize `[get, set]`
	The bulb size of the attenuation. More...

float	ClipRadius `[get, set]`
	The clipping radius. More...

float	BoxHeight `[get, set]`
	The environment probe box height of this RenderLight. More...

float	BoxLength `[get, set]`
	The environment probe box length of this RenderLight. More...

float	BoxWidth `[get, set]`
	The environment probe box width of this RenderLight. More...

float	FogRadialLobe `[get, set]`
	The blend ratio of two radial lobe for volumetric fog. More...

DynamicLightFlags	Flags `[get, set]`
	The flags of this RenderLight. More...

float	LightFrustumAngle `[get, set]`
	The light frustrum angle of the projector. More...

float	ProjectorNearPlane `[get, set]`
	The near plane of the projector. More...

float	Radius `[get, set]`
	The radius of the light. More...

float	ShadowBias `[get, set]`
	The shadow bias of the shadow map. More...

float	ShadowResolutionScale `[get, set]`
	The resolution scale of the shadow map. More...

float	ShadowSlopeBias `[get, set]`
	The slope bias of the shadow map. More...

float	ShadowUpdateMinRadius `[get, set]`
	The minimal update radius of the shadow map. More...

float	TimeScrubbed `[get, set]`
	The time the light was scrubbed. More...

short	Id `[get, set]`
	The ID of the light. More...

byte	LensOpticsFrustumAngle `[get, set]`
	Frustum angle ranging from 0 to 255. The range will be adjusted from 0 to 360 when used. More...

uint	Engine3DUpdateFrameID `[get, set]`
	Frame ID of the Engine3D update. More...

byte	AnimationSpeed `[get, set]`
	The animation speed of the light. More...

byte	AttenuationFalloffMax `[get, set]`
	The maximum attenuation falloff of the environment probe. More...

EntitySystem.EntityId	EntityId `[get, set]`
	The ID of the entity. More...

byte	LightPhase `[get, set]`
	The phase of the light. More...

byte	LightStyle `[get, set]`
	The style of the light. More...

ushort	ShadowMinResolution `[get, set]`
	The minimum shadow resolution of the shadow map. More...

ushort	ShadowUpdateRatio `[get, set]`
	The update ratio of the shadow map. More...

byte	SortPriority `[get, set]`
	The sorting priority of the environemt probe. More...

Matrix3x4	ObjectMatrix `[get, set]`
	The object matrix of the projector. More...

Vector3	Position `[get, set]`
	The world space position of the RenderLight. More...

Vector3	ProbeExtents `[get, set]`
	The extents of the environment probe. More...

Matrix4x4	ProjectionMatrix `[get, set]`
	The projection matrix of the projector. More...

byte	ShadowMaskIndex `[get, set]`
	The index of the shadow mask of the shadow map. More...

short	Height `[get, set]`
	The height of the RenderLight. More...

string	Name `[get, set]`
	Optional name of the light source. More...

float	SpecularMultiplier `[get, set]`
	The specular multiplier. More...

short	Width `[get, set]`
	The width of the RenderLight. More...

short	X `[get, set]`
	Scissor parameters (2d extent). More...

short	Y `[get, set]`
	Scissor parameters (2d extent). More...

Detailed Description

Base class for a RenderLight.

Member Function Documentation

◆ AcquireResources()

void CryEngine.RenderLight.AcquireResources

(

)

inline

Safely acquires the data of this RenderLight.

◆ DropResources()

void CryEngine.RenderLight.DropResources

(

)

inline

Safely releases the data of this RenderLight.

Property Documentation

◆ AnimationSpeed

byte CryEngine.RenderLight.AnimationSpeed

get

set

The animation speed of the light.

◆ AreaHeight

float CryEngine.RenderLight.AreaHeight

get

set

The area height of this RenderLight.

◆ AreaWidth

float CryEngine.RenderLight.AreaWidth

get

set

The area width of this RenderLight.

◆ AttenuationBulbSize

float CryEngine.RenderLight.AttenuationBulbSize

get

set

The bulb size of the attenuation.

◆ AttenuationFalloffMax

byte CryEngine.RenderLight.AttenuationFalloffMax

get

set

The maximum attenuation falloff of the environment probe.

◆ BaseColor

Color CryEngine.RenderLight.BaseColor

get

set

The base Color of this RenderLight. The alpha value is ignored.

The base color.

◆ BaseObjMatrix

Matrix3x4 CryEngine.RenderLight.BaseObjMatrix

get

set

The base object matrix of this RenderLight.

The base object matrix.

◆ BaseOrigin

Vector3 CryEngine.RenderLight.BaseOrigin

get

set

The position of this RenderLight in world-space.

The world-space position.

◆ BaseSpecMult

float CryEngine.RenderLight.BaseSpecMult

get

set

The base specular multiplier.

◆ BoxHeight

float CryEngine.RenderLight.BoxHeight

get

set

The environment probe box height of this RenderLight.

◆ BoxLength

float CryEngine.RenderLight.BoxLength

get

set

The environment probe box length of this RenderLight.

◆ BoxWidth

float CryEngine.RenderLight.BoxWidth

get

set

The environment probe box width of this RenderLight.

◆ ClipRadius

float CryEngine.RenderLight.ClipRadius

get

set

The clipping radius.

◆ Color

Color CryEngine.RenderLight.Color

get

set

The Color of this RenderLight. The alpha is ignored.

The color.

◆ Engine3DUpdateFrameID

uint CryEngine.RenderLight.Engine3DUpdateFrameID

get

set

Frame ID of the Engine3D update.

◆ EntityId

EntitySystem.EntityId CryEngine.RenderLight.EntityId

get

set

The ID of the entity.

◆ Flags

DynamicLightFlags CryEngine.RenderLight.Flags

get

set

The flags of this RenderLight.

◆ FogRadialLobe

float CryEngine.RenderLight.FogRadialLobe

get

set

The blend ratio of two radial lobe for volumetric fog.

◆ Height

short CryEngine.RenderLight.Height

get

set

The height of the RenderLight.

◆ Id

short CryEngine.RenderLight.Id

get

set

The ID of the light.

◆ LensOpticsFrustumAngle

byte CryEngine.RenderLight.LensOpticsFrustumAngle

get

set

Frustum angle ranging from 0 to 255. The range will be adjusted from 0 to 360 when used.

◆ LightFrustumAngle

float CryEngine.RenderLight.LightFrustumAngle

get

set

The light frustrum angle of the projector.

◆ LightPhase

byte CryEngine.RenderLight.LightPhase

get

set

The phase of the light.

◆ LightStyle

byte CryEngine.RenderLight.LightStyle

get

set

The style of the light.

◆ Name

string CryEngine.RenderLight.Name

get

set

Optional name of the light source.

◆ ObjectMatrix

Matrix3x4 CryEngine.RenderLight.ObjectMatrix

get

set

The object matrix of the projector.

◆ Position

Vector3 CryEngine.RenderLight.Position

get

set

The world space position of the RenderLight.

◆ ProbeExtents

Vector3 CryEngine.RenderLight.ProbeExtents

get

set

The extents of the environment probe.

◆ ProjectionMatrix

Matrix4x4 CryEngine.RenderLight.ProjectionMatrix

get

set

The projection matrix of the projector.

◆ ProjectorNearPlane

float CryEngine.RenderLight.ProjectorNearPlane

get

set

The near plane of the projector.

◆ Radius

float CryEngine.RenderLight.Radius

get

set

The radius of the light.

◆ ShadowBias

float CryEngine.RenderLight.ShadowBias

get

set

The shadow bias of the shadow map.

◆ ShadowMaskIndex

byte CryEngine.RenderLight.ShadowMaskIndex

get

set

The index of the shadow mask of the shadow map.

◆ ShadowMinResolution

ushort CryEngine.RenderLight.ShadowMinResolution

get

set

The minimum shadow resolution of the shadow map.

◆ ShadowResolutionScale

float CryEngine.RenderLight.ShadowResolutionScale

get

set

The resolution scale of the shadow map.

◆ ShadowSlopeBias

float CryEngine.RenderLight.ShadowSlopeBias

get

set

The slope bias of the shadow map.

◆ ShadowUpdateMinRadius

float CryEngine.RenderLight.ShadowUpdateMinRadius

get

set

The minimal update radius of the shadow map.

◆ ShadowUpdateRatio

ushort CryEngine.RenderLight.ShadowUpdateRatio

get

set

The update ratio of the shadow map.

◆ SortPriority

byte CryEngine.RenderLight.SortPriority

get

set

The sorting priority of the environemt probe.

◆ SpecularMultiplier

float CryEngine.RenderLight.SpecularMultiplier

get

set

The specular multiplier.

◆ TimeScrubbed

float CryEngine.RenderLight.TimeScrubbed

get

set

The time the light was scrubbed.

◆ Width

short CryEngine.RenderLight.Width

get

set

The width of the RenderLight.

◆ X

short CryEngine.RenderLight.X

get

set

Scissor parameters (2d extent).

◆ Y

short CryEngine.RenderLight.Y

get

set

Scissor parameters (2d extent).