AeonGames::FrameBuffer Class Reference

Abstract interface for off-screen render target (frame buffer) resources. More...

#include <aeongames/FrameBuffer.hpp>

Inheritance diagram for AeonGames::FrameBuffer:

Collaboration diagram for AeonGames::FrameBuffer:

Public Member Functions
virtual void	LoadFromPBMsg (const FrameBufferMsg &aFrameBufferMsg)=0
	Initialize the frame buffer from a protobuf message.
virtual void	Unload ()=0
	Release all resources held by this frame buffer.
virtual void	Resize (uint32_t aWidth, uint32_t aHeight)=0
	Resize the frame buffer to new dimensions.
virtual void	Bind ()=0
	Bind this frame buffer as the current render target.
virtual void	Unbind ()=0
	Unbind this frame buffer, restoring the previous render target.
Public Member Functions inherited from AeonGames::Resource
virtual	~Resource ()
	Virtual destructor.
virtual void	LoadFromMemory (const void *aBuffer, size_t aBufferSize)=0
	Load the resource from a raw memory buffer.
DLL void	LoadFromId (uint32_t aId)
	Load the resource identified by a numeric id.
DLL void	LoadFromFile (const std::string &aFilename)
	Load the resource from a file on disk.
DLL size_t	GetConsecutiveId () const
	Get the Consecutive Id for the resource object.

Detailed Description

Abstract interface for off-screen render target (frame buffer) resources.

Definition at line 34 of file FrameBuffer.hpp.

Member Function Documentation

Bind()

virtual void AeonGames::FrameBuffer::Bind ( )

pure virtual

Bind this frame buffer as the current render target.

Implemented in AeonGames::VulkanFrameBuffer.

LoadFromPBMsg()

virtual void AeonGames::FrameBuffer::LoadFromPBMsg ( const FrameBufferMsg & aFrameBufferMsg )

pure virtual

Initialize the frame buffer from a protobuf message.

Parameters

aFrameBufferMsg

Protobuf message describing the frame buffer configuration.

Implemented in AeonGames::VulkanFrameBuffer.

Resize()

virtual void AeonGames::FrameBuffer::Resize ( uint32_t aWidth, uint32_t aHeight )

pure virtual

Resize the frame buffer to new dimensions.

Parameters

aWidth	New width in pixels.
aHeight	New height in pixels.

Implemented in AeonGames::VulkanFrameBuffer.

Unbind()

virtual void AeonGames::FrameBuffer::Unbind ( )

pure virtual

Unbind this frame buffer, restoring the previous render target.

Implemented in AeonGames::VulkanFrameBuffer.

Unload()

virtual void AeonGames::FrameBuffer::Unload ( )

pure virtual

Release all resources held by this frame buffer.

Implements AeonGames::Resource.

Implemented in AeonGames::VulkanFrameBuffer.

---

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

• include/aeongames/FrameBuffer.hpp
• engine/core/FrameBuffer.cpp