Antkeeper  0.0.1
cube-map.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Christopher J. Howard
3  *
4  * This file is part of Antkeeper source code.
5  *
6  * Antkeeper source code is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Antkeeper source code is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ANTKEEPER_GL_CUBE_MAP_HPP
21 #define ANTKEEPER_GL_CUBE_MAP_HPP
22 
23 #include <cstdint>
24 
25 namespace gl {
26 
28 enum class cube_map_layout: std::uint8_t
29 {
31  unknown,
32 
34  column,
35 
37  row,
38 
41 
44 
47 
49  spherical
50 };
51 
60 [[nodiscard]] cube_map_layout infer_cube_map_layout(std::uint32_t width, std::uint32_t height) noexcept;
61 
71 [[nodiscard]] std::uint32_t infer_cube_map_face_width(std::uint32_t width, std::uint32_t height, cube_map_layout layout) noexcept;
72 
73 } // namespace gl
74 
75 #endif // ANTKEEPER_GL_CUBE_MAP_HPP
Graphics library interface.
Definition: window.hpp:28
std::uint32_t infer_cube_map_face_width(std::uint32_t width, std::uint32_t height, cube_map_layout layout) noexcept
Infers the width of a cube map face from its dimensons and layout.
Definition: cube-map.cpp:54
cube_map_layout infer_cube_map_layout(std::uint32_t width, std::uint32_t height) noexcept
Infers the layout of a cube map from its dimensions.
Definition: cube-map.cpp:24
cube_map_layout
Cube map layouts.
Definition: cube-map.hpp:29
@ column
Faces are stored consecutively in a single column.
@ spherical
Faces are stored in a spherical projection.
@ horizontal_cross
Faces are stored in a horizontal cross.
@ unknown
Unknown layout.
@ equirectangular
Faces are stored in an equirectangular projection.
@ vertical_cross
Faces are stored in a vertical cross.
@ row
Faces are stored consecutively in a single row.