Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
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)
 
virtual void Enable (bool enable)=0
 
virtual bool IsEnabled ()=0
 
virtual void SetSkyboxMode (SkyBoxMode mode)=0
 
virtual void SetFogSettings (const SkyBoxFogSettings &fogSettings)=0
 
virtual void SetCubemap (Data::Instance< RPI::Image > cubemap)=0
 
virtual void SetCubemapExposure (float exposure)=0
 
virtual void SetCubemapRotationMatrix (AZ::Matrix4x4 matrix)=0
 
virtual void SetSunPosition (SunPosition sunPosition)=0
 
virtual void SetSunPosition (float azimuth, float altitude)=0
 
virtual void SetTurbidity (int turbidity)=0
 
virtual void SetSkyIntensity (float intensity, PhotometricUnit type)=0
 
virtual void SetSunIntensity (float intensity, PhotometricUnit type)=0
 
virtual void SetSunRadiusFactor (float factor)=0
 
virtual void SetFogEnabled (bool enable)=0
 
virtual bool IsFogEnabled ()=0
 
virtual void SetFogColor (const AZ::Color &color)=0
 
virtual void SetFogTopHeight (float topHeight)=0
 
virtual void SetFogBottomHeight (float bottomHeight)=0
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
SceneGetParentScene () const
 
virtual void Activate ()
 Perform any necessary activation and gives access to owning Scene.
 
virtual void Deactivate ()
 Perform any necessary deactivation.
 
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

◆ IsEnabled()

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

◆ IsFogEnabled()

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

◆ SetCubemap()

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

◆ SetCubemapExposure()

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

◆ SetCubemapRotationMatrix()

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

◆ SetFogBottomHeight()

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

◆ SetFogColor()

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

◆ SetFogEnabled()

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

◆ SetFogSettings()

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

◆ SetFogTopHeight()

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

◆ SetSkyboxMode()

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

◆ SetSkyIntensity()

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

◆ SetSunIntensity()

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

◆ SetSunPosition() [1/2]

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

◆ SetSunPosition() [2/2]

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

◆ SetSunRadiusFactor()

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

◆ SetTurbidity()

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

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