Open 3D Engine GradientSignal 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.
GradientSignal::ImageGradientConfig Class Reference

Inherits AZ::ComponentConfig.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ImageGradientConfig, AZ::SystemAllocator)
 
 AZ_RTTI (ImageGradientConfig, "{1BDB5DA4-A4A8-452B-BE6D-6BD451D4E7CD}", AZ::ComponentConfig)
 
bool GetManualScaleVisibility () const
 
bool IsImageAssetReadOnly () const
 
bool AreImageOptionsReadOnly () const
 
AZStd::string GetImageAssetPropertyName () const
 
void SetImageAssetPropertyName (const AZStd::string &imageAssetPropertyName)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

AZ::Data::Asset< AZ::RPI::StreamingImageAsset > m_imageAsset = { AZ::Data::AssetLoadBehavior::QueueLoad }
 The image asset used for the image gradient.
 
AZ::Vector2 m_tiling = AZ::Vector2::CreateOne()
 How often the image should repeat within its shape bounds.
 
ChannelToUse m_channelToUse = ChannelToUse::Red
 Which color channel to use from the image.
 
AZ::u32 m_mipIndex = 0
 Which mipmap level to use from the image.
 
CustomScaleType m_customScaleType = CustomScaleType::None
 Scale type to apply to the image data. (Auto = auto-scale data to use full 0-1 range, Manual = use scaleRangeMin/Max)
 
float m_scaleRangeMin = 0.0f
 
float m_scaleRangeMax = 1.0f
 
SamplingType m_samplingType = SamplingType::Point
 Which sampling method to use for querying gradient values (Point = exact image data, Bilinear = interpolated image data)
 
int m_numImageModificationsActive = 0
 The number of active image modification sessions.
 
AZStd::string m_imageAssetPropertyLabel = "Image Asset"
 Label to use for the image asset. This gets modified to show current asset loading/processing state.
 

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