Vulkan-Hpp
Public Types | Public Member Functions | Static Public Attributes | List of all members
vk::raii::SwapchainKHR Class Reference

#include <vulkan_raii.hpp>

Public Types

using CType = VkSwapchainKHR
 
using CppType = vk::SwapchainKHR
 

Public Member Functions

 SwapchainKHR (vk::raii::Device const &device, vk::SwapchainCreateInfoKHR const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr)
 
 SwapchainKHR (vk::raii::Device const &device, VkSwapchainKHR swapchain, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr)
 
 SwapchainKHR (std::nullptr_t)
 
 ~SwapchainKHR ()
 
 SwapchainKHR ()=delete
 
 SwapchainKHR (SwapchainKHR const &)=delete
 
 SwapchainKHR (SwapchainKHR &&rhs) VULKAN_HPP_NOEXCEPT
 
SwapchainKHR & operator= (SwapchainKHR const &)=delete
 
SwapchainKHR & operator= (SwapchainKHR &&rhs) VULKAN_HPP_NOEXCEPT
 
vk::SwapchainKHR const & operator* () const VULKAN_HPP_NOEXCEPT
 
 operator vk::SwapchainKHR () const VULKAN_HPP_NOEXCEPT
 
void clear () VULKAN_HPP_NOEXCEPT
 
vk::SwapchainKHR release ()
 
vk::Device getDevice () const
 
vk::raii::DeviceDispatcher const * getDispatcher () const
 
void swap (vk::raii::SwapchainKHR &rhs) VULKAN_HPP_NOEXCEPT
 
VULKAN_HPP_NODISCARD std::vector< vk::Image > getImages () const
 
VULKAN_HPP_NODISCARD std::pair< vk::Result, uint32_t > acquireNextImage (uint64_t timeout, vk::Semaphore semaphore VULKAN_HPP_DEFAULT_ARGUMENT_ASSIGNMENT, vk::Fence fence VULKAN_HPP_DEFAULT_ARGUMENT_ASSIGNMENT) const
 
VULKAN_HPP_NODISCARD uint64_t getCounterEXT (vk::SurfaceCounterFlagBitsEXT counter) const
 
VULKAN_HPP_NODISCARD vk::RefreshCycleDurationGOOGLE getRefreshCycleDurationGOOGLE () const
 
VULKAN_HPP_NODISCARD std::vector< vk::PastPresentationTimingGOOGLE > getPastPresentationTimingGOOGLE () const
 
VULKAN_HPP_NODISCARD vk::Result getStatus () const
 
void setLocalDimmingAMD (vk::Bool32 localDimmingEnable) const VULKAN_HPP_NOEXCEPT
 
VULKAN_HPP_NODISCARD vk::Result waitForPresent (uint64_t presentId, uint64_t timeout) const
 
void setLatencySleepModeNV (const vk::LatencySleepModeInfoNV &sleepModeInfo) const
 
void latencySleepNV (const vk::LatencySleepInfoNV &sleepInfo) const
 
void setLatencyMarkerNV (const vk::SetLatencyMarkerInfoNV &latencyMarkerInfo) const VULKAN_HPP_NOEXCEPT
 
VULKAN_HPP_NODISCARD vk::GetLatencyMarkerInfoNV getLatencyTimingsNV () const VULKAN_HPP_NOEXCEPT
 

Static Public Attributes

static VULKAN_HPP_CONST_OR_CONSTEXPR vk::ObjectType objectType = vk::ObjectType::eSwapchainKHR
 
static VULKAN_HPP_CONST_OR_CONSTEXPR vk::DebugReportObjectTypeEXT debugReportObjectType
 

Detailed Description

Definition at line 11305 of file vulkan_raii.hpp.

Member Typedef Documentation

◆ CppType

using vk::raii::SwapchainKHR::CppType = vk::SwapchainKHR

Definition at line 11309 of file vulkan_raii.hpp.

◆ CType

using vk::raii::SwapchainKHR::CType = VkSwapchainKHR

Definition at line 11308 of file vulkan_raii.hpp.

Constructor & Destructor Documentation

◆ SwapchainKHR() [1/6]

vk::raii::SwapchainKHR::SwapchainKHR ( vk::raii::Device const &  device,
vk::SwapchainCreateInfoKHR const &  createInfo,
vk::Optional< const vk::AllocationCallbacks >  allocator = nullptr 
)
inline

Definition at line 11317 of file vulkan_raii.hpp.

◆ SwapchainKHR() [2/6]

vk::raii::SwapchainKHR::SwapchainKHR ( vk::raii::Device const &  device,
VkSwapchainKHR  swapchain,
vk::Optional< const vk::AllocationCallbacks >  allocator = nullptr 
)
inline

Definition at line 11325 of file vulkan_raii.hpp.

◆ SwapchainKHR() [3/6]

vk::raii::SwapchainKHR::SwapchainKHR ( std::nullptr_t  )
inline

Definition at line 11335 of file vulkan_raii.hpp.

◆ ~SwapchainKHR()

vk::raii::SwapchainKHR::~SwapchainKHR ( )
inline

Definition at line 11337 of file vulkan_raii.hpp.

◆ SwapchainKHR() [4/6]

vk::raii::SwapchainKHR::SwapchainKHR ( )
delete

◆ SwapchainKHR() [5/6]

vk::raii::SwapchainKHR::SwapchainKHR ( SwapchainKHR const &  )
delete

◆ SwapchainKHR() [6/6]

vk::raii::SwapchainKHR::SwapchainKHR ( SwapchainKHR &&  rhs)
inline

Definition at line 11345 of file vulkan_raii.hpp.

Member Function Documentation

◆ acquireNextImage()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE std::pair< vk::Result, uint32_t > vk::raii::SwapchainKHR::acquireNextImage ( uint64_t  timeout,
vk::Semaphore semaphore  VULKAN_HPP_DEFAULT_ARGUMENT_ASSIGNMENT,
vk::Fence fence  VULKAN_HPP_DEFAULT_ARGUMENT_ASSIGNMENT 
) const

Definition at line 15083 of file vulkan_raii.hpp.

◆ clear()

void vk::raii::SwapchainKHR::clear ( )
inline

Definition at line 11377 of file vulkan_raii.hpp.

◆ getCounterEXT()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE uint64_t vk::raii::SwapchainKHR::getCounterEXT ( vk::SurfaceCounterFlagBitsEXT  counter) const

Definition at line 17002 of file vulkan_raii.hpp.

◆ getDevice()

vk::Device vk::raii::SwapchainKHR::getDevice ( ) const
inline

Definition at line 11398 of file vulkan_raii.hpp.

◆ getDispatcher()

vk::raii::DeviceDispatcher const* vk::raii::SwapchainKHR::getDispatcher ( ) const
inline

Definition at line 11403 of file vulkan_raii.hpp.

◆ getImages()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE std::vector< vk::Image > vk::raii::SwapchainKHR::getImages ( ) const

Definition at line 15052 of file vulkan_raii.hpp.

◆ getLatencyTimingsNV()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::GetLatencyMarkerInfoNV vk::raii::SwapchainKHR::getLatencyTimingsNV ( ) const

Definition at line 22616 of file vulkan_raii.hpp.

◆ getPastPresentationTimingGOOGLE()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE std::vector< vk::PastPresentationTimingGOOGLE > vk::raii::SwapchainKHR::getPastPresentationTimingGOOGLE ( ) const

Definition at line 17030 of file vulkan_raii.hpp.

◆ getRefreshCycleDurationGOOGLE()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::RefreshCycleDurationGOOGLE vk::raii::SwapchainKHR::getRefreshCycleDurationGOOGLE ( ) const

Definition at line 17016 of file vulkan_raii.hpp.

◆ getStatus()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::Result vk::raii::SwapchainKHR::getStatus ( ) const

Definition at line 17170 of file vulkan_raii.hpp.

◆ latencySleepNV()

VULKAN_HPP_INLINE void vk::raii::SwapchainKHR::latencySleepNV ( const vk::LatencySleepInfoNV &  sleepInfo) const

Definition at line 22598 of file vulkan_raii.hpp.

◆ operator vk::SwapchainKHR()

vk::raii::SwapchainKHR::operator vk::SwapchainKHR ( ) const
inline

Definition at line 11372 of file vulkan_raii.hpp.

◆ operator*()

vk::SwapchainKHR const& vk::raii::SwapchainKHR::operator* ( ) const
inline

Definition at line 11367 of file vulkan_raii.hpp.

◆ operator=() [1/2]

SwapchainKHR& vk::raii::SwapchainKHR::operator= ( SwapchainKHR &&  rhs)
inline

Definition at line 11355 of file vulkan_raii.hpp.

◆ operator=() [2/2]

SwapchainKHR& vk::raii::SwapchainKHR::operator= ( SwapchainKHR const &  )
delete

◆ release()

vk::SwapchainKHR vk::raii::SwapchainKHR::release ( )
inline

Definition at line 11390 of file vulkan_raii.hpp.

◆ setLatencyMarkerNV()

VULKAN_HPP_INLINE void vk::raii::SwapchainKHR::setLatencyMarkerNV ( const vk::SetLatencyMarkerInfoNV &  latencyMarkerInfo) const

Definition at line 22607 of file vulkan_raii.hpp.

◆ setLatencySleepModeNV()

VULKAN_HPP_INLINE void vk::raii::SwapchainKHR::setLatencySleepModeNV ( const vk::LatencySleepModeInfoNV &  sleepModeInfo) const

Definition at line 22589 of file vulkan_raii.hpp.

◆ setLocalDimmingAMD()

VULKAN_HPP_INLINE void vk::raii::SwapchainKHR::setLocalDimmingAMD ( vk::Bool32  localDimmingEnable) const

Definition at line 19396 of file vulkan_raii.hpp.

◆ swap()

void vk::raii::SwapchainKHR::swap ( vk::raii::SwapchainKHR &  rhs)
inline

Definition at line 11409 of file vulkan_raii.hpp.

◆ waitForPresent()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::Result vk::raii::SwapchainKHR::waitForPresent ( uint64_t  presentId,
uint64_t  timeout 
) const

Definition at line 19552 of file vulkan_raii.hpp.

Member Data Documentation

◆ debugReportObjectType

VULKAN_HPP_CONST_OR_CONSTEXPR vk::DebugReportObjectTypeEXT vk::raii::SwapchainKHR::debugReportObjectType
static
Initial value:
=
vk::DebugReportObjectTypeEXT::eSwapchainKHR

Definition at line 11312 of file vulkan_raii.hpp.

◆ objectType

VULKAN_HPP_CONST_OR_CONSTEXPR vk::ObjectType vk::raii::SwapchainKHR::objectType = vk::ObjectType::eSwapchainKHR
static

Definition at line 11311 of file vulkan_raii.hpp.

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