NDEVR
API Documentation
VulkanImageView

Manages a view within the Vulkan logic space. More...

Public Member Functions

 VulkanImageView (const ConstPointer< VulkanImageData > &data, uint04 aspectFlags, bool create=true)
 Constructs an image view for the given image data.
 VulkanImageView (VulkanImageView &&old)
 Move constructor.
 ~VulkanImageView ()
 Destructor.
void cleanup ()
 Releases the Vulkan image view resources.
void create ()
 Creates or recreates the Vulkan image view.
bool needsUpdate () const
 Checks whether the view needs to be recreated due to image changes.
VkImageView vkImageView () const
 Returns the underlying Vulkan image view handle.

Detailed Description

Manages a view within the Vulkan logic space.


See: https://vulkan-tutorial.com/Drawing_a_triangle/Presentation/Image_views

Definition at line 235 of file VulkanImage.h.

Constructor & Destructor Documentation

◆ VulkanImageView() [1/2]

VulkanImageView::VulkanImageView ( const ConstPointer< VulkanImageData > & data,
uint04 aspectFlags,
bool create = true )

Constructs an image view for the given image data.

Parameters
[in]dataThe image data to create a view for.
[in]aspectFlagsThe Vulkan image aspect flags.
[in]createWhether to immediately create the view.

References create().

Referenced by VulkanImageView().

◆ VulkanImageView() [2/2]

VulkanImageView::VulkanImageView ( VulkanImageView && old)

Move constructor.

Parameters
[in]oldThe image view to move from.

References VulkanImageView().

Member Function Documentation

◆ needsUpdate()

bool VulkanImageView::needsUpdate ( ) const

Checks whether the view needs to be recreated due to image changes.

Returns
True if an update is needed.

◆ vkImageView()

VkImageView VulkanImageView::vkImageView ( ) const
inline

Returns the underlying Vulkan image view handle.

Returns
The VkImageView.

Definition at line 255 of file VulkanImage.h.


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