Image view.
More...
#include <image-view.hpp>
|
| | 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...
|
| |
Image view.
Definition at line 33 of file image-view.hpp.
◆ ~image_view()
| gl::image_view::~image_view |
( |
| ) |
|
|
pure virtual |
◆ image_view() [1/3]
◆ image_view() [2/3]
◆ image_view() [3/3]
| 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 |
|
) |
| |
|
protected |
Constructs an image view from an image.
- Parameters
-
| image | Image on which the view will be created. |
| dimensionality | Image view dimensionality, on [1, 3]. |
| format | Format and type used to interpret texel blocks of the image. If gl::format::undefined, the format will be set to the format of the image. |
| first_mip_level | First mipmap level accessible to the view. |
| mip_level_count | Number of mipmap levels accessible to the view. |
| first_array_layer | First array layer accessible to the view. |
| array_layer | Number of array layers accessible to the view. |
| flags | Image view flags. |
@except std::invalid_argument Image view has null image. @except std::invalid_argument Image view has unsupported format. @except std::invalid_argument Image view has zero mip levels. @except std::out_of_range Image view mip range out of image mip range. @except std::invalid_argument Image view has zero array layers. @except std::out_of_range Image view array layer range out of image array layer range. @except std::invalid_argument Image view dimensionality must match image dimensionality. @except std::invalid_argument Cube image views must be constructed from cube-compatible images. @except std::invalid_argument Cube image views array layer count must be a multiple of 6.
Definition at line 27 of file image-view.cpp.
◆ get_array_layer_count()
| constexpr std::uint32_t gl::image_view::get_array_layer_count |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the number of array layers accessible to the view.
Definition at line 75 of file image-view.hpp.
◆ get_dimensionality()
| constexpr std::uint8_t gl::image_view::get_dimensionality |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the dimensionality of the image view.
Definition at line 81 of file image-view.hpp.
◆ get_first_array_layer()
| constexpr std::uint32_t gl::image_view::get_first_array_layer |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the first array layer accessible to the view.
Definition at line 69 of file image-view.hpp.
◆ get_first_mip_level()
| constexpr std::uint32_t gl::image_view::get_first_mip_level |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the first mipmap level accessible to the view.
Definition at line 57 of file image-view.hpp.
◆ get_format()
| constexpr format gl::image_view::get_format |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the format and type used to interpret texel blocks of the image.
Definition at line 51 of file image-view.hpp.
◆ get_image()
| constexpr const std::shared_ptr<image>& gl::image_view::get_image |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the image on which the view was created.
Definition at line 45 of file image-view.hpp.
◆ get_mip_level_count()
| constexpr std::uint32_t gl::image_view::get_mip_level_count |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns the number of mipmap levels accessible to the view.
Definition at line 63 of file image-view.hpp.
◆ is_1d()
| constexpr bool gl::image_view::is_1d |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns true if the image view is 1D, false otherwise.
Definition at line 87 of file image-view.hpp.
◆ is_2d()
| constexpr bool gl::image_view::is_2d |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns true if the image view is 2D, false otherwise.
Definition at line 93 of file image-view.hpp.
◆ is_3d()
| constexpr bool gl::image_view::is_3d |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns true if the image view is 3D, false otherwise.
Definition at line 99 of file image-view.hpp.
◆ is_array()
| constexpr bool gl::image_view::is_array |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns true if the image view is an array view, false otherwise.
Definition at line 105 of file image-view.hpp.
◆ is_cube()
| constexpr bool gl::image_view::is_cube |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Returns true if the image view is a cube map view, false otherwise.
Definition at line 111 of file image-view.hpp.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ framebuffer
◆ gl_shader_texture_1d
◆ gl_shader_texture_2d
◆ gl_shader_texture_3d
◆ gl_shader_texture_cube
The documentation for this class was generated from the following files:
