image-view.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef ANTKEEPER_GL_IMAGE_VIEW_HPP
#define ANTKEEPER_GL_IMAGE_VIEW_HPP
 
#include <engine/gl/image.hpp>
#include <engine/gl/image-view-flag.hpp>
#include <cstdint>
#include <memory>
 
namespace gl {
 
class image_view
{
public:
    virtual ~image_view() = 0;
    
    image_view(const image_view&) = delete;
    image_view(image_view&&) = delete;
    image_view& operator=(const image_view&) = delete;
    image_view& operator=(image_view&&) = delete;
    
    [[nodiscard]] inline constexpr const std::shared_ptr<image>& get_image() const noexcept
    {
        return m_image;
    }
    
    [[nodiscard]] inline constexpr format get_format() const noexcept
    {
        return m_format;
    }
    
    [[nodiscard]] inline constexpr std::uint32_t get_first_mip_level() const noexcept
    {
        return m_first_mip_level;
    }
    
    [[nodiscard]] inline constexpr std::uint32_t get_mip_level_count() const noexcept
    {
        return m_mip_level_count;
    }
    
    [[nodiscard]] inline constexpr std::uint32_t get_first_array_layer() const noexcept
    {
        return m_first_array_layer;
    }
    
    [[nodiscard]] inline constexpr std::uint32_t get_array_layer_count() const noexcept
    {
        return m_array_layer_count;
    }
    
    [[nodiscard]] inline constexpr std::uint8_t get_dimensionality() const noexcept
    {
        return m_dimensionality;
    }
    
    [[nodiscard]] inline constexpr bool is_1d() const noexcept
    {
        return m_dimensionality == 1;
    }
    
    [[nodiscard]] inline constexpr bool is_2d() const noexcept
    {
        return m_dimensionality == 2;
    }
    
    [[nodiscard]] inline constexpr bool is_3d() const noexcept
    {
        return m_dimensionality == 3;
    }
    
    [[nodiscard]] inline constexpr bool is_array() const noexcept
    {
        return m_flags & std::to_underlying(image_view_flag::array);
    }
    
    [[nodiscard]] inline constexpr bool is_cube() const noexcept
    {
        return m_flags & std::to_underlying(image_view_flag::cube);
    }
    
protected:
    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
    );
    
private:
    friend class framebuffer;
    friend class gl_shader_texture_1d;
    friend class gl_shader_texture_2d;
    friend class gl_shader_texture_3d;
    friend class gl_shader_texture_cube;
    
    unsigned int m_gl_texture_name{0};
    std::shared_ptr<image> m_image;
    std::uint8_t m_dimensionality{0};
    format m_format{format::undefined};
    std::uint32_t m_first_mip_level{0};
    std::uint32_t m_mip_level_count{0};
    std::uint32_t m_first_array_layer{0};
    std::uint32_t m_array_layer_count{0};
    std::uint8_t m_flags{0};
};
 
class image_view_1d: public image_view
{
public:
    image_view_1d
    (
        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
    );
};
 
class image_view_1d_array: public image_view
{
public:
    image_view_1d_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
    );
};
 
class image_view_2d: public image_view
{
public:
    image_view_2d
    (
        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
    );
};
 
class image_view_2d_array: public image_view
{
public:
    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
    );
};
 
class image_view_3d: public image_view
{
public:
    image_view_3d
    (
        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
    );
};
 
class image_view_cube: public image_view
{
public:
    image_view_cube
    (
        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
    );
};
 
class image_view_cube_array: public image_view
{
public:
    image_view_cube_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 = 6
    );
};
 
} // namespace gl
 
#endif // ANTKEEPER_GL_IMAGE_VIEW_HPP