All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Illumination Feature

Classes

struct  VuIlluminationConfig
 Configuration for illumination observer creation. More...
 
struct  VuIlluminationObservationInfo
 Illumination information for rendering. More...
 

Enumerations

enum  VuIlluminationCreationError : int32_t {
  VU_ILLUMINATION_CREATION_ERROR_NONE = 0x0 ,
  VU_ILLUMINATION_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_ILLUMINATION_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2
}
 Configuration error for Illumination observer creation. More...
 
enum  { VU_ILLUMINATION_AMBIENT_INTENSITY_UNAVAILABLE = -1 }
 
enum  { VU_ILLUMINATION_AMBIENT_COLOR_TEMPERATURE_UNAVAILABLE = -1 }
 
enum  { VU_OBSERVER_ILLUMINATION_TYPE = 0xB }
 
enum  { VU_OBSERVATION_ILLUMINATION_TYPE = 0xB }
 

Functions

VuIlluminationConfig vuIlluminationConfigDefault ()
 Default illumination observer configuration.
 
VuResult vuEngineCreateIlluminationObserver (VuEngine *engine, VuObserver **observer, const VuIlluminationConfig *config, VuIlluminationCreationError *errorCode)
 Create an illumination observer.
 
VuResult vuEngineGetIlluminationObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all target illumination observers.
 
VuResult vuStateGetIlluminationObservations (const VuState *state, VuObservationList *observationList)
 Get all illumination observations.
 
VuResult vuIlluminationObservationGetInfo (const VuObservation *observation, VuIlluminationObservationInfo *illuminationInfo)
 Get info associated with an illumination observation.
 

Detailed Description

Enumeration Type Documentation

◆ VuIlluminationCreationError

Configuration error for Illumination observer creation.

Enumerator
VU_ILLUMINATION_CREATION_ERROR_NONE 

No error.

VU_ILLUMINATION_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_ILLUMINATION_CREATION_ERROR_AUTOACTIVATION_FAILED 

An error occurred while auto-activating the observer.

◆ anonymous enum

anonymous enum
Enumerator
VU_ILLUMINATION_AMBIENT_INTENSITY_UNAVAILABLE 

Value used in the VuIlluminationObservationInfo data structure to indicate that scene ambient intensity is not supported on the current platform.

◆ anonymous enum

anonymous enum
Enumerator
VU_ILLUMINATION_AMBIENT_COLOR_TEMPERATURE_UNAVAILABLE 

Value used in the VuIlluminationObservationInfo data structure to indicate that scene ambient color temperature is not supported on the current platform.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVER_ILLUMINATION_TYPE 

Type identifier for illumination observers.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVATION_ILLUMINATION_TYPE 

Type identifier for illumination observations.

Function Documentation

◆ vuIlluminationConfigDefault()

VuIlluminationConfig vuIlluminationConfigDefault ( )

Default illumination observer configuration.

Note
Use this function to initialize the VuIlluminationConfig data structure with default values.