vk::raii::Instance Class Reference

#include <vulkan_raii.hpp>

Public Types
using	CType = VkInstance
using	CppType = vk::Instance

Public Member Functions
	Instance (vk::raii::Context const &context, vk::InstanceCreateInfo const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr)
	Instance (vk::raii::Context const &context, VkInstance instance, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr)
	Instance (std::nullptr_t)
	~Instance ()
	Instance ()=delete
	Instance (Instance const &)=delete
	Instance (Instance &&rhs) VULKAN_HPP_NOEXCEPT
Instance &	operator= (Instance const &)=delete
Instance &	operator= (Instance &&rhs) VULKAN_HPP_NOEXCEPT
vk::Instance const &	operator* () const VULKAN_HPP_NOEXCEPT
	operator vk::Instance () const VULKAN_HPP_NOEXCEPT
void	clear () VULKAN_HPP_NOEXCEPT
vk::Instance	release ()
vk::raii::InstanceDispatcher const *	getDispatcher () const
void	swap (vk::raii::Instance &rhs) VULKAN_HPP_NOEXCEPT
VULKAN_HPP_NODISCARD vk::raii::CreateReturnType< std::vector< vk::raii::PhysicalDevice > >::Type	enumeratePhysicalDevices () const
VULKAN_HPP_NODISCARD PFN_vkVoidFunction	getProcAddr (const std::string &name) const VULKAN_HPP_NOEXCEPT
VULKAN_HPP_NODISCARD std::vector< vk::PhysicalDeviceGroupProperties >	enumeratePhysicalDeviceGroups () const
VULKAN_HPP_NODISCARD vk::raii::CreateReturnType< vk::raii::SurfaceKHR >::Type	createDisplayPlaneSurfaceKHR (vk::DisplaySurfaceCreateInfoKHR const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr) const VULKAN_HPP_RAII_CREATE_NOEXCEPT
VULKAN_HPP_NODISCARD vk::raii::CreateReturnType< vk::raii::DebugReportCallbackEXT >::Type	createDebugReportCallbackEXT (vk::DebugReportCallbackCreateInfoEXT const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr) const VULKAN_HPP_RAII_CREATE_NOEXCEPT
void	debugReportMessageEXT (vk::DebugReportFlagsEXT flags, vk::DebugReportObjectTypeEXT objectType_, uint64_t object, size_t location, int32_t messageCode, const std::string &layerPrefix, const std::string &message) const VULKAN_HPP_NOEXCEPT
VULKAN_HPP_NODISCARD std::vector< vk::PhysicalDeviceGroupProperties >	enumeratePhysicalDeviceGroupsKHR () const
VULKAN_HPP_NODISCARD vk::raii::CreateReturnType< vk::raii::DebugUtilsMessengerEXT >::Type	createDebugUtilsMessengerEXT (vk::DebugUtilsMessengerCreateInfoEXT const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr) const VULKAN_HPP_RAII_CREATE_NOEXCEPT
void	submitDebugUtilsMessageEXT (vk::DebugUtilsMessageSeverityFlagBitsEXT messageSeverity, vk::DebugUtilsMessageTypeFlagsEXT messageTypes, const vk::DebugUtilsMessengerCallbackDataEXT &callbackData) const VULKAN_HPP_NOEXCEPT
VULKAN_HPP_NODISCARD vk::raii::CreateReturnType< vk::raii::SurfaceKHR >::Type	createHeadlessSurfaceEXT (vk::HeadlessSurfaceCreateInfoEXT const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr) const VULKAN_HPP_RAII_CREATE_NOEXCEPT

Static Public Attributes
static VULKAN_HPP_CONST_OR_CONSTEXPR vk::ObjectType	objectType = vk::ObjectType::eInstance
static VULKAN_HPP_CONST_OR_CONSTEXPR vk::DebugReportObjectTypeEXT	debugReportObjectType

Detailed Description

Definition at line 2772 of file vulkan_raii.hpp.

Member Typedef Documentation

CppType

using vk::raii::Instance::CppType = vk::Instance

Definition at line 2776 of file vulkan_raii.hpp.

CType

using vk::raii::Instance::CType = VkInstance

Definition at line 2775 of file vulkan_raii.hpp.

Constructor & Destructor Documentation

Instance() [1/6]

vk::raii::Instance::Instance ( vk::raii::Context const &  context, vk::InstanceCreateInfo const &  createInfo, vk::Optional< const vk::AllocationCallbacks >  allocator = nullptr  )

inline

Definition at line 2784 of file vulkan_raii.hpp.

Instance() [2/6]

vk::raii::Instance::Instance ( vk::raii::Context const &  context, VkInstance  instance, vk::Optional< const vk::AllocationCallbacks >  allocator = nullptr  )

inline

Definition at line 2792 of file vulkan_raii.hpp.

Instance() [3/6]

vk::raii::Instance::Instance ( std::nullptr_t  )

inline

Definition at line 2801 of file vulkan_raii.hpp.

~Instance()

vk::raii::Instance::~Instance ( )

inline

Definition at line 2803 of file vulkan_raii.hpp.

Instance() [4/6]

vk::raii::Instance::Instance ( )

delete

Instance() [5/6]

vk::raii::Instance::Instance ( Instance const &  )

delete

Instance() [6/6]

vk::raii::Instance::Instance ( Instance &&  rhs )

inline

Definition at line 2811 of file vulkan_raii.hpp.

Member Function Documentation

clear()

void vk::raii::Instance::clear ( )

inline

Definition at line 2841 of file vulkan_raii.hpp.

createDebugReportCallbackEXT()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::raii::CreateReturnType< vk::raii::DebugReportCallbackEXT >::Type vk::raii::Instance::createDebugReportCallbackEXT	(	vk::DebugReportCallbackCreateInfoEXT const &	createInfo,
		vk::Optional< const vk::AllocationCallbacks >	allocator = nullptr
	)		const

Definition at line 15630 of file vulkan_raii.hpp.

createDebugUtilsMessengerEXT()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::raii::CreateReturnType< vk::raii::DebugUtilsMessengerEXT >::Type vk::raii::Instance::createDebugUtilsMessengerEXT	(	vk::DebugUtilsMessengerCreateInfoEXT const &	createInfo,
		vk::Optional< const vk::AllocationCallbacks >	allocator = nullptr
	)		const

Definition at line 17663 of file vulkan_raii.hpp.

createDisplayPlaneSurfaceKHR()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::raii::CreateReturnType< vk::raii::SurfaceKHR >::Type vk::raii::Instance::createDisplayPlaneSurfaceKHR	(	vk::DisplaySurfaceCreateInfoKHR const &	createInfo,
		vk::Optional< const vk::AllocationCallbacks >	allocator = nullptr
	)		const

Definition at line 15360 of file vulkan_raii.hpp.

createHeadlessSurfaceEXT()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::raii::CreateReturnType< vk::raii::SurfaceKHR >::Type vk::raii::Instance::createHeadlessSurfaceEXT	(	vk::HeadlessSurfaceCreateInfoEXT const &	createInfo,
		vk::Optional< const vk::AllocationCallbacks >	allocator = nullptr
	)		const

Definition at line 19708 of file vulkan_raii.hpp.

debugReportMessageEXT()

VULKAN_HPP_INLINE void vk::raii::Instance::debugReportMessageEXT	(	vk::DebugReportFlagsEXT	flags,
		vk::DebugReportObjectTypeEXT	objectType_,
		uint64_t	object,
		size_t	location,
		int32_t	messageCode,
		const std::string &	layerPrefix,
		const std::string &	message
	)		const

Definition at line 15653 of file vulkan_raii.hpp.

enumeratePhysicalDeviceGroups()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE std::vector< vk::PhysicalDeviceGroupProperties > vk::raii::Instance::enumeratePhysicalDeviceGroups

(

)

const

Definition at line 13817 of file vulkan_raii.hpp.

enumeratePhysicalDeviceGroupsKHR()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE std::vector< vk::PhysicalDeviceGroupProperties > vk::raii::Instance::enumeratePhysicalDeviceGroupsKHR

(

)

const

Definition at line 16590 of file vulkan_raii.hpp.

enumeratePhysicalDevices()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::raii::CreateReturnType< std::vector< vk::raii::PhysicalDevice > >::Type vk::raii::Instance::enumeratePhysicalDevices

(

)

const

Definition at line 11906 of file vulkan_raii.hpp.

getDispatcher()

vk::raii::InstanceDispatcher const* vk::raii::Instance::getDispatcher ( ) const

inline

Definition at line 2859 of file vulkan_raii.hpp.

getProcAddr()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE PFN_vkVoidFunction vk::raii::Instance::getProcAddr

(

const std::string &

name

)

const

Definition at line 12030 of file vulkan_raii.hpp.

operator vk::Instance()

vk::raii::Instance::operator vk::Instance ( ) const

inline

Definition at line 2836 of file vulkan_raii.hpp.

operator*()

vk::Instance const& vk::raii::Instance::operator* ( ) const

inline

Definition at line 2831 of file vulkan_raii.hpp.

operator=() [1/2]

Instance& vk::raii::Instance::operator= ( Instance &&  rhs )

inline

Definition at line 2820 of file vulkan_raii.hpp.

operator=() [2/2]

Instance& vk::raii::Instance::operator= ( Instance const &  )

delete

release()

vk::Instance vk::raii::Instance::release ( )

inline

Definition at line 2852 of file vulkan_raii.hpp.

submitDebugUtilsMessageEXT()

VULKAN_HPP_INLINE void vk::raii::Instance::submitDebugUtilsMessageEXT	(	vk::DebugUtilsMessageSeverityFlagBitsEXT	messageSeverity,
		vk::DebugUtilsMessageTypeFlagsEXT	messageTypes,
		const vk::DebugUtilsMessengerCallbackDataEXT &	callbackData
	)		const

Definition at line 17687 of file vulkan_raii.hpp.

swap()

void vk::raii::Instance::swap ( vk::raii::Instance &  rhs )

inline

Definition at line 2865 of file vulkan_raii.hpp.

Member Data Documentation

debugReportObjectType

VULKAN_HPP_CONST_OR_CONSTEXPR vk::DebugReportObjectTypeEXT vk::raii::Instance::debugReportObjectType

static

Initial value:

=
        vk::DebugReportObjectTypeEXT::eInstance

Definition at line 2779 of file vulkan_raii.hpp.

objectType

VULKAN_HPP_CONST_OR_CONSTEXPR vk::ObjectType vk::raii::Instance::objectType = vk::ObjectType::eInstance

static

Definition at line 2778 of file vulkan_raii.hpp.

---

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

• vulkan/vulkan_raii.hpp