Antkeeper  0.0.1
Public Member Functions | List of all members
gl::image_view_2d_array Class Reference

2D image array view. More...

#include <image-view.hpp>

Inheritance diagram for gl::image_view_2d_array:
gl::image_view

Public Member Functions

 image_view_2d_array (std::shared_ptr< gl::image > image, gl::format format=gl::format::undefined, std::uint32_t first_mip_level=0, std::uint32_t mip_level_count=1, std::uint32_t first_array_layer=0, std::uint32_t array_layer_count=1)
 
- Public Member Functions inherited from gl::image_view
virtual ~image_view ()=0
 Destructs an image view. More...
 
 image_view (const image_view &)=delete
 
 image_view (image_view &&)=delete
 
image_viewoperator= (const image_view &)=delete
 
image_viewoperator= (image_view &&)=delete
 
constexpr const std::shared_ptr< image > & get_image () const noexcept
 Returns the image on which the view was created. More...
 
constexpr format get_format () const noexcept
 Returns the format and type used to interpret texel blocks of the image. More...
 
constexpr std::uint32_t get_first_mip_level () const noexcept
 Returns the first mipmap level accessible to the view. More...
 
constexpr std::uint32_t get_mip_level_count () const noexcept
 Returns the number of mipmap levels accessible to the view. More...
 
constexpr std::uint32_t get_first_array_layer () const noexcept
 Returns the first array layer accessible to the view. More...
 
constexpr std::uint32_t get_array_layer_count () const noexcept
 Returns the number of array layers accessible to the view. More...
 
constexpr std::uint8_t get_dimensionality () const noexcept
 Returns the dimensionality of the image view. More...
 
constexpr bool is_1d () const noexcept
 Returns true if the image view is 1D, false otherwise. More...
 
constexpr bool is_2d () const noexcept
 Returns true if the image view is 2D, false otherwise. More...
 
constexpr bool is_3d () const noexcept
 Returns true if the image view is 3D, false otherwise. More...
 
constexpr bool is_array () const noexcept
 Returns true if the image view is an array view, false otherwise. More...
 
constexpr bool is_cube () const noexcept
 Returns true if the image view is a cube map view, false otherwise. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gl::image_view
 image_view (std::shared_ptr< gl::image > image, std::uint8_t dimensionality, gl::format format, std::uint32_t first_mip_level, std::uint32_t mip_level_count, std::uint32_t first_array_layer, std::uint32_t array_layer_count, std::uint8_t flags)
 Constructs an image view from an image. More...
 

Detailed Description

2D image array view.

Definition at line 224 of file image-view.hpp.

Constructor & Destructor Documentation

◆ image_view_2d_array()

gl::image_view_2d_array::image_view_2d_array ( std::shared_ptr< gl::image image,
gl::format  format = gl::format::undefined,
std::uint32_t  first_mip_level = 0,
std::uint32_t  mip_level_count = 1,
std::uint32_t  first_array_layer = 0,
std::uint32_t  array_layer_count = 1 
)

Definition at line 213 of file image-view.cpp.


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