LensFlare Class Reference
Add lens flare effects to the camera output as a render pass. More...
#include <gz/sim/systems/LensFlare.hh>
Public Member Functions | |
| LensFlare () | |
| Constructor. More... | |
| ~LensFlare () override=default | |
| Destructor. More... | |
| void | Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override |
| Document Inherited. More... | |
 Public Member Functions inherited from System | |
| System ()=default | |
| Constructor. More... | |
| virtual | ~System ()=default |
| Destructor. More... | |
Additional Inherited Members | |
| Public Types inherited from System | |
| using | PriorityType = int32_t |
| Signed integer type used for specifying priority of the execution order of PreUpdate and Update phases. More... | |
| Static Public Attributes inherited from System | |
| constexpr static PriorityType | kDefaultPriority = {0} |
| Default priority value for execution order of the PreUpdate and Update phases. More... | |
| constexpr static std::string_view | kPriorityElementName |
| Name of the XML element from which the priority value will be parsed. More... | |
Detailed Description
Add lens flare effects to the camera output as a render pass.
System Parameters
<scale>: Sets the scale of the lens flare. If this is not specified, the value defaults to 1.0<color>: Sets the color of the lens flare. The default is {1.4, 1.2, 1.0}<occlusion_steps>: Sets the number of steps to take in each direction to check for occlusions. The default value is set to 10. Use 0 to disable<light_name>: Sets the light associated with the lens flares. If not specified. The first light in the scene will be used.
Constructor & Destructor Documentation
◆ LensFlare()
| LensFlare | ( | ) |
Constructor.
◆ ~LensFlare()
|
overridedefault |
Destructor.
Member Function Documentation
◆ Configure()
|
overridevirtual |
Document Inherited.
Implements ISystemConfigure.
The documentation for this class was generated from the following file: