AZ::Render::ImageBasedLightFeatureProcessorInterface Class Reference

This feature processor handles image based lights. More...

#include <ImageBasedLightFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

Inherited by AZ::Render::ImageBasedLightFeatureProcessor.

Public Member Functions
	AZ_RTTI (AZ::Render::ImageBasedLightFeatureProcessorInterface, "{EE7441A3-B406-4717-8F35-E3DAC60E3BDB}", AZ::RPI::FeatureProcessor)
virtual void	SetSpecularImage (const Data::Asset< RPI::StreamingImageAsset > &imageAsset)=0
	Sets the global specular IBL image for this scene.
virtual void	SetDiffuseImage (const Data::Asset< RPI::StreamingImageAsset > &imageAsset)=0
	Sets the global diffuse IBL image for this scene.
virtual void	SetExposure (float exposure)=0
	Sets the exposure value in stops for the global IBL. 0 = no change. Final intensity = intensity * 2^exposure.
virtual void	SetOrientation (const Quaternion &orientation)=0
	Sets the orientation of the global IBL.
virtual const Data::Instance< RPI::Image > &	GetSpecularImage () const =0
	Returns the global specular IBL image for this scene.
virtual const Data::Instance< RPI::Image > &	GetDiffuseImage () const =0
	Returns the global diffuse IBL image for this scene.
virtual float	GetExposure () const =0
	Returns the exposure value in stops for the global IBL.
virtual const Quaternion &	GetOrientation () const =0
	Returns the orientation of the global IBL.
virtual void	Reset ()=0
	Resets the images and exposure back to default (unset) values.
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	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 ()

Additional Inherited Members
Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void	EnableSceneNotification ()
void	DisableSceneNotification ()

Detailed Description

This feature processor handles image based lights.

Member Function Documentation

GetDiffuseImage()

virtual const Data::Instance< RPI::Image > & AZ::Render::ImageBasedLightFeatureProcessorInterface::GetDiffuseImage ( ) const

pure virtual

Returns the global diffuse IBL image for this scene.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

GetExposure()

virtual float AZ::Render::ImageBasedLightFeatureProcessorInterface::GetExposure ( ) const

pure virtual

Returns the exposure value in stops for the global IBL.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

GetOrientation()

virtual const Quaternion & AZ::Render::ImageBasedLightFeatureProcessorInterface::GetOrientation ( ) const

pure virtual

Returns the orientation of the global IBL.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

GetSpecularImage()

virtual const Data::Instance< RPI::Image > & AZ::Render::ImageBasedLightFeatureProcessorInterface::GetSpecularImage ( ) const

pure virtual

Returns the global specular IBL image for this scene.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

Reset()

virtual void AZ::Render::ImageBasedLightFeatureProcessorInterface::Reset ( )

pure virtual

Resets the images and exposure back to default (unset) values.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

SetDiffuseImage()

virtual void AZ::Render::ImageBasedLightFeatureProcessorInterface::SetDiffuseImage ( const Data::Asset< RPI::StreamingImageAsset > &  imageAsset )

pure virtual

Sets the global diffuse IBL image for this scene.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

SetExposure()

virtual void AZ::Render::ImageBasedLightFeatureProcessorInterface::SetExposure ( float  exposure )

pure virtual

Sets the exposure value in stops for the global IBL. 0 = no change. Final intensity = intensity * 2^exposure.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

SetOrientation()

virtual void AZ::Render::ImageBasedLightFeatureProcessorInterface::SetOrientation ( const Quaternion &  orientation )

pure virtual

Sets the orientation of the global IBL.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

SetSpecularImage()

virtual void AZ::Render::ImageBasedLightFeatureProcessorInterface::SetSpecularImage ( const Data::Asset< RPI::StreamingImageAsset > &  imageAsset )

pure virtual

Sets the global specular IBL image for this scene.

Implemented in AZ::Render::ImageBasedLightFeatureProcessor.

---

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

• Gems/Atom/Feature/Common/Code/Include/Atom/Feature/ImageBasedLights/ImageBasedLightFeatureProcessorInterface.h