Open 3D Engine Atom Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
The asset for attachment image which is mainly used to create runtime attachment instance. More...
#include <AttachmentImageAsset.h>
Inherits AZ::RPI::ImageAsset.
Public Member Functions | |
AZ_RTTI (AttachmentImageAsset, "{82CEA86B-E891-4969-8F35-D8017E8902C8}", ImageAsset) | |
AZ_CLASS_ALLOCATOR (AttachmentImageAsset, AZ::SystemAllocator) | |
const Data::Asset< ResourcePoolAsset > & | GetPoolAsset () const |
const RHI::ClearValue * | GetOptimizedClearValue () const |
Return the clear value of the image. The clear value may only be useful for certain type of images such as render targets (color/depth stencil). | |
const AZ::Name & | GetName () const |
Return the name which can be used as debug name. | |
RHI::AttachmentId | GetAttachmentId () const |
Return an unique name id which can be used as attachment id. | |
bool | HasUniqueName () const |
![]() | |
AZ_RTTI (ImageAsset, "{C53AB73A-5BC9-462D-805B-43BAFA8C8167}", Data::AssetData) | |
AZ_CLASS_ALLOCATOR (ImageAsset, AZ::SystemAllocator) | |
const RHI::ImageDescriptor & | GetImageDescriptor () const |
Returns the descriptor for the image. | |
const RHI::ImageViewDescriptor & | GetImageViewDescriptor () const |
Returns the default image view descriptor for the image. | |
Static Public Member Functions | |
static void | Reflect (AZ::ReflectContext *context) |
![]() | |
static void | Reflect (AZ::ReflectContext *context) |
Static Public Attributes | |
static const char * | DisplayName |
static const char * | Group |
static const char * | Extension |
![]() | |
static const char * | DisplayName |
static const char * | Group |
static const char * | Extension |
Friends | |
class | AttachmentImageAssetCreator |
Additional Inherited Members | |
![]() | |
void | SetReady () |
![]() | |
RHI::ImageDescriptor | m_imageDescriptor |
RHI::ImageViewDescriptor | m_imageViewDescriptor |
The asset for attachment image which is mainly used to create runtime attachment instance.
bool AZ::RPI::AttachmentImageAsset::HasUniqueName | ( | ) | const |
Return ture if the attachment image has an unique name An attachment image with an unique name will be registered to image system and it can be found by ImageSystemInterface::FindRegisteredAttachmentImage() function The unique name is same as its attachment Id