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

#include <vulkan_raii.hpp>

Public Types

using CType = VkImage
 
using CppType = vk::Image
 

Public Member Functions

 Image (vk::raii::Device const &device, vk::ImageCreateInfo const &createInfo, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr)
 
 Image (vk::raii::Device const &device, VkImage image, vk::Optional< const vk::AllocationCallbacks > allocator=nullptr)
 
 Image (std::nullptr_t)
 
 ~Image ()
 
 Image ()=delete
 
 Image (Image const &)=delete
 
 Image (Image &&rhs) VULKAN_HPP_NOEXCEPT
 
Image & operator= (Image const &)=delete
 
Image & operator= (Image &&rhs) VULKAN_HPP_NOEXCEPT
 
vk::Image const & operator* () const VULKAN_HPP_NOEXCEPT
 
 operator vk::Image () const VULKAN_HPP_NOEXCEPT
 
void clear () VULKAN_HPP_NOEXCEPT
 
vk::Image release ()
 
vk::Device getDevice () const
 
vk::raii::DeviceDispatcher const * getDispatcher () const
 
void swap (vk::raii::Image &rhs) VULKAN_HPP_NOEXCEPT
 
void bindMemory (vk::DeviceMemory memory, vk::DeviceSize memoryOffset) const
 
VULKAN_HPP_NODISCARD vk::MemoryRequirements getMemoryRequirements () const VULKAN_HPP_NOEXCEPT
 
VULKAN_HPP_NODISCARD std::vector< vk::SparseImageMemoryRequirements > getSparseMemoryRequirements () const
 
VULKAN_HPP_NODISCARD vk::SubresourceLayout getSubresourceLayout (const vk::ImageSubresource &subresource) const VULKAN_HPP_NOEXCEPT
 
VULKAN_HPP_NODISCARD vk::ImageDrmFormatModifierPropertiesEXT getDrmFormatModifierPropertiesEXT () const
 
VULKAN_HPP_NODISCARD vk::SubresourceLayout2KHR getSubresourceLayout2EXT (const vk::ImageSubresource2KHR &subresource) const VULKAN_HPP_NOEXCEPT
 
template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD vk::StructureChain< X, Y, Z... > getSubresourceLayout2EXT (const vk::ImageSubresource2KHR &subresource) const VULKAN_HPP_NOEXCEPT
 
VULKAN_HPP_NODISCARD vk::SubresourceLayout2KHR getSubresourceLayout2KHR (const vk::ImageSubresource2KHR &subresource) const VULKAN_HPP_NOEXCEPT
 
template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD vk::StructureChain< X, Y, Z... > getSubresourceLayout2KHR (const vk::ImageSubresource2KHR &subresource) const VULKAN_HPP_NOEXCEPT
 
template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::StructureChain< X, Y, Z... > getSubresourceLayout2EXT (const vk::ImageSubresource2KHR &subresource) const VULKAN_HPP_NOEXCEPT
 
template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::StructureChain< X, Y, Z... > getSubresourceLayout2KHR (const vk::ImageSubresource2KHR &subresource) const VULKAN_HPP_NOEXCEPT
 

Static Public Attributes

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

Detailed Description

Definition at line 8566 of file vulkan_raii.hpp.

Member Typedef Documentation

◆ CppType

using vk::raii::Image::CppType = vk::Image

Definition at line 8570 of file vulkan_raii.hpp.

◆ CType

using vk::raii::Image::CType = VkImage

Definition at line 8569 of file vulkan_raii.hpp.

Constructor & Destructor Documentation

◆ Image() [1/6]

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

Definition at line 8578 of file vulkan_raii.hpp.

◆ Image() [2/6]

vk::raii::Image::Image ( vk::raii::Device const &  device,
VkImage  image,
vk::Optional< const vk::AllocationCallbacks >  allocator = nullptr 
)
inline

Definition at line 8586 of file vulkan_raii.hpp.

◆ Image() [3/6]

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

Definition at line 8596 of file vulkan_raii.hpp.

◆ ~Image()

vk::raii::Image::~Image ( )
inline

Definition at line 8598 of file vulkan_raii.hpp.

◆ Image() [4/6]

vk::raii::Image::Image ( )
delete

◆ Image() [5/6]

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

◆ Image() [6/6]

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

Definition at line 8606 of file vulkan_raii.hpp.

Member Function Documentation

◆ bindMemory()

VULKAN_HPP_INLINE void vk::raii::Image::bindMemory ( vk::DeviceMemory  memory,
vk::DeviceSize  memoryOffset 
) const

Definition at line 12312 of file vulkan_raii.hpp.

◆ clear()

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

Definition at line 8638 of file vulkan_raii.hpp.

◆ getDevice()

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

Definition at line 8659 of file vulkan_raii.hpp.

◆ getDispatcher()

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

Definition at line 8664 of file vulkan_raii.hpp.

◆ getDrmFormatModifierPropertiesEXT()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::ImageDrmFormatModifierPropertiesEXT vk::raii::Image::getDrmFormatModifierPropertiesEXT ( ) const

Definition at line 18583 of file vulkan_raii.hpp.

◆ getMemoryRequirements()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::MemoryRequirements vk::raii::Image::getMemoryRequirements ( ) const

Definition at line 12335 of file vulkan_raii.hpp.

◆ getSparseMemoryRequirements()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE std::vector< vk::SparseImageMemoryRequirements > vk::raii::Image::getSparseMemoryRequirements ( ) const

Definition at line 12346 of file vulkan_raii.hpp.

◆ getSubresourceLayout()

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::SubresourceLayout vk::raii::Image::getSubresourceLayout ( const vk::ImageSubresource &  subresource) const

Definition at line 12688 of file vulkan_raii.hpp.

◆ getSubresourceLayout2EXT() [1/3]

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::SubresourceLayout2KHR vk::raii::Image::getSubresourceLayout2EXT ( const vk::ImageSubresource2KHR &  subresource) const

Definition at line 20128 of file vulkan_raii.hpp.

◆ getSubresourceLayout2EXT() [2/3]

template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD vk::StructureChain<X, Y, Z...> vk::raii::Image::getSubresourceLayout2EXT ( const vk::ImageSubresource2KHR &  subresource) const

◆ getSubresourceLayout2EXT() [3/3]

template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::StructureChain<X, Y, Z...> vk::raii::Image::getSubresourceLayout2EXT ( const vk::ImageSubresource2KHR &  subresource) const

Definition at line 20145 of file vulkan_raii.hpp.

◆ getSubresourceLayout2KHR() [1/3]

VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::SubresourceLayout2KHR vk::raii::Image::getSubresourceLayout2KHR ( const vk::ImageSubresource2KHR &  subresource) const

Definition at line 22405 of file vulkan_raii.hpp.

◆ getSubresourceLayout2KHR() [2/3]

template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD vk::StructureChain<X, Y, Z...> vk::raii::Image::getSubresourceLayout2KHR ( const vk::ImageSubresource2KHR &  subresource) const

◆ getSubresourceLayout2KHR() [3/3]

template<typename X , typename Y , typename... Z>
VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE vk::StructureChain<X, Y, Z...> vk::raii::Image::getSubresourceLayout2KHR ( const vk::ImageSubresource2KHR &  subresource) const

Definition at line 22422 of file vulkan_raii.hpp.

◆ operator vk::Image()

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

Definition at line 8633 of file vulkan_raii.hpp.

◆ operator*()

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

Definition at line 8628 of file vulkan_raii.hpp.

◆ operator=() [1/2]

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

Definition at line 8616 of file vulkan_raii.hpp.

◆ operator=() [2/2]

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

◆ release()

vk::Image vk::raii::Image::release ( )
inline

Definition at line 8651 of file vulkan_raii.hpp.

◆ swap()

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

Definition at line 8670 of file vulkan_raii.hpp.

Member Data Documentation

◆ debugReportObjectType

VULKAN_HPP_CONST_OR_CONSTEXPR vk::DebugReportObjectTypeEXT vk::raii::Image::debugReportObjectType
static
Initial value:
=
vk::DebugReportObjectTypeEXT::eImage

Definition at line 8573 of file vulkan_raii.hpp.

◆ objectType

VULKAN_HPP_CONST_OR_CONSTEXPR vk::ObjectType vk::raii::Image::objectType = vk::ObjectType::eImage
static

Definition at line 8572 of file vulkan_raii.hpp.

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