Lugdunum  0.1.0
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
lug::Graphics::Vulkan::API::DeviceMemory Class Reference

#include <DeviceMemory.hpp>

Collaboration diagram for lug::Graphics::Vulkan::API::DeviceMemory:
[legend]

Public Member Functions

 DeviceMemory ()=default
 
 DeviceMemory (const DeviceMemory &)=delete
 
 DeviceMemory (DeviceMemory &&deviceMemory)
 
DeviceMemoryoperator= (const DeviceMemory &)=delete
 
DeviceMemoryoperator= (DeviceMemory &&deviceMemory)
 
 ~DeviceMemory ()
 
 operator VkDeviceMemory () const
 
void destroy ()
 
void * map (VkDeviceSize size=VK_WHOLE_SIZE, VkDeviceSize offset=0) const
 
void * mapBuffer (const API::Buffer &buffer, VkDeviceSize size=VK_WHOLE_SIZE, VkDeviceSize offset=0) const
 
void * mapImage (const API::Image &image, VkDeviceSize size=VK_WHOLE_SIZE, VkDeviceSize offset=0) const
 
void unmap () const
 
VkDeviceSize getSize () const
 

Private Member Functions

 DeviceMemory (VkDeviceMemory deviceMemory, const Device *device, VkDeviceSize size)
 

Private Attributes

VkDeviceMemory _deviceMemory {VK_NULL_HANDLE}
 
const Device_device {nullptr}
 
VkDeviceSize _size {0}
 

Friends

class Builder::DeviceMemory
 

Detailed Description

Definition at line 19 of file DeviceMemory.hpp.

Constructor & Destructor Documentation

◆ DeviceMemory() [1/4]

lug::Graphics::Vulkan::API::DeviceMemory::DeviceMemory ( )
default

◆ DeviceMemory() [2/4]

lug::Graphics::Vulkan::API::DeviceMemory::DeviceMemory ( const DeviceMemory )
delete

◆ DeviceMemory() [3/4]

lug::Graphics::Vulkan::API::DeviceMemory::DeviceMemory ( DeviceMemory &&  deviceMemory)

Definition at line 15 of file DeviceMemory.cpp.

◆ ~DeviceMemory()

lug::Graphics::Vulkan::API::DeviceMemory::~DeviceMemory ( )

Definition at line 37 of file DeviceMemory.cpp.

◆ DeviceMemory() [4/4]

lug::Graphics::Vulkan::API::DeviceMemory::DeviceMemory ( VkDeviceMemory  deviceMemory,
const Device device,
VkDeviceSize  size 
)
explicitprivate

Definition at line 13 of file DeviceMemory.cpp.

Member Function Documentation

◆ operator=() [1/2]

DeviceMemory& lug::Graphics::Vulkan::API::DeviceMemory::operator= ( const DeviceMemory )
delete

◆ operator=() [2/2]

DeviceMemory & lug::Graphics::Vulkan::API::DeviceMemory::operator= ( DeviceMemory &&  deviceMemory)

Definition at line 24 of file DeviceMemory.cpp.

◆ operator VkDeviceMemory()

lug::Graphics::Vulkan::API::DeviceMemory::operator VkDeviceMemory ( ) const
inlineexplicit

Definition at line 33 of file DeviceMemory.hpp.

◆ destroy()

void lug::Graphics::Vulkan::API::DeviceMemory::destroy ( )

Definition at line 41 of file DeviceMemory.cpp.

◆ map()

void * lug::Graphics::Vulkan::API::DeviceMemory::map ( VkDeviceSize  size = VK_WHOLE_SIZE,
VkDeviceSize  offset = 0 
) const

Definition at line 48 of file DeviceMemory.cpp.

◆ mapBuffer()

void * lug::Graphics::Vulkan::API::DeviceMemory::mapBuffer ( const API::Buffer buffer,
VkDeviceSize  size = VK_WHOLE_SIZE,
VkDeviceSize  offset = 0 
) const

Definition at line 61 of file DeviceMemory.cpp.

◆ mapImage()

void * lug::Graphics::Vulkan::API::DeviceMemory::mapImage ( const API::Image image,
VkDeviceSize  size = VK_WHOLE_SIZE,
VkDeviceSize  offset = 0 
) const

Definition at line 86 of file DeviceMemory.cpp.

◆ unmap()

void lug::Graphics::Vulkan::API::DeviceMemory::unmap ( ) const

Definition at line 111 of file DeviceMemory.cpp.

◆ getSize()

VkDeviceSize DeviceMemory::getSize ( ) const
inline

Definition at line 1 of file DeviceMemory.inl.

Friends And Related Function Documentation

◆ Builder::DeviceMemory

friend class Builder::DeviceMemory
friend

Definition at line 20 of file DeviceMemory.hpp.

Member Data Documentation

◆ _deviceMemory

VkDeviceMemory lug::Graphics::Vulkan::API::DeviceMemory::_deviceMemory {VK_NULL_HANDLE}
private

Definition at line 51 of file DeviceMemory.hpp.

◆ _device

const Device* lug::Graphics::Vulkan::API::DeviceMemory::_device {nullptr}
private

Definition at line 52 of file DeviceMemory.hpp.

◆ _size

VkDeviceSize lug::Graphics::Vulkan::API::DeviceMemory::_size {0}
private

Definition at line 54 of file DeviceMemory.hpp.


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