Open 3D Engine Atom Gem API Reference 25.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
AZ::Render::SkyBoxFeatureProcessor Class Referencefinal

Inherits AZ::Render::SkyBoxFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (AZ::Render::SkyBoxFeatureProcessor, "{CB7D1F95-2A02-4152-86F1-BB29DC802CF7}", AZ::Render::SkyBoxFeatureProcessorInterface)
 
void Activate () override
 FeatureProcessor.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const FeatureProcessor::SimulatePacket &packet) override
 
void Render (const FeatureProcessor::RenderPacket &packet) override
 
void Enable (bool enable) override
 
bool IsEnabled () override
 
void SetSkyboxMode (SkyBoxMode mode) override
 
void SetFogSettings (const SkyBoxFogSettings &fogSettings) override
 
void SetFogEnabled (bool enable) override
 
bool IsFogEnabled () override
 
void SetFogColor (const AZ::Color &color) override
 
void SetFogTopHeight (float topHeight) override
 
void SetFogBottomHeight (float bottomHeight) override
 
void SetCubemapRotationMatrix (AZ::Matrix4x4 matrix) override
 
void SetCubemap (Data::Instance< RPI::Image > cubemap) override
 
void SetCubemapExposure (float exposure) override
 
void SetSunPosition (SunPosition sunPosition) override
 
void SetSunPosition (float azimuth, float altitude) override
 
void SetTurbidity (int turbidity) override
 
void SetSkyIntensity (float intensity, PhotometricUnit unit) override
 
void SetSunIntensity (float intensity, PhotometricUnit unit) override
 
void SetSunRadiusFactor (float factor) override
 
- Public Member Functions inherited from AZ::Render::SkyBoxFeatureProcessorInterface
 AZ_RTTI (AZ::Render::SkyBoxFeatureProcessorInterface, "{71061869-1190-4451-A337-E9CFF16441B4}", AZ::RPI::FeatureProcessor)
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
Scene * GetParentScene () const
 
virtual void ApplyRenderPipelineChange (RenderPipeline *pipeline)
 
virtual void AddRenderPasses (RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)
 
virtual void Simulate (const SimulatePacket &)
 
virtual void Render (const RenderPacket &)
 
virtual void OnEndCulling (const RenderPacket &)
 
virtual void OnRenderEnd ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void EnableSceneNotification ()
 
void DisableSceneNotification ()
 

Member Function Documentation

◆ Activate()

void AZ::Render::SkyBoxFeatureProcessor::Activate ( )
overridevirtual

FeatureProcessor.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Deactivate()

void AZ::Render::SkyBoxFeatureProcessor::Deactivate ( )
overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Enable()

void AZ::Render::SkyBoxFeatureProcessor::Enable ( bool  enable)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ IsEnabled()

bool AZ::Render::SkyBoxFeatureProcessor::IsEnabled ( )
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ IsFogEnabled()

bool AZ::Render::SkyBoxFeatureProcessor::IsFogEnabled ( )
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetCubemap()

void AZ::Render::SkyBoxFeatureProcessor::SetCubemap ( Data::Instance< RPI::Image >  cubemap)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetCubemapExposure()

void AZ::Render::SkyBoxFeatureProcessor::SetCubemapExposure ( float  exposure)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetCubemapRotationMatrix()

void AZ::Render::SkyBoxFeatureProcessor::SetCubemapRotationMatrix ( AZ::Matrix4x4  matrix)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetFogBottomHeight()

void AZ::Render::SkyBoxFeatureProcessor::SetFogBottomHeight ( float  bottomHeight)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetFogColor()

void AZ::Render::SkyBoxFeatureProcessor::SetFogColor ( const AZ::Color &  color)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetFogEnabled()

void AZ::Render::SkyBoxFeatureProcessor::SetFogEnabled ( bool  enable)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetFogSettings()

void AZ::Render::SkyBoxFeatureProcessor::SetFogSettings ( const SkyBoxFogSettings &  fogSettings)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetFogTopHeight()

void AZ::Render::SkyBoxFeatureProcessor::SetFogTopHeight ( float  topHeight)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetSkyboxMode()

void AZ::Render::SkyBoxFeatureProcessor::SetSkyboxMode ( SkyBoxMode  mode)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetSkyIntensity()

void AZ::Render::SkyBoxFeatureProcessor::SetSkyIntensity ( float  intensity,
PhotometricUnit  unit 
)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetSunIntensity()

void AZ::Render::SkyBoxFeatureProcessor::SetSunIntensity ( float  intensity,
PhotometricUnit  unit 
)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetSunPosition() [1/2]

void AZ::Render::SkyBoxFeatureProcessor::SetSunPosition ( float  azimuth,
float  altitude 
)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetSunPosition() [2/2]

void AZ::Render::SkyBoxFeatureProcessor::SetSunPosition ( SunPosition  sunPosition)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetSunRadiusFactor()

void AZ::Render::SkyBoxFeatureProcessor::SetSunRadiusFactor ( float  factor)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

◆ SetTurbidity()

void AZ::Render::SkyBoxFeatureProcessor::SetTurbidity ( int  turbidity)
overridevirtual

Implements AZ::Render::SkyBoxFeatureProcessorInterface.

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