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

Inherits AZ::RHI::DeviceObject, and RHI::ResourceInvalidateBus::MultiHandler.

Classes

struct  Descriptor
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (Framebuffer, AZ::ThreadPoolAllocator)
 
 AZ_RTTI (Framebuffer, "1EF7EE0F-CB6C-45EB-8D8A-8254F4AC5F67", Base)
 
RHI::ResultCode Init (const Descriptor &descriptor)
 
VkFramebuffer GetNativeFramebuffer () const
 
const RenderPassGetRenderPass () const
 
const RHI::SizeGetSize () const
 
const AZStd::vector< RHI::ConstPtr< ImageView > > & GetImageViews () const
 Returns a list with image views of the framebuffer.
 
AZStd::optional< uint32_t > FindImageViewIndex (RHI::ImageScopeAttachment &scopeAttachment) const
 
- 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< FramebufferCreate ()
 

Additional Inherited Members

- 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
 

Member Function Documentation

◆ FindImageViewIndex()

AZStd::optional< uint32_t > AZ::Vulkan::Framebuffer::FindImageViewIndex ( RHI::ImageScopeAttachment scopeAttachment) const

Returns the index of the image view that correspons to one used by the ImageScopeAttachment. If not found an empty optional is returned.


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