vOOlkan
An object oriented approach to Vulkan
Vulkan::SwapchainOptions::Capabilities Class Reference

The capabilities of a swapchain define some important properties of the images in the swapchain, such as their resolution. More...

#include <SwapchainCapabilities.h>

Public Member Functions

 Capabilities (const PhysicalDevice &realGpu, const WindowSurface &windowSurface)
 Creates an object containing the capabilities of the pair GPU window surface, such has the maximum resolution. More...
 
 Capabilities ()=default
 
const VkSurfaceCapabilitiesKHR & operator+ () const
 Returns the underlying VkSurfaceCapabilitiesKHR. More...
 
VkExtent2D chooseSwapExtent (const Window &window) const
 Chooses the best swap extent (basically the resolution of the images to be shown) based on the window and the capabilities of the GPU and the window surface. More...
 

Detailed Description

The capabilities of a swapchain define some important properties of the images in the swapchain, such as their resolution.

Constructor & Destructor Documentation

◆ Capabilities() [1/2]

Vulkan::SwapchainOptions::Capabilities::Capabilities ( const PhysicalDevice realGpu,
const WindowSurface windowSurface 
)

Creates an object containing the capabilities of the pair GPU window surface, such has the maximum resolution.

Parameters
realGpuThe physical GPU.
windowSurfaceThe OS window surface.

◆ Capabilities() [2/2]

Vulkan::SwapchainOptions::Capabilities::Capabilities ( )
default

Member Function Documentation

◆ chooseSwapExtent()

VkExtent2D Vulkan::SwapchainOptions::Capabilities::chooseSwapExtent ( const Window window) const

Chooses the best swap extent (basically the resolution of the images to be shown) based on the window and the capabilities of the GPU and the window surface.

Parameters
windowCurrent OS window.
Returns
The best swap extent for this window considering the capabilities of the GPU and the window surface.

◆ operator+()

const VkSurfaceCapabilitiesKHR & Vulkan::SwapchainOptions::Capabilities::operator+ ( ) const

Returns the underlying VkSurfaceCapabilitiesKHR.

Returns
The underlying VkSurfaceCapabilitiesKHR.

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