Framebuffer Object (FBO) wrapper. More...

#include <framebuffer.hpp>

Public Member Functions
	framebuffer () noexcept
	Construct a new framebuffer::framebuffer object.

	~framebuffer ()

	framebuffer (const framebuffer &)=delete

auto	operator= (const framebuffer &) -> framebuffer &=delete

	framebuffer (framebuffer &&other) noexcept
	Construct a new framebuffer::framebuffer object.

auto	operator= (framebuffer &&other) noexcept -> framebuffer &
	Move assignment operator.

void	set_renderbuffer (resolution res, fbo_attachment attachment=fbo_attachment::ATTACH_DEPTH_STENCIL_BUFFER, tex_samples samples=tex_samples::MSAA_X1)
	Set the renderbuffer object.

void	set_texture (texture_2d const &tex, size_t index=0) const
	Set a texture as the color attachment of the framebuffer.

void	bind () const

constexpr auto	id () const -> std::uint32_t
	Get the id of the framebuffer.

constexpr auto	get_renderbuffer () const -> const std::optional< renderbuffer > &

constexpr auto	attachment () const -> fbo_attachment

Static Public Member Functions
static void	set_viewport (resolution res)
	Resize the OpenGL viewport.

static void	bind_default ()
	Bind the default framebuffer.

static void	unbind ()

static auto	assert_completeness () -> bool
	Check if the framebuffer is complete.

static void	transfer_data (framebuffer const &src, framebuffer const &dst, resolution res)
	Transfer the contents of a framebuffer to another.

Private Attributes
std::uint32_t	m_id {}

fbo_attachment	m_attachment {}

std::optional< renderbuffer >	m_renderbuffer {}

Detailed Description

Framebuffer Object (FBO) wrapper.

Examples: teapot.cpp.

Definition at line 51 of file framebuffer.hpp.

Constructor & Destructor Documentation

◆ framebuffer() [1/3]

staplegl::framebuffer::framebuffer ( )

inlinenoexcept

Construct a new framebuffer::framebuffer object.

Very thin constructor, generates an ID for the framebuffer and stores it.

Definition at line 182 of file framebuffer.hpp.

◆ ~framebuffer()

staplegl::framebuffer::~framebuffer ( )

inline

Definition at line 187 of file framebuffer.hpp.

◆ framebuffer() [2/3]

staplegl::framebuffer::framebuffer ( const framebuffer & )

delete

◆ framebuffer() [3/3]

staplegl::framebuffer::framebuffer ( framebuffer && other )

inlinenoexcept

Construct a new framebuffer::framebuffer object.

Parameters

other

Definition at line 199 of file framebuffer.hpp.

Member Function Documentation

◆ assert_completeness()

static auto staplegl::framebuffer::assert_completeness ( ) -> bool

inlinestatic

Check if the framebuffer is complete.

asserts whether a framebuffer is complete, e.g.: ready to be used for rendering. The specifics of what makes a framebuffer complete are well-defined in the OpenGL specification and available in the link below.

Warning: this function requires the framebuffer to be bound.

See also: https://www.khronos.org/opengl/wiki/Framebuffer_Object#Framebuffer_Completeness

Returns: true if the framebuffer is complete.; false otherwise.

Definition at line 129 of file framebuffer.hpp.

◆ attachment()

constexpr auto staplegl::framebuffer::attachment ( ) const -> fbo_attachment

inlineconstexpr

Definition at line 165 of file framebuffer.hpp.

◆ bind()

void staplegl::framebuffer::bind ( ) const

inline

Definition at line 306 of file framebuffer.hpp.

◆ bind_default()

static void staplegl::framebuffer::bind_default ( )

inlinestatic

Bind the default framebuffer.

Calling this function is equivalent to calling unbind on any framebuffer object, however, it is semantically more correct to call this function when you want to bind the default framebuffer (even if no framebuffer object exists).

Examples: teapot.cpp.

Definition at line 107 of file framebuffer.hpp.

◆ get_renderbuffer()

constexpr auto staplegl::framebuffer::get_renderbuffer ( ) const -> const std::optional<renderbuffer>&

constexpr

Definition at line 301 of file framebuffer.hpp.

◆ id()

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

inlineconstexpr

Get the id of the framebuffer.

Returns: std::uint32_t the id of the framebuffer.

Definition at line 158 of file framebuffer.hpp.

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

inlinenoexcept

Move assignment operator.

Parameters

other the other framebuffer object to move from.

Returns: framebuffer& the reference to this object.

Definition at line 213 of file framebuffer.hpp.

◆ set_renderbuffer()

void staplegl::framebuffer::set_renderbuffer	(	resolution	res,
		fbo_attachment	attachment = `fbo_attachment::ATTACH_DEPTH_STENCIL_BUFFER`,
		tex_samples	samples = `tex_samples::MSAA_X1`
	)

inline

Set the renderbuffer object.

Attach a renderbuffer to the framebuffer.

Parameters

res	The resolution of the renderbuffer object.
attachment	the type of attachment (Depth buffer, Stencil Buffer, Both, None).

Note: passing staplegl::fbo_attachment::NONE results in the removal of any renderbuffer from the FBO.; this function destroys any previously held renderbuffer.

See also: staplegl::fbo_attachment

Parameters

res	the resolution of the renderbuffer.
attachment	the type of the renderbuffer.

Warning: the framebuffer MUST be bound before calling this function.

Definition at line 232 of file framebuffer.hpp.

◆ set_texture()

void staplegl::framebuffer::set_texture	(	staplegl::texture_2d const &	tex,
		size_t	index = `0`
	)		const

inline

Set a texture as the color attachment of the framebuffer.

Uses the ID contained in the staplegl::texture_2d object to attach it to the framebuffer,

Note: the framebuffer must be bound before calling this function.

Warning: the framebuffer does not take ownership of the texture, hence care must be taken to ensure that the texture is not destroyed before the framebuffer.

Parameters

tex	a texture_2d to attach to the framebuffer.
index	the index of the color attachment to use, used as an offset from `GL_COLOR_ATTACHMENT0`.

Definition at line 290 of file framebuffer.hpp.

◆ set_viewport()

void staplegl::framebuffer::set_viewport ( staplegl::resolution res )

inlinestatic

Resize the OpenGL viewport.

Note: this does not resize held textures, but it's faster.

Parameters

res	The target resolution

Definition at line 296 of file framebuffer.hpp.

◆ transfer_data()

static void staplegl::framebuffer::transfer_data	(	framebuffer const &	src,
		framebuffer const &	dst,
		resolution	res
	)

inlinestatic

Transfer the contents of a framebuffer to another.

Parameters

src	The source framebuffer.
dst	The destination framebuffer.
res	The resolution of the framebuffer.

Examples: teapot.cpp.

Definition at line 143 of file framebuffer.hpp.

◆ unbind()

void staplegl::framebuffer::unbind ( )

inlinestatic

Definition at line 311 of file framebuffer.hpp.

Member Data Documentation

◆ m_attachment

fbo_attachment staplegl::framebuffer::m_attachment {}

private

Definition at line 172 of file framebuffer.hpp.

◆ m_id

std::uint32_t staplegl::framebuffer::m_id {}

private

Definition at line 171 of file framebuffer.hpp.

◆ m_renderbuffer

std::optional<renderbuffer> staplegl::framebuffer::m_renderbuffer {}

private

Definition at line 173 of file framebuffer.hpp.

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

include/modules/framebuffer.hpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ framebuffer() [1/3]

◆ ~framebuffer()

◆ framebuffer() [2/3]

◆ framebuffer() [3/3]

Member Function Documentation

◆ assert_completeness()

◆ attachment()

◆ bind()

◆ bind_default()

◆ get_renderbuffer()

◆ id()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_renderbuffer()

◆ set_texture()

◆ set_viewport()

◆ transfer_data()

◆ unbind()

Member Data Documentation

◆ m_attachment

◆ m_id

◆ m_renderbuffer