Renderer::Backend::IFramebuffer Class Reference

IFramebuffer stores attachments which should be used by backend as rendering destinations. More...

#include <IFramebuffer.h>

Inheritance diagram for Renderer::Backend::IFramebuffer:

Collaboration diagram for Renderer::Backend::IFramebuffer:

Public Member Functions
virtual const CColor &	GetClearColor () const =0
	Returns a clear color for all color attachments of the framebuffer. More...
virtual uint32_t	GetWidth () const =0
virtual uint32_t	GetHeight () const =0
Public Member Functions inherited from Renderer::Backend::IDeviceObject< IFramebuffer >
virtual	~IDeviceObject ()
virtual IDevice *	GetDevice ()=0
T *	As ()

Detailed Description

IFramebuffer stores attachments which should be used by backend as rendering destinations.

That combining allows to set these destinations at once. IFramebuffer doesn't own its attachments so clients must keep them alive. The number of framebuffers ever created for a device during its lifetime should be as small as possible.

Framebuffer is a term from OpenGL/Vulkan worlds (D3D synonym is a render target).

Member Function Documentation

GetClearColor()

virtual const CColor & Renderer::Backend::IFramebuffer::GetClearColor ( ) const

pure virtual

Returns a clear color for all color attachments of the framebuffer.

See also

IDevice::CreateFramebuffer()

Implemented in Renderer::Backend::Dummy::CFramebuffer, Renderer::Backend::GL::CFramebuffer, and Renderer::Backend::Vulkan::CFramebuffer.

GetHeight()

virtual uint32_t Renderer::Backend::IFramebuffer::GetHeight ( ) const

pure virtual

Implemented in Renderer::Backend::Dummy::CFramebuffer, Renderer::Backend::GL::CFramebuffer, and Renderer::Backend::Vulkan::CFramebuffer.

GetWidth()

virtual uint32_t Renderer::Backend::IFramebuffer::GetWidth ( ) const

pure virtual

Implemented in Renderer::Backend::Dummy::CFramebuffer, Renderer::Backend::GL::CFramebuffer, and Renderer::Backend::Vulkan::CFramebuffer.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/renderer/backend/IFramebuffer.h