The class to create an attachment image asset. More...
#include <AttachmentImageAssetCreator.h>
Inherits AZ::RPI::AssetCreator< AttachmentImageAsset >.
Public Member Functions | |
void | Begin (const Data::AssetId &assetId) |
void | SetImageDescriptor (const RHI::ImageDescriptor &imageDescriptor) |
Assigns the default image descriptor. Required. | |
void | SetImageViewDescriptor (const RHI::ImageViewDescriptor &imageViewDescriptor) |
Assigns the default image view descriptor. Optional. | |
void | SetOptimizedClearValue (const RHI::ClearValue &clearValue) |
Assigns clear value for the image asset. Optional. | |
void | SetPoolAsset (const Data::Asset< ResourcePoolAsset > &poolAsset) |
Assigns the attachment image pool, which the runtime attachment image will allocate from. Required. | |
void | SetAssetHint (AZStd::string_view hint) |
void | SetName (const AZ::Name &name, bool isUniqueName) |
bool | End (Data::Asset< AttachmentImageAsset > &result) |
Public Member Functions inherited from AZ::RPI::AssetCreator< AttachmentImageAsset > | |
void | SetElevateWarnings (bool elevated) |
When true, treat all subsequent warnings as errors. Any warnings already reported will not be elevated. | |
bool | GetElevateWarnings () const |
int | GetErrorCount () const |
int | GetWarningCount () const |
bool | IsFailed () const |
void | ReportError (const char *format, Args... args) |
void | ReportWarning (const char *format, Args... args) |
Additional Inherited Members | |
Protected Member Functions inherited from AZ::RPI::AssetCreator< AttachmentImageAsset > | |
AZ_DISABLE_COPY_MOVE (AssetCreator) | |
void | BeginCommon (const Data::AssetId &assetId) |
bool | EndCommon (Data::Asset< AttachmentImageAsset > &result) |
bool | ValidateIsReady () |
bool | ValidateNotNull (void *pointer, const char *name) |
Reports errors when a pointer is null. | |
bool | ValidateNotNull (const AZ::Data::Asset< AZ::Data::AssetData > &pointer, const char *name) |
bool | ValidateNotNull (const AZStd::intrusive_ptr< T > &pointer, const char *name) |
Protected Attributes inherited from AZ::RPI::AssetCreator< AttachmentImageAsset > | |
Data::Asset< AttachmentImageAsset > | m_asset |
This is the asset that subclass creators will build. | |
The class to create an attachment image asset.
void AZ::RPI::AttachmentImageAssetCreator::Begin | ( | const Data::AssetId & | assetId | ) |
Begins construction of a new attachment image asset instance. Resets the builder to a fresh state. assetId the unique id to use when creating the asset.
bool AZ::RPI::AttachmentImageAssetCreator::End | ( | Data::Asset< AttachmentImageAsset > & | result | ) |
Finalizes and assigns ownership of the asset to result, if successful. Otherwise false is returned and result is left untouched.
void AZ::RPI::AttachmentImageAssetCreator::SetAssetHint | ( | AZStd::string_view | hint | ) |
void AZ::RPI::AttachmentImageAssetCreator::SetName | ( | const AZ::Name & | name, |
bool | isUniqueName | ||
) |
Set a name for this attachment image. This name will be used for AttachmentImage's RHI Image's debug name.
isUniqueName | If true the image will be registered to Image System and the unique need to be unique among other attachment image with unique names. And the image can be found by ImageSystemInterface::FindRegisteredAttachmentImage() function |