staplegl::renderbuffer Class Reference

Render Buffer Object (RBO) wrapper. More...

#include <renderbuffer.hpp>

Collaboration diagram for staplegl::renderbuffer:

Public Types
enum class	attachment_type : uint32_t { depth = GL_DEPTH_ATTACHMENT , stencil = GL_STENCIL_ATTACHMENT , depth_stencil = GL_DEPTH_STENCIL_ATTACHMENT }
	Renderbuffer attachment type. More...

Public Member Functions
	renderbuffer (resolution res, attachment_type type=attachment_type::depth_stencil, tex_samples samples=tex_samples::MSAA_X1) noexcept
	Construct a new renderbuffer object with the specified resolution, attachment type and sample count.
	~renderbuffer ()
	Destroy the renderbuffer object.
	renderbuffer (const renderbuffer &)=delete
auto	operator= (const renderbuffer &) -> renderbuffer &=delete
	renderbuffer (renderbuffer &&other) noexcept
	Construct a new renderbuffer object.
auto	operator= (renderbuffer &&other) noexcept -> renderbuffer &
	Move assignment operator.
void	bind () const
	Bind the renderbuffer object.
void	unbind () const
	Unbind the renderbuffer object.
constexpr auto	id () const noexcept -> uint32_t
	Get the ID of the renderbuffer object.
constexpr auto	res () const noexcept -> resolution
	Get the resolution of the renderbuffer object.
constexpr auto	type () const noexcept -> attachment_type
	Get the attachment type of the renderbuffer object.
constexpr auto	samples () const noexcept -> tex_samples
	Get the sample count of the renderbuffer object.

Private Attributes
uint32_t	m_id {}
resolution	m_res {}
attachment_type	m_type {}
tex_samples	m_samples {}

Detailed Description

Render Buffer Object (RBO) wrapper.

Definition at line 30 of file renderbuffer.hpp.

Member Enumeration Documentation

attachment_type

enum class staplegl::renderbuffer::attachment_type : uint32_t

strong

Renderbuffer attachment type.

This enum is used to specify the type of attachment that the renderbuffer will be used for.

Enumerator
depth
stencil
depth_stencil

Definition at line 40 of file renderbuffer.hpp.

Constructor & Destructor Documentation

renderbuffer() [1/3]

staplegl::renderbuffer::renderbuffer ( resolution  res, attachment_type  type = attachment_type::depth_stencil, tex_samples  samples = tex_samples::MSAA_X1  )

inlinenoexcept

Construct a new renderbuffer object with the specified resolution, attachment type and sample count.

Parameters

res	Resolution of the renderbuffer.
type	Attachment type of the renderbuffer.
samples	Sample count of the renderbuffer, defaults to 1.

Definition at line 133 of file renderbuffer.hpp.

~renderbuffer()

staplegl::renderbuffer::~renderbuffer ( )

inline

Destroy the renderbuffer object.

Definition at line 164 of file renderbuffer.hpp.

renderbuffer() [2/3]

staplegl::renderbuffer::renderbuffer ( const renderbuffer &  )

delete

renderbuffer() [3/3]

staplegl::renderbuffer::renderbuffer ( renderbuffer &&  other )

inlinenoexcept

Construct a new renderbuffer object.

Parameters

other

The renderbuffer object to move from.

Note

Moving from a renderbuffer is cheap since it only involves copying the OpenGL ID, the other object will be left with an ID of 0.

Definition at line 170 of file renderbuffer.hpp.

Member Function Documentation

bind()

void staplegl::renderbuffer::bind ( ) const

inline

Bind the renderbuffer object.

Definition at line 193 of file renderbuffer.hpp.

id()

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

inlineconstexprnoexcept

Get the ID of the renderbuffer object.

Returns

uint32_t the ID of the renderbuffer object.

Definition at line 102 of file renderbuffer.hpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

inlinenoexcept

Move assignment operator.

Parameters

other

The renderbuffer object to move from.

Returns

renderbuffer& The moved object.

Definition at line 179 of file renderbuffer.hpp.

res()

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

inlineconstexprnoexcept

Get the resolution of the renderbuffer object.

Returns

resolution A resolution object containing the width and height of the renderbuffer.

Definition at line 109 of file renderbuffer.hpp.

samples()

constexpr auto staplegl::renderbuffer::samples ( ) const -> tex_samples

inlineconstexprnoexcept

Get the sample count of the renderbuffer object.

Returns

tex_samples The sample count of the renderbuffer object.

Definition at line 124 of file renderbuffer.hpp.

type()

constexpr auto staplegl::renderbuffer::type ( ) const -> attachment_type

inlineconstexprnoexcept

Get the attachment type of the renderbuffer object.

Returns

attachment_type The attachment type of the renderbuffer object.

Definition at line 117 of file renderbuffer.hpp.

unbind()

void staplegl::renderbuffer::unbind ( ) const

inline

Unbind the renderbuffer object.

Definition at line 198 of file renderbuffer.hpp.

Member Data Documentation

m_id

uint32_t staplegl::renderbuffer::m_id {}

private

Definition at line 127 of file renderbuffer.hpp.

m_res

resolution staplegl::renderbuffer::m_res {}

private

Definition at line 128 of file renderbuffer.hpp.

m_samples

tex_samples staplegl::renderbuffer::m_samples {}

private

Definition at line 130 of file renderbuffer.hpp.

m_type

attachment_type staplegl::renderbuffer::m_type {}

private

Definition at line 129 of file renderbuffer.hpp.

---

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

• include/modules/renderbuffer.hpp