staplegl::cubemap Class Reference

Cube map texture wrapper. More...

#include <cubemap.hpp>

Collaboration diagram for staplegl::cubemap:

Public Member Functions
	cubemap (std::span< std::span< std::byte >, 6 > data, resolution res, texture_color color, texture_filter filter, bool generate_mipmaps=false) noexcept
	Construct a new cubemap object.
	~cubemap () noexcept
	Destroy the cubemap object.
	cubemap (const cubemap &)=delete
auto	operator= (const cubemap &) -> cubemap &=delete
	cubemap (cubemap &&other) noexcept
	Construct a new cubemap object from another cubemap object.
auto	operator= (cubemap &&other) noexcept -> cubemap &
	Move assignment operator.
void	bind () const
	Bind the cubemap texture.
constexpr auto	id () const noexcept -> uint32_t
	Get the texture id.
constexpr auto	color () const noexcept -> texture_color
	Get the texture color.
constexpr auto	res () const noexcept -> resolution
	Get the resolution of the cubemap.
void	set_unit (std::uint32_t unit_offset) const
	Set the unit object to bind the texture to.

Static Public Member Functions
static void	unbind ()
	Unbind the cubemap texture.

Private Attributes
uint32_t	m_id {}
resolution	m_res {}
texture_color	m_color {}
texture_filter	m_filter {}

Detailed Description

Cube map texture wrapper.

Examples

teapot.cpp.

Definition at line 33 of file cubemap.hpp.

Constructor & Destructor Documentation

cubemap() [1/3]

staplegl::cubemap::cubemap ( std::span< std::span< std::byte >, 6 >  data, resolution  res, texture_color  color, texture_filter  filter, bool  generate_mipmaps = false  )

inlinenoexcept

Construct a new cubemap object.

Parameters

data	The cubemap data, six faces of the cube.
res	The resolution of the cubemap.
color	The color format of the cubemap.
filter	The filtering algorithms to use for the cubemap.
generate_mipmaps	Whether to generate mipmaps for the cubemap, defaults to false.

Definition at line 146 of file cubemap.hpp.

~cubemap()

staplegl::cubemap::~cubemap ( )

inlinenoexcept

Destroy the cubemap object.

Definition at line 55 of file cubemap.hpp.

cubemap() [2/3]

staplegl::cubemap::cubemap ( const cubemap &  )

delete

cubemap() [3/3]

staplegl::cubemap::cubemap ( cubemap &&  other )

inlinenoexcept

Construct a new cubemap object from another cubemap object.

Parameters

other

the other cubemap object to move from.

Definition at line 72 of file cubemap.hpp.

Member Function Documentation

bind()

void staplegl::cubemap::bind ( ) const

inline

Bind the cubemap texture.

Definition at line 171 of file cubemap.hpp.

color()

constexpr auto staplegl::cubemap::color ( ) const -> texture_color

inlineconstexprnoexcept

Get the texture color.

Returns

texture_color the texture color.

Definition at line 123 of file cubemap.hpp.

id()

constexpr auto staplegl::cubemap::id ( ) const -> uint32_t

inlineconstexprnoexcept

Get the texture id.

Returns

uint32_t the texture id.

Definition at line 116 of file cubemap.hpp.

operator=() [1/2]

auto staplegl::cubemap::operator= ( const cubemap &  ) -> cubemap &=delete

delete

operator=() [2/2]

auto staplegl::cubemap::operator= ( cubemap &&  other ) -> cubemap&

inlinenoexcept

Move assignment operator.

Parameters

other

the other cubemap object to move from.

Returns

cubemap& a reference to this object.

Definition at line 87 of file cubemap.hpp.

res()

constexpr auto staplegl::cubemap::res ( ) const -> resolution

inlineconstexprnoexcept

Get the resolution of the cubemap.

Returns

resolution the resolution of the cubemap.

Definition at line 130 of file cubemap.hpp.

set_unit()

void staplegl::cubemap::set_unit ( std::uint32_t  unit_offset ) const

inline

Set the unit object to bind the texture to.

Parameters

unit_offset

an offset that specifies the unit on which to bind the texture.

Definition at line 181 of file cubemap.hpp.

unbind()

void staplegl::cubemap::unbind ( )

inlinestatic

Unbind the cubemap texture.

Definition at line 176 of file cubemap.hpp.

Member Data Documentation

m_color

texture_color staplegl::cubemap::m_color {}

private

Definition at line 142 of file cubemap.hpp.

m_filter

texture_filter staplegl::cubemap::m_filter {}

private

Definition at line 143 of file cubemap.hpp.

m_id

uint32_t staplegl::cubemap::m_id {}

private

Definition at line 140 of file cubemap.hpp.

m_res

resolution staplegl::cubemap::m_res {}

private

Definition at line 141 of file cubemap.hpp.

---

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

• include/modules/cubemap.hpp