Open 3D Engine Atom Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::DX12::Image Class Referencefinal

Inherits AZ::RHI::Image.

Classes

struct  SubresourceAttachmentState
 

Public Types

using SubresourceRangeAttachmentState = RHI::ImageProperty< D3D12_RESOURCE_STATES >::PropertyRange
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (Image, AZ::SystemAllocator)
 
 AZ_RTTI (Image,"{D2B32EE2-2ED5-477A-8346-95AF0D11DAC8}", Base)
 
const MemoryViewGetMemoryView () const
 
MemoryViewGetMemoryView ()
 
void FinalizeAsyncUpload (uint32_t newStreamedMipLevels)
 
uint32_t GetStreamedMipLevel () const
 
void SetStreamedMipLevel (uint32_t streamedMipLevel)
 
bool IsTiled () const
 
void SetUploadFenceValue (uint64_t fenceValue)
 
uint64_t GetUploadFenceValue () const
 
void SetAttachmentState (D3D12_RESOURCE_STATES state, const RHI::ImageSubresourceRange *range=nullptr)
 
AZStd::vector
< SubresourceRangeAttachmentState
GetAttachmentStateByRange (const RHI::ImageSubresourceRange *range=nullptr) const
 
AZStd::vector
< SubresourceAttachmentState
GetAttachmentStateByIndex (const RHI::ImageSubresourceRange *range=nullptr) const
 
D3D12_RESOURCE_STATES GetInitialResourceState () const
 
- Public Member Functions inherited from AZ::RHI::Image
 AZ_RTTI (Image,"{39FFE66C-805A-41AD-9092-91327D51F64B}", Resource)
 
const ImageDescriptorGetDescriptor () const
 
void GetSubresourceLayouts (const ImageSubresourceRange &subresourceRange, ImageSubresourceLayout *subresourceLayouts, size_t *totalSizeInBytes) const
 
uint32_t GetResidentMipLevel () const
 
HardwareQueueClassMask GetSupportedQueueMask () const
 
const ImageFrameAttachmentGetFrameAttachment () const
 
Ptr< ImageViewGetImageView (const ImageViewDescriptor &imageViewDescriptor)
 
ImageAspectFlags GetAspectFlags () const
 Returns the aspects that are included in the image.
 
const HashValue64 GetHash () const
 Get the hash associated with the passed image descriptor.
 
bool IsStreamable () const
 Returns whether the image has sub-resources which can be evicted from or streamed into the device memory.
 
- Public Member Functions inherited from AZ::RHI::Resource
 AZ_RTTI (Resource,"{9D02CDAC-80EB-4B77-8E62-849AC6E69206}", DeviceObject)
 
bool IsAttachment () const
 Returns whether the resource is currently an attachment on a frame graph.
 
void Shutdown () overridefinal
 Shuts down the buffer by detaching it from its parent pool.
 
const ResourcePoolGetPool () const
 
ResourcePoolGetPool ()
 
uint32_t GetVersion () const
 
const FrameAttachmentGetFrameAttachment () const
 Returns the frame attachment associated with this image (if it exists).
 
void InvalidateViews ()
 
bool IsInResourceCache (const ImageViewDescriptor &imageViewDescriptor)
 Returns true if the ResourceView is in the cache.
 
bool IsInResourceCache (const BufferViewDescriptor &bufferViewDescriptor)
 
void EraseResourceView (ResourceView *resourceView) const
 Removes the provided ResourceView from the cache.
 
- Public Member Functions inherited from AZ::RHI::DeviceObject
 AZ_RTTI (DeviceObject,"{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)
 
bool IsInitialized () const
 Returns whether the device object is initialized.
 
DeviceGetDevice () const
 
- Public Member Functions inherited from AZ::RHI::Object
 AZ_RTTI (Object,"{E43378F1-2331-4173-94B8-990ED20E6003}")
 
void SetName (const Name &name)
 Sets the name of the object.
 
const Name & GetName () const
 Returns the name set on the object by SetName.
 
uint32_t use_count ()
 Returns the current use count of the object.
 

Static Public Member Functions

static RHI::Ptr< ImageCreate ()
 

Friends

class SwapChain
 
class ImagePool
 
class StreamingImagePool
 
class AliasedHeap
 
class ImagePoolResolver
 
class StreamingImagePoolResolver
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::Resource
Ptr< ImageViewGetResourceView (const ImageViewDescriptor &imageViewDescriptor) const
 Returns view based on the descriptor.
 
Ptr< BufferViewGetResourceView (const BufferViewDescriptor &bufferViewDescriptor) const
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

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