scl::gl_frame_buffer Class Reference

#include <gl_frame_buffer.h>

Inheritance diagram for scl::gl_frame_buffer:

Public Member Functions
void	SetFrameBufferProps (const frame_buffer_props &Props)
const frame_buffer_props &	GetFrameBufferProps () const
const shared< texture_2d > &	GetColorAttachment (int Index) const override
const shared< texture_2d > &	GetDepthAttachment (int Index) const override
render_primitive::handle	GetHandle () const override
	gl_frame_buffer (const frame_buffer_props &Props)
	~gl_frame_buffer () override
void	Bind () const override
void	Unbind () const override
void	Resize (int Width, int Height) override
void	Free () override
void	Clear () override
Public Member Functions inherited from scl::frame_buffer
virtual void	SetFrameBufferProps (const frame_buffer_props &Props)=0
virtual const frame_buffer_props &	GetFrameBufferProps () const =0
virtual const shared< texture_2d > &	GetColorAttachment (int Index=0) const =0
virtual const shared< texture_2d > &	GetDepthAttachment (int Index=0) const =0
virtual	~frame_buffer ()=default
virtual void	Bind () const =0
virtual void	Unbind () const =0
virtual void	Resize (int Width, int Height)=0
virtual void	Free ()=0
virtual void	Clear ()=0

Additional Inherited Members
Static Public Member Functions inherited from scl::frame_buffer
static shared< frame_buffer >	Create (const frame_buffer_props &Props)

Detailed Description

OpenGL frame buffer class.

Definition at line 18 of file gl_frame_buffer.h.

Constructor & Destructor Documentation

gl_frame_buffer()

scl::gl_frame_buffer::gl_frame_buffer

(

const frame_buffer_props &

Props

)

• OpenGL frame buffer constructor.

Parameters

Props

- frame buffer properties.

Definition at line 85 of file gl_frame_buffer.cpp.

                                                                   :
    Props(Props)
{
    this->Invalidate();
    SCL_CORE_SUCCES("OpenGL Frame Buffer with id {} created.", Id);
}

~gl_frame_buffer()

scl::gl_frame_buffer::~gl_frame_buffer ( )

override

OpenGL frame buffer default destructor.

Definition at line 92 of file gl_frame_buffer.cpp.

{
    this->Free();
}

Member Function Documentation

Bind()

void scl::gl_frame_buffer::Bind ( ) const

overridevirtual

• Bind frame buffer to current render stage function.

Parameters

None.

Returns

None.

Implements scl::frame_buffer.

Definition at line 97 of file gl_frame_buffer.cpp.

{
    glBindFramebuffer(GL_FRAMEBUFFER, Id);
    glViewport(0, 0, Props.Width, Props.Height);
}

Clear()

void scl::gl_frame_buffer::Clear ( )

overridevirtual

• Clear frame buffer funcrion.

Parameters

None.

Returns

None.

Implements scl::frame_buffer.

Definition at line 128 of file gl_frame_buffer.cpp.

{
    this->Bind();
    glClear(ClearConfig);
    this->Unbind();
}

Free()

void scl::gl_frame_buffer::Free ( )

overridevirtual

• Unload frame buffer render target texture from GPU memory function.

Parameters

None.

Returns

None.

Implements scl::frame_buffer.

Definition at line 115 of file gl_frame_buffer.cpp.

{
    if (Id != 0) glDeleteFramebuffers(1, &Id);
 
    for (auto &color_attachment : ColorAttachments) color_attachment.reset();
    ColorAttachments.clear();
 
    if (DepthAttachment) DepthAttachment.reset();
 
    SCL_CORE_INFO("OpenGL Frame Buffer with id {} freed.", Id);
    Id = 0;
}

GetColorAttachment()

const scl::shared< scl::texture_2d > & scl::gl_frame_buffer::GetColorAttachment ( int  Index ) const

overridevirtual

Frame buffer color attachment getter function.

Implements scl::frame_buffer.

Definition at line 25 of file gl_frame_buffer.cpp.

{
    return ColorAttachments[Index];
}

GetDepthAttachment()

const scl::shared< scl::texture_2d > & scl::gl_frame_buffer::GetDepthAttachment ( int  Index ) const

overridevirtual

Frame buffer depth attachment getter function.

Implements scl::frame_buffer.

Definition at line 30 of file gl_frame_buffer.cpp.

{
    return DepthAttachment;
}

GetFrameBufferProps()

const scl::frame_buffer_props & scl::gl_frame_buffer::GetFrameBufferProps ( ) const

virtual

Frame buffer properties getter function.

Implements scl::frame_buffer.

Definition at line 20 of file gl_frame_buffer.cpp.

{
    return Props;
}

GetHandle()

render_primitive::handle scl::gl_frame_buffer::GetHandle ( ) const

inlineoverride

Backend api render primitive hadnle getter function.

Definition at line 48 of file gl_frame_buffer.h.

{ return Id; }

Resize()

void scl::gl_frame_buffer::Resize ( int  Width, int  Height  )

overridevirtual

• Resize frame buffer (resize also could be called by setting frame buffer props).

Parameters

Width	- new frame buffer width.
Height	- new frame buffer height.

Returns

None.

Implements scl::frame_buffer.

Definition at line 108 of file gl_frame_buffer.cpp.

{
    Props.Width = Width;
    Props.Height = Height;
    this->Invalidate();
}

SetFrameBufferProps()

void scl::gl_frame_buffer::SetFrameBufferProps ( const frame_buffer_props &  Props )

virtual

Frame buffer getter/setter functions.

Frame buffer properties setter function.

Implements scl::frame_buffer.

Definition at line 13 of file gl_frame_buffer.cpp.

{
    this->Props = Props;
    this->Invalidate();
    SCL_CORE_INFO("OpenGL Frame Buffer with id {} props changed.", Id);
}

Unbind()

void scl::gl_frame_buffer::Unbind ( ) const

overridevirtual

• Unbind frame buffer from current render stage function.

Parameters

None.

Returns

None.

Implements scl::frame_buffer.

Definition at line 103 of file gl_frame_buffer.cpp.

{
    glBindFramebuffer(GL_FRAMEBUFFER, 0);
}

---

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

• platform/opengl/gl_frame_buffer.h
• platform/opengl/gl_frame_buffer.cpp