Differential D4830 Diff 21083 source/renderer/backend/IFramebuffer.h

Changeset View

Standalone View

source/renderer/backend/IFramebuffer.h

	Show All 21 Lines
	#include "renderer/backend/IDeviceObject.h"			#include "renderer/backend/IDeviceObject.h"

	namespace Renderer			namespace Renderer
	{			{

	namespace Backend			namespace Backend
	{			{

				/**
				* Load operation is set for each attachment, what should be done with its
				StanUnsubmitted Done Inline Actions wrong ident Stan: wrong ident
				* content on BeginFramebufferPass.
				*/
				enum class AttachmentLoadOp
				{
				// Loads the attachment content.
				LOAD,
				// Clears the attachment content without loading. Prefer to use that
				// operation over manual ClearFramebuffer.
				CLEAR,
				// After BeginFramebufferPass the attachment content is undefined.
				DONT_CARE
				};

				/**
				* Store operation is set for each attachment, what should be done with its
				StanUnsubmitted Done Inline Actions here too Stan: here too
				* content on EndFramebufferPass.
				*/
				enum class AttachmentStoreOp
				{
				// Stores the attachment content.
				StanUnsubmitted Not Done Inline Actions Does doxygen support commenting enums? Stan: Does doxygen support commenting enums?
				vladislavbelovAuthorUnsubmitted Done Inline Actions I think it should, but I'm not sure which format is required. It seems we don't use something for enumerations yet. vladislavbelov: I think it should, but I'm not sure which format is required. It seems we don't use something…
				STORE,
				// After EndFramebufferPass the attachment content is undefined.
				DONT_CARE
				};

				/**
				* 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).
				*/
	class IFramebuffer : public IDeviceObject<IFramebuffer>			class IFramebuffer : public IDeviceObject<IFramebuffer>
	{			{
	public:			public:
				/**
				* Returns a clear color for all color attachments of the framebuffer.
				* @see IDevice::CreateFramebuffer()
				*/
	virtual const CColor& GetClearColor() const = 0;			virtual const CColor& GetClearColor() const = 0;
	};			};

	} // namespace Backend			} // namespace Backend

	} // namespace Renderer			} // namespace Renderer

	#endif // INCLUDED_RENDERER_BACKEND_IFRAMEBUFFER			#endif // INCLUDED_RENDERER_BACKEND_IFRAMEBUFFER