vulkan_display::ImageDescription Struct Reference

#include <vulkan_transfer_image.hpp>

Collaboration diagram for vulkan_display::ImageDescription:

Public Member Functions
	ImageDescription ()=default
	ImageDescription (uint32_t width, uint32_t height, Format format)
	ImageDescription (vk::Extent2D size, Format format)
const detail::FormatInfo &	format_info () const
bool	operator!= (const ImageDescription &other) const
bool	operator== (const ImageDescription &other) const

Public Attributes
Format	format = Format::uninitialized
vk::Extent2D	size {}

Detailed Description

Definition at line 99 of file vulkan_transfer_image.hpp.

Constructor & Destructor Documentation

ImageDescription() [1/3]

vulkan_display::ImageDescription::ImageDescription ( )

default

ImageDescription() [2/3]

vulkan_display::ImageDescription::ImageDescription ( vk::Extent2D size, Format format )

inline

Definition at line 104 of file vulkan_transfer_image.hpp.

                                                         :
                size{ size }, format{ format } { }

ImageDescription() [3/3]

vulkan_display::ImageDescription::ImageDescription ( uint32_t width, uint32_t height, Format format )

inline

Definition at line 106 of file vulkan_transfer_image.hpp.

                                                                         :
                ImageDescription{ vk::Extent2D{width, height}, format } { }

Member Function Documentation

format_info()

const detail::FormatInfo & vulkan_display::ImageDescription::format_info ( ) const

inline

Definition at line 119 of file vulkan_transfer_image.hpp.

{ return detail::format_info(format); }

References format, and vulkan_display_detail::format_info().

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

Here is the call graph for this function:

operator!=()

bool vulkan_display::ImageDescription::operator!= ( const ImageDescription & other ) const

inline

Definition at line 115 of file vulkan_transfer_image.hpp.

                                                             {
                return !(*this == other);
        }

operator==()

bool vulkan_display::ImageDescription::operator== ( const ImageDescription & other ) const

inline

Definition at line 109 of file vulkan_transfer_image.hpp.

                                                             {
                return size.width == other.size.width 
                        && size.height == other.size.height 
                        && format == other.format;
        }

References format, and size.

Member Data Documentation

format

Format vulkan_display::ImageDescription::format = Format::uninitialized

Definition at line 101 of file vulkan_transfer_image.hpp.

Referenced by format_info(), and operator==().

size

vk::Extent2D vulkan_display::ImageDescription::size {}

Definition at line 100 of file vulkan_transfer_image.hpp.

{};

Referenced by vulkan_display::VulkanDisplay::display_queued_image(), vulkan_display::TransferImage::get_size(), operator==(), vulkan_display::VulkanDisplay::reconfigure(), and vulkan_display::VulkanDisplay::window_parameters_changed().

---

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

• src/video_display/vulkan/vulkan_transfer_image.hpp