Open 3D Engine SkyAtmosphere Gem API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Member Functions | Static Public Member Functions | List of all members
SkyAtmosphere::SkyAtmosphereFeatureProcessor Class Referencefinal

#include <SkyAtmosphereFeatureProcessor.h>

Inherits SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (SkyAtmosphereFeatureProcessor, "{FB3155E9-BA3C-487B-B251-EB4BF3465E02}", SkyAtmosphereFeatureProcessorInterface)
 
void Activate () override
 FeatureProcessor.
 
void Deactivate () override
 
void AddRenderPasses (AZ::RPI::RenderPipeline *renderPipeline) override
 
void Render (const RenderPacket &packet) override
 
AtmosphereId CreateAtmosphere () override
 SkyAtmosphereFeatureProcessorInterface.
 
void ReleaseAtmosphere (AtmosphereId id) override
 
void SetAtmosphereParams (AtmosphereId id, const SkyAtmosphereParams &params) override
 
void SetAtmosphereEnabled (AtmosphereId id, bool enabled) override
 
bool GetAtmosphereEnabled (AtmosphereId id) override
 
- Public Member Functions inherited from SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface
 AZ_RTTI (SkyAtmosphereFeatureProcessorInterface, "{00C9FD3D-2A1B-49EA-97E3-952EF6C1C451}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Public Types inherited from SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface
using AtmosphereId = AZ::RHI::Handle< uint16_t, SkyAtmosphereFeatureProcessorInterface >
 

Detailed Description

This feature processor manages drawing sky atmospheres. Use CreateAtmosphere() to create a new atmosphere

Member Function Documentation

◆ CreateAtmosphere()

AtmosphereId SkyAtmosphere::SkyAtmosphereFeatureProcessor::CreateAtmosphere ( )
overridevirtual

SkyAtmosphereFeatureProcessorInterface.

Implements SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface.

◆ GetAtmosphereEnabled()

bool SkyAtmosphere::SkyAtmosphereFeatureProcessor::GetAtmosphereEnabled ( AtmosphereId  id)
overridevirtual

Implements SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface.

◆ ReleaseAtmosphere()

void SkyAtmosphere::SkyAtmosphereFeatureProcessor::ReleaseAtmosphere ( AtmosphereId  id)
overridevirtual

Implements SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface.

◆ SetAtmosphereEnabled()

void SkyAtmosphere::SkyAtmosphereFeatureProcessor::SetAtmosphereEnabled ( AtmosphereId  id,
bool  enabled 
)
overridevirtual

Implements SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface.

◆ SetAtmosphereParams()

void SkyAtmosphere::SkyAtmosphereFeatureProcessor::SetAtmosphereParams ( AtmosphereId  id,
const SkyAtmosphereParams &  params 
)
overridevirtual

Implements SkyAtmosphere::SkyAtmosphereFeatureProcessorInterface.

The documentation for this class was generated from the following file: