A swap chain registered into the frame scheduler. More...

#include <SwapChainFrameAttachment.h>

Public Member Functions
	AZ_RTTI (SwapChainFrameAttachment, "{6DBAE3A9-45F9-4B0A-AFF4-0965C456D4C0}", ImageFrameAttachment)

	AZ_CLASS_ALLOCATOR (SwapChainFrameAttachment, AZ::PoolAllocator)

	SwapChainFrameAttachment (const AttachmentId &attachmentId, Ptr< SwapChain > swapChain)

const SwapChain *	GetSwapChain () const
	Returns the swap chain referenced by this attachment.

SwapChain *	GetSwapChain ()

Public Member Functions inherited from AZ::RHI::ImageFrameAttachment
	AZ_RTTI (ImageFrameAttachment, "{F620A6ED-C33A-4487-9BF7-12F652B8B1E3}", FrameAttachment)

	AZ_CLASS_ALLOCATOR (ImageFrameAttachment, SystemAllocator)

	ImageFrameAttachment (const AttachmentId &attachmentId, Ptr< Image > image)
	Initialization for imported images.

	ImageFrameAttachment (const TransientImageDescriptor &descriptor)
	Initialization for transient images.

const ImageScopeAttachment *	GetFirstScopeAttachment (int deviceIndex) const
	Returns the first scope attachment in the linked list.

ImageScopeAttachment *	GetFirstScopeAttachment (int deviceIndex)

const ImageScopeAttachment *	GetLastScopeAttachment (int deviceIndex) const
	Returns the last scope attachment in the linked list.

ImageScopeAttachment *	GetLastScopeAttachment (int deviceIndex)

const Image *	GetImage () const

Image *	GetImage ()

const ImageDescriptor &	GetImageDescriptor () const
	Returns the image descriptor for this attachment.

ClearValue	GetOptimizedClearValue (int deviceIndex) const
	Returns an optimized clear value for the image by traversing the usage chain.

Public Member Functions inherited from AZ::RHI::FrameAttachment
	AZ_RTTI (FrameAttachment, "{F35548B3-4B2C-478C-9ED9-759CAEAE2729}")

const AttachmentId &	GetId () const
	Returns the attachment id.

Resource *	GetResource ()
	Returns the resource associated with this frame attachment.

const Resource *	GetResource () const

AttachmentLifetimeType	GetLifetimeType () const
	Returns the attachment lifetime type.

const ScopeAttachment *	GetFirstScopeAttachment (int deviceIndex) const

ScopeAttachment *	GetFirstScopeAttachment (int deviceIndex)

const ScopeAttachment *	GetLastScopeAttachment (int deviceIndex) const

ScopeAttachment *	GetLastScopeAttachment (int deviceIndex)

bool	HasScopeAttachments () const
	Returns whether there are any scope attachments at all.

Scope *	GetFirstScope (int deviceIndex) const

Scope *	GetLastScope (int deviceIndex) const

HardwareQueueClassMask	GetUsedQueueMask () const
	Returns the mask of all the hardware queues that this attachment is used on.

HardwareQueueClassMask	GetSupportedQueueMask () const
	Returns the mask of all the hardware queues that this attachment is supported on.

void	SetResource (Ptr< Resource > resource, int deviceIndex=MultiDevice::InvalidDeviceIndex)
	[Internal] Assigns the resource. This may only be done once.

Additional Inherited Members
Protected Member Functions inherited from AZ::RHI::FrameAttachment
	FrameAttachment (const AttachmentId &attachmentId, HardwareQueueClassMask supportedQueueMask, AttachmentLifetimeType lifetimeType)

	FrameAttachment (const FrameAttachment &)=delete

	FrameAttachment (FrameAttachment &&)=delete

Detailed Description

A swap chain registered into the frame scheduler.

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

Gems/Atom/RHI/Code/Include/Atom/RHI/SwapChainFrameAttachment.h

Public Member Functions

Additional Inherited Members

Detailed Description