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

1D image. More...

#include <image.hpp>

Inheritance diagram for gl::image_1d:
gl::image

Public Member Functions

 image_1d (gl::format format, std::uint32_t width, std::uint32_t mip_levels=1, std::uint32_t array_layers=1, std::uint32_t flags=0)
 
- Public Member Functions inherited from gl::image
virtual ~image ()=0
 Destructs an image. More...
 
 image (const image &)=delete
 
 image (image &&)=delete
 
imageoperator= (const image &)=delete
 
imageoperator= (image &&)=delete
 
void read (std::uint32_t mip_level, std::uint32_t offset_x, std::uint32_t offset_y, std::uint32_t offset_z, std::uint32_t width, std::uint32_t height, std::uint32_t depth, gl::format format, std::span< std::byte > data) const
 Reads pixel data from the image. More...
 
void write (std::uint32_t mip_level, std::uint32_t offset_x, std::uint32_t offset_y, std::uint32_t offset_z, std::uint32_t width, std::uint32_t height, std::uint32_t depth, gl::format format, std::span< const std::byte > data)
 Writes pixel data to the image. More...
 
void copy (std::uint32_t src_mip_level, std::uint32_t src_x, std::uint32_t src_y, std::uint32_t src_z, image &dst_image, std::uint32_t dst_mip_level, std::uint32_t dst_x, std::uint32_t dst_y, std::uint32_t dst_z, std::uint32_t width, std::uint32_t height, std::uint32_t depth) const
 Copies pixel data from this image into another the image. More...
 
void generate_mipmaps ()
 Generates mip subimages. More...
 
constexpr std::uint8_t get_dimensionality () const noexcept
 Returns the dimensionality of the image. More...
 
constexpr bool is_1d () const noexcept
 Returns true if the image is 1D, false otherwise. More...
 
constexpr bool is_2d () const noexcept
 Returns true if the image is 2D, false otherwise. More...
 
constexpr bool is_3d () const noexcept
 Returns true if the image is 3D, false otherwise. More...
 
constexpr format get_format () const noexcept
 Returns the format and type of the texel blocks contained in the image. More...
 
constexpr const std::array< std::uint32_t, 3 > & get_dimensions () const noexcept
 Returns the dimensions of the image. More...
 
constexpr std::uint32_t get_mip_levels () const noexcept
 Returns the number of levels of detail available for minified sampling of the image. More...
 
constexpr std::uint32_t get_array_layers () const noexcept
 Returns the number of layers in the image. More...
 
constexpr std::uint8_t get_flags () const noexcept
 Returns the image flags. More...
 
constexpr bool is_cube_compatible () const noexcept
 Returns true if the image is cube map compatible, false otherwise. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gl::image
 image (std::uint8_t dimensionality, gl::format format, std::uint32_t width, std::uint32_t height, std::uint32_t depth, std::uint32_t mip_levels, std::uint32_t array_layers, std::uint32_t flags)
 Constructs an image. More...
 

Detailed Description

1D image.

Definition at line 256 of file image.hpp.

Constructor & Destructor Documentation

◆ image_1d()

gl::image_1d::image_1d ( gl::format  format,
std::uint32_t  width,
std::uint32_t  mip_levels = 1,
std::uint32_t  array_layers = 1,
std::uint32_t  flags = 0 
)

Definition at line 476 of file image.cpp.


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