vulkan_display::TransferImage Class Reference

#include <vulkan_transfer_image.hpp>

Collaboration diagram for vulkan_display::TransferImage:

Public Member Functions
	TransferImage ()=default
	TransferImage (detail::TransferImageImpl &image)
	TransferImage (std::nullptr_t)
ImageDescription	get_description ()
uint32_t	get_id () const
unsigned char *	get_memory_ptr ()
vk::DeviceSize	get_row_pitch () const
vk::Extent2D	get_size () const
vulkan_display_detail::TransferImageImpl *	get_transfer_image ()
bool	operator== (TransferImage other) const
void	set_process_function (std::function< void(TransferImage &image)> function)

Private Attributes
detail::TransferImageImpl *	transfer_image = nullptr

Detailed Description

Definition at line 220 of file vulkan_transfer_image.hpp.

Constructor & Destructor Documentation

TransferImage() [1/3]

vulkan_display::TransferImage::TransferImage ( )

default

TransferImage() [2/3]

vulkan_display::TransferImage::TransferImage ( std::nullptr_t )

inline

Definition at line 225 of file vulkan_transfer_image.hpp.

{}

TransferImage() [3/3]

vulkan_display::TransferImage::TransferImage ( detail::TransferImageImpl & image )

inlineexplicit

Definition at line 227 of file vulkan_transfer_image.hpp.

                                                               :
                transfer_image{ &image }
        { 
                assert(image.id != detail::TransferImageImpl::NO_ID);
        }

References vulkan_display_detail::TransferImageImpl::id.

Member Function Documentation

get_description()

ImageDescription vulkan_display::TransferImage::get_description ( )

inline

Definition at line 243 of file vulkan_transfer_image.hpp.

                                          {
                return transfer_image->image_description;
        }

References vulkan_display_detail::TransferImageImpl::image_description, and transfer_image.

get_id()

uint32_t vulkan_display::TransferImage::get_id ( ) const

inline

Definition at line 233 of file vulkan_transfer_image.hpp.

                                {
                assert(transfer_image); 
                return transfer_image->id;
        }

References vulkan_display_detail::TransferImageImpl::id, and transfer_image.

get_memory_ptr()

unsigned char * vulkan_display::TransferImage::get_memory_ptr ( )

inline

Definition at line 238 of file vulkan_transfer_image.hpp.

                                        {
                assert(transfer_image);
                return transfer_image->ptr;
        }

References vulkan_display_detail::TransferImageImpl::ptr, and transfer_image.

Referenced by vulkan_display::VulkanDisplay::copy_and_queue_image().

get_row_pitch()

vk::DeviceSize vulkan_display::TransferImage::get_row_pitch ( ) const

inline

Definition at line 247 of file vulkan_transfer_image.hpp.

                                           {
                assert(transfer_image);
                return transfer_image->row_pitch;
        }

References vulkan_display_detail::TransferImageImpl::row_pitch, and transfer_image.

Referenced by vulkan_display::VulkanDisplay::copy_and_queue_image().

get_size()

vk::Extent2D vulkan_display::TransferImage::get_size ( ) const

inline

Definition at line 252 of file vulkan_transfer_image.hpp.

                                    {
                return transfer_image->image_description.size;
        }

References vulkan_display_detail::TransferImageImpl::image_description, vulkan_display::ImageDescription::size, and transfer_image.

Referenced by vulkan_display::VulkanDisplay::copy_and_queue_image().

get_transfer_image()

vulkan_display_detail::TransferImageImpl * vulkan_display::TransferImage::get_transfer_image ( )

inline

Definition at line 256 of file vulkan_transfer_image.hpp.

                                                                     {
                return transfer_image;
        }

References transfer_image.

Referenced by vulkan_display::VulkanDisplay::discard_image(), and vulkan_display::VulkanDisplay::queue_image().

operator==()

bool vulkan_display::TransferImage::operator== ( TransferImage other ) const

inline

Definition at line 264 of file vulkan_transfer_image.hpp.

                                                   {
                return transfer_image == other.transfer_image;
        }

References transfer_image.

set_process_function()

void vulkan_display::TransferImage::set_process_function ( std::function< void(TransferImage &image)> function )

inline

Definition at line 260 of file vulkan_transfer_image.hpp.

                                                                                    {
                transfer_image->preprocess_fun = std::move(function);
        }

References vulkan_display_detail::TransferImageImpl::preprocess_fun, and transfer_image.

Member Data Documentation

transfer_image

detail::TransferImageImpl* vulkan_display::TransferImage::transfer_image = nullptr

private

Definition at line 222 of file vulkan_transfer_image.hpp.

Referenced by get_description(), get_id(), get_memory_ptr(), get_row_pitch(), get_size(), get_transfer_image(), operator==(), and set_process_function().

---

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

• src/video_display/vulkan/vulkan_transfer_image.hpp