staplegl::texture_2d Class Reference

2D texture wrapper. More...

#include <texture.hpp>

Collaboration diagram for staplegl::texture_2d:

Public Member Functions
	texture_2d ()=default
	Construct a new texture 2d object.
template<typename T > requires std::integral<T> || std::floating_point<T>
	texture_2d (std::span< const T > data, resolution res, texture_color color, texture_filter filters, tex_samples samples=tex_samples::MSAA_X1, bool generate_mipmap=false) noexcept
	Construct a new texture 2d object.
	~texture_2d ()
	Destroy the texture 2d object.
	texture_2d (const texture_2d &)=delete
auto	operator= (const texture_2d &) -> texture_2d &=delete
	texture_2d (texture_2d &&other) noexcept
	Construct a new texture 2d object.
auto	operator= (texture_2d &&other) noexcept -> texture_2d &
	Move assignment operator.
void	set_unit (std::uint32_t unit_offset)
	Activate the texture on a unit.
void	set_data (std::span< const float > data, resolution res, texture_color color, bool generate_mipmap=false)
	Set the data object.
void	bind () const
	Bind the texture object.
void	unbind () const
	Unbind the texture object.
auto constexpr	get_unit () const -> uint32_t
	Get the last texture unit this texture was bound to.
constexpr auto	color () const -> texture_color
	Get the texture color struct.
constexpr auto	id () const -> std::uint32_t
	Get the id of the texture object.
constexpr auto	get_resolution () const -> staplegl::resolution
	Get the resolution of the texture object.
constexpr auto	filter () const -> texture_filter
	Get the texture filter struct.
constexpr auto	antialias () const -> texture_antialias
	Get the texture antialias struct.

Private Attributes
std::uint32_t	m_id {}
std::uint32_t	m_unit {}
texture_color	m_color {}
texture_filter	m_filter {}
resolution	m_resolution {}
texture_antialias	m_antialias {}

Detailed Description

2D texture wrapper.

Examples

teapot.cpp.

Definition at line 97 of file texture.hpp.

Constructor & Destructor Documentation

texture_2d() [1/4]

staplegl::texture_2d::texture_2d ( )

default

Construct a new texture 2d object.

This constructor is only left here to allow users to create containers of texture_2d objects without having to initialize them immediately, every one of those instances should be overwritten before use through a call to texture_2d::(std::span<T> data, resolution res, texture_color color, bool generate_mipmap).

A default-constructed texture_2d object is still valid, having an ID of 0, it is however not backed by any OpenGL texture object, therefore it cannot be used in any OpenGL calls (binding it to a framebuffer, for example, would be practically equivalent to unbinding the color attachment for that particular slot).

Warning

this constructor does not initialize the texture object, remember to perform initialization before using it.

texture_2d() [2/4]

template<typename T >
requires std::integral<T> || std::floating_point<T>

staplegl::texture_2d::texture_2d ( std::span< const T >  data, resolution  res, texture_color  color, texture_filter  filters, tex_samples  samples = tex_samples::MSAA_X1, bool  generate_mipmap = false  )

inlinenoexcept

Construct a new texture 2d object.

Template Parameters

T	raw type of the data, commonly float or uint8_t (unsigned char)

Parameters

data	span of floats that contains the texture data.
res	resolution of the texture.
color	descriptor of the texture's color format and data type.
filters	descriptor of the texture's filtering and clamping.
samples	the number of samples to use for the texture, defaults to 1.
generate_mipmap	whether to generate mipmaps for the texture, defaults to false.

Definition at line 298 of file texture.hpp.

~texture_2d()

staplegl::texture_2d::~texture_2d ( )

inline

Destroy the texture 2d object.

Definition at line 137 of file texture.hpp.

texture_2d() [3/4]

staplegl::texture_2d::texture_2d ( const texture_2d &  )

delete

texture_2d() [4/4]

staplegl::texture_2d::texture_2d ( texture_2d &&  other )

inlinenoexcept

Construct a new texture 2d object.

Parameters

other

the other texture_2d object to move from.

Definition at line 156 of file texture.hpp.

Member Function Documentation

antialias()

constexpr auto staplegl::texture_2d::antialias ( ) const -> texture_antialias

inlineconstexpr

Get the texture antialias struct.

Returns

texture_antialias

Definition at line 280 of file texture.hpp.

bind()

void staplegl::texture_2d::bind ( ) const

inline

Bind the texture object.

Definition at line 212 of file texture.hpp.

color()

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

inlineconstexpr

Get the texture color struct.

Returns

texture_color

Definition at line 240 of file texture.hpp.

filter()

constexpr auto staplegl::texture_2d::filter ( ) const -> texture_filter

inlineconstexpr

Get the texture filter struct.

Returns

texture_filter

Definition at line 270 of file texture.hpp.

get_resolution()

constexpr auto staplegl::texture_2d::get_resolution ( ) const -> staplegl::resolution

inlineconstexpr

Get the resolution of the texture object.

Returns

staplegl::resolution

Definition at line 260 of file texture.hpp.

get_unit()

auto constexpr staplegl::texture_2d::get_unit ( ) const -> uint32_t

inlineconstexpr

Get the last texture unit this texture was bound to.

Returns

uint32_t a texture unit offset from GL_TEXTURE0.

Definition at line 230 of file texture.hpp.

id()

constexpr auto staplegl::texture_2d::id ( ) const -> std::uint32_t

inlineconstexpr

Get the id of the texture object.

Returns

std::uint32_t

Definition at line 250 of file texture.hpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

inlinenoexcept

Move assignment operator.

Parameters

other

the other texture_2d object to move from.

Returns

texture_2d& the reference to this object.

Definition at line 172 of file texture.hpp.

set_data()

void staplegl::texture_2d::set_data ( std::span< const float >  data, resolution  res, texture_color  color, bool  generate_mipmap = false  )

inline

Set the data object.

Parameters

data	A span of floats that contains the new data.
res	A resolution object containing the new resolution.
color	A texture_color object containing the new color format and data type.
generate_mipmap	Whether to generate mipmaps for the texture, defaults to false.

Definition at line 327 of file texture.hpp.

set_unit()

void staplegl::texture_2d::set_unit ( std::uint32_t  unit_offset )

inline

Activate the texture on a unit.

Parameters

unit_offset

a texture unit offset from GL_TEXTURE0.

Definition at line 190 of file texture.hpp.

unbind()

void staplegl::texture_2d::unbind ( ) const

inline

Unbind the texture object.

Definition at line 221 of file texture.hpp.

Member Data Documentation

m_antialias

texture_antialias staplegl::texture_2d::m_antialias {}

private

Definition at line 293 of file texture.hpp.

m_color

texture_color staplegl::texture_2d::m_color {}

private

Definition at line 290 of file texture.hpp.

m_filter

texture_filter staplegl::texture_2d::m_filter {}

private

Definition at line 291 of file texture.hpp.

m_id

std::uint32_t staplegl::texture_2d::m_id {}

private

Definition at line 288 of file texture.hpp.

m_resolution

resolution staplegl::texture_2d::m_resolution {}

private

Definition at line 292 of file texture.hpp.

m_unit

std::uint32_t staplegl::texture_2d::m_unit {}

private

Definition at line 289 of file texture.hpp.

---

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

• include/modules/texture.hpp