Assimp v5.2.2 (January 2022)
The Asset-Importer-Lib API documentation.
light.h File Reference

Defines the aiLight data structure. More...

Classes

struct  aiLight
 Helper structure to describe a light source. More...
 

Macros

#define AI_LIGHT_H_INC
 

Enumerations

enum  aiLightSourceType {
  aiLightSource_UNDEFINED = 0x0 , aiLightSource_DIRECTIONAL = 0x1 , aiLightSource_POINT = 0x2 , aiLightSource_SPOT = 0x3 ,
  aiLightSource_AMBIENT = 0x4 , aiLightSource_AREA = 0x5 , _aiLightSource_Force32Bit = INT_MAX
}
 Enumerates all supported types of light sources. More...
 

Detailed Description

Defines the aiLight data structure.

Macro Definition Documentation

◆ AI_LIGHT_H_INC

#define AI_LIGHT_H_INC

Enumeration Type Documentation

◆ aiLightSourceType

Enumerates all supported types of light sources.

Enumerator
aiLightSource_UNDEFINED 
aiLightSource_DIRECTIONAL 

A directional light source has a well-defined direction but is infinitely far away.

That's quite a good approximation for sun light.

aiLightSource_POINT 

A point light source has a well-defined position in space but no direction - it emits light in all directions.

A normal bulb is a point light.

aiLightSource_SPOT 

A spot light source emits light in a specific angle.

It has a position and a direction it is pointing to. A good example for a spot light is a light spot in sport arenas.

aiLightSource_AMBIENT 

The generic light level of the world, including the bounces of all other light sources.

Typically, there's at most one ambient light in a scene. This light type doesn't have a valid position, direction, or other properties, just a color.

aiLightSource_AREA 

An area light is a rectangle with predefined size that uniformly emits light from one of its sides.

The position is center of the rectangle and direction is its normal vector.

_aiLightSource_Force32Bit 

This value is not used.

It is just there to force the compiler to map this enum to a 32 Bit integer.