Foundation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Protected Attributes | List of all members
Foundation::RHI::RHISwapchain Class Referenceabstract

#include <Swapchain.hpp>

Inheritance diagram for Foundation::RHI::RHISwapchain:
Foundation::RHI::RHIObject Foundation::RHI::VulkanSwapchain

Classes

struct  SwapchainDesc
 

Public Member Functions

virtual Core::Span< RHITexture *constGetImages () const =0
 
 RHISwapchain (RHIDevice const &device, SwapchainDesc const &desc)
 
virtual uint32_t GetNextImage (uint64_t timeout_ns, RHIDeviceObjectHandle< RHIDeviceSemaphore > semaphore, RHIDeviceObjectHandle< RHIDeviceFence > fence)=0
 Gets the next image in the swapchain. Raises RHISwapchainResizeException if the swapchain needs to be resized.
 
virtual RHIExtent2D GetExtents () const =0
 
float GetAspectRatio () const
 
virtual void DebugSetObjectName (const char *name)=0
 
- Public Member Functions inherited from Foundation::RHI::RHIObject
 RHIObject ()=default
 
 RHIObject (RHIObject const &)=delete
 
RHIObjectoperator= (const RHIObject &)=delete
 
 RHIObject (RHIObject &&)=delete
 
RHIObjectoperator= (RHIObject &&)=delete
 
virtual ~RHIObject ()=default
 

Public Attributes

struct Foundation::RHI::RHISwapchain::SwapchainDesc mDesc
 

Protected Attributes

const RHIDevicemDevice
 

Constructor & Destructor Documentation

◆ RHISwapchain()

Foundation::RHI::RHISwapchain::RHISwapchain ( RHIDevice const device,
SwapchainDesc const desc 
)
inline

Member Function Documentation

◆ DebugSetObjectName()

virtual void Foundation::RHI::RHISwapchain::DebugSetObjectName ( const char name)
pure virtual

◆ GetAspectRatio()

float Foundation::RHI::RHISwapchain::GetAspectRatio ( ) const
inline

◆ GetExtents()

virtual RHIExtent2D Foundation::RHI::RHISwapchain::GetExtents ( ) const
pure virtual

◆ GetImages()

virtual Core::Span< RHITexture *const > Foundation::RHI::RHISwapchain::GetImages ( ) const
pure virtual

◆ GetNextImage()

virtual uint32_t Foundation::RHI::RHISwapchain::GetNextImage ( uint64_t  timeout_ns,
RHIDeviceObjectHandle< RHIDeviceSemaphore semaphore,
RHIDeviceObjectHandle< RHIDeviceFence fence 
)
pure virtual

Gets the next image in the swapchain. Raises RHISwapchainResizeException if the swapchain needs to be resized.

Implemented in Foundation::RHI::VulkanSwapchain.

Member Data Documentation

◆ mDesc

struct Foundation::RHI::RHISwapchain::SwapchainDesc Foundation::RHI::RHISwapchain::mDesc

◆ mDevice

const RHIDevice& Foundation::RHI::RHISwapchain::mDevice
protected

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