VPP  0.7
A high-level modern C++ API for Vulkan
Public Types | Public Member Functions | List of all members
vpp::ImageView< AttributesT > Class Template Reference

Typed image view. More...

#include <vppImageView.hpp>

Public Types

typedef AttributesT::image_type image_type
 Image type.
 
typedef AttributesT::format_type format_type
 Format type (an instance of vpp::format template).
 
typedef AttributesT attributes_type
 Attributes type (taken from the argument).
 

Public Member Functions

 ImageView ()
 Constructs null reference.
 
 ImageView (const image_type &hImage)
 Constructs a view for specified image.
 
 ImageView (const image_type &hImage, unsigned int layer)
 Constructs a view for single array layer selected from specified image.
 
 ImageView (const image_type &hImage, unsigned int mipLevel, unsigned int layer)
 Constructs a typed view for single array layer and mip level selected from specified image.
 
 ImageView (const FrameImageView &hGenericView)
 Constructs a typed view from untyped view.
 
 ImageView (const image_type &hImage, unsigned int baseMipLevel, unsigned int levelCount, unsigned int baseArrayLayer, unsigned int layerCount, const VkComponentMapping &componentMapping=ComponentMapping())
 Constructs a typed view for specified range of array layers and mip levels selected from specified image.
 
 operator VkImageView () const
 Retrieves the Vulkan handle.
 
const image_typeimage () const
 Retrieves the image.
 
const Devicedevice () const
 Retrieves the device.
 
const VkImageSubresourceRange & subresourceRange () const
 Retrieves the range of image slice (levels and layers).
 
FrameImageView frameView () const
 Converts the typed view to untyped view.
 

Detailed Description

template<class AttributesT>
class vpp::ImageView< AttributesT >

Typed image view.

An image view is auxiliary object that acts as an interface between the image and the binding point in the pipeline. In case of image buffers, the view is actual Vulkan object and has two functions:

You must hold ImageView references along with your image. This is similar to texel buffer views.

As the template argument, use an instance of ImageViewAttributes template.

This object is reference-counted and may be passed by value.


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