Collaboration diagram for Light API:

Topics
	Trace&Visibility API

Typedefs
typedef int[]	HLIGHT
	Light handle.

Enumerations
enum	LightType { POINT , SPOT , DIRECTIONAL , AMBIENT }

enum	LightFlags { DYNAMIC , CASTSHADOW , CHEAP }

Functions
proto HLIGHT	AddLight (IEntity owner, LightType type, LightFlags flags, float radius, vector color)

proto native bool	RemoveLight (HLIGHT light)
	removes light

proto native bool	SetLightEx (HLIGHT light, float radius, vector color)

proto native bool	SetLightTexture (HLIGHT light, string cubemap)
	sets lookup texture for projection lights

proto native int	SetLightFlags (HLIGHT light, LightFlags flags)

proto native int	ClearLightFlags (HLIGHT light, LightFlags flags)

proto native bool	SetLightCone (HLIGHT light, float cone)
	Sets light cone in degrees (for LightType.SPOT).

proto native float	GetSceneHDRMul (int camera)

Detailed Description

Typedef Documentation

◆ HLIGHT

typedef int [] HLIGHT

Light handle.

Definition at line 119 of file EnWorld.c.

Enumeration Type Documentation

◆ LightFlags

enum LightFlags

Enumerator

DYNAMIC

Dynamic objects are included in the query.

Dynamic light. There is limit 512 dynamic lights per world and 32 per camera view. They are faster when moving and changing shape. Also they are always attached to owner entity

CASTSHADOW

CHEAP

for cheaper dynamic lights, like muzzle flashes (might use cheaper rendering method)

Definition at line 129 of file EnWorld.c.

{
  DYNAMIC,
  CASTSHADOW,
  CHEAP
};

◆ LightType

enum LightType

Enumerator
POINT
SPOT
DIRECTIONAL
AMBIENT

Definition at line 121 of file EnWorld.c.

{
  POINT, //< point light, all directional light
  SPOT, //< spot light, direction is determined by owner (entity)
  DIRECTIONAL,
  AMBIENT
};

Function Documentation

◆ AddLight()

proto HLIGHT AddLight	(	IEntity	owner,
		LightType	type,
		LightFlags	flags,
		float	radius,
		vector	color )

creates light

◆ ClearLightFlags()

proto native int ClearLightFlags	(	HLIGHT	light,
		LightFlags	flags )

◆ GetSceneHDRMul()

proto native float GetSceneHDRMul ( int camera )

scene multiplicator of light (based on measured scene light levels) - preexposure of light

Referenced by GameplayEffectWidgets_base::CalculateBreathEffect().

◆ RemoveLight()

proto native bool RemoveLight ( HLIGHT light )

removes light

◆ SetLightCone()

proto native bool SetLightCone	(	HLIGHT	light,
		float	cone )

Sets light cone in degrees (for LightType.SPOT).

◆ SetLightEx()

proto native bool SetLightEx	(	HLIGHT	light,
		float	radius,
		vector	color )

◆ SetLightFlags()

proto native int SetLightFlags	(	HLIGHT	light,
		LightFlags	flags )

◆ SetLightTexture()

proto native bool SetLightTexture	(	HLIGHT	light,
		string	cubemap )

sets lookup texture for projection lights

Topics

Typedefs

Enumerations

Functions