A class that enables render-to-texture by specifying textures and their attachment points. More...

#include <omGraphicsFramebuffer.h>

Inheritance diagram for om::graphics::textures::Framebuffer:

Public Member Functions
	Framebuffer ()
	Create a default framebuffer with no attachments. More...

	Framebuffer (devices::GraphicsContext *context)
	Create a default GPU framebuffer for the specified context with no attachments. More...

Size	getTargetCount () const
	Return the total number of attached target textures for this framebuffer. More...

Size	getTargetCount (FramebufferAttachment::Type attachmentType) const
	Return the total number of attached target textures with the specified attachment type for this framebuffer. More...

Texture *	getTarget (const FramebufferAttachment &attachment) const
	Return the texture that is attached at the specified framebuffer attachment point. More...

Bool	hasTarget (const FramebufferAttachment &attachment) const
	Return whether or not this framebuffer has a valid texture attached to the specified attachment point. More...

Bool	setTarget (const FramebufferAttachment &attachment, Texture *newTarget, TextureFace face=TextureFace::FRONT)
	Set the target texture for the specified framebuffer attachment point. More...

Bool	removeTarget (const FramebufferAttachment &attachment)
	Remove any previously attached texture from the specified framebuffer attachment point. More...

void	removeTargets (FramebufferAttachment::Type attachmentType)
	Remove all attached target textures with the specified attachment type from this framebuffer. More...

void	clearTargets ()
	Remove all attached target textures from this framebuffer. More...

TextureFace	getTargetFace (const FramebufferAttachment &attachment)
	Return an object representing which face of the texture at the specified attachment point is being used. More...

Bool	setTargetFace (const FramebufferAttachment &attachment, TextureFace newFace)
	Set the face of the texture at the specified attachment point that is being used. More...

Size	getWidth () const
	Return the minimum size of the framebuffer in pixels along the X direction. More...

Size	getHeight () const
	Return the minimum size of the framebuffer in pixels along the Y direction. More...

Size	getSize (Index dimension) const
	Return the minimum size of the framebuffer in pixels along the specified dimension index. More...

Size	getMinimumSize (Index dimension) const
	Return the minimum size of the framebuffer in pixels along the specified dimension index. More...

Size	getMaximumSize (Index dimension) const
	Return the maximum size of the framebuffer in pixels along the specified dimension index. More...

AABB2f	getViewport () const
	Return a 2D AABB object that covers the rectangular screen area shared by all target textures. More...

virtual void	setContext (devices::GraphicsContext *newContext)
	Set a pointer to the graphics context this buffer should use to do rendering. More...

virtual void	upload (UploadRequest &request)
	Upload this framebuffer's CPU representation to the GPU device. More...

virtual void	download (DownloadRequest &request)
	Download the framebuffer's GPU representation to CPU memory. More...

virtual Bool	isUploaded () const
	Return whether or not this framebuffer has been successfully created and uploaded to the device. More...

virtual Bool	isDownloaded () const
	Return whether or not this framebuffer has a copy of its data stored in CPU-side memory. More...

virtual Bool	isValid () const
	Return whether or not the framebuffer is valid and can be used as a render target. More...

const DeviceFramebuffer *	getRenderable () const
	Return a pointer to the context-renderable texture for this texture, or NULL if there is none. More...

Public Member Functions inherited from om::graphics::devices::GraphicsContextObject
virtual	~GraphicsContextObject ()
	Destory this graphics context object. More...

GraphicsContext *	getContext () const
	Return a pointer to the graphics context this context object is using to do rendering. More...

void	clearContext ()
	Clear the previous context from this object. More...

void	upload ()
	Upload this resource's CPU representation to the GPU device. More...

void	download ()
	Upload this resource's CPU representation to the GPU device. More...

Additional Inherited Members
Protected Member Functions inherited from om::graphics::devices::GraphicsContextObject
	GraphicsContextObject ()
	Create a new graphics context object that doesn't have an associated graphics context. More...

	GraphicsContextObject (GraphicsContext *newContext)
	Create a new graphics context object that uses the specified context for rendering. More...

Protected Attributes inherited from om::graphics::devices::GraphicsContextObject
GraphicsContext *	context
	A pointer to the graphics context this object is using. More...

Detailed Description

A class that enables render-to-texture by specifying textures and their attachment points.

A Framebuffer object contains a set of associations between rendering framebuffer attachment points and textures which are to be used for render-to-texture. This framebuffer object can then be used as a render target, where the output of rendering will be sent to the texture targets specified here rather than the main screen.

Constructor & Destructor Documentation

om::graphics::textures::Framebuffer::Framebuffer ( )

Create a default framebuffer with no attachments.

om::graphics::textures::Framebuffer::Framebuffer ( devices::GraphicsContext * context )

Create a default GPU framebuffer for the specified context with no attachments.

Member Function Documentation

Size om::graphics::textures::Framebuffer::getTargetCount ( ) const

inline

Return the total number of attached target textures for this framebuffer.

Size om::graphics::textures::Framebuffer::getTargetCount ( FramebufferAttachment::Type attachmentType ) const

Return the total number of attached target textures with the specified attachment type for this framebuffer.

Texture* om::graphics::textures::Framebuffer::getTarget ( const FramebufferAttachment & attachment ) const

Return the texture that is attached at the specified framebuffer attachment point.

If there is no target texture for that attachment point, a NULL texture resource is returned.

Bool om::graphics::textures::Framebuffer::hasTarget ( const FramebufferAttachment & attachment ) const

Return whether or not this framebuffer has a valid texture attached to the specified attachment point.

Bool om::graphics::textures::Framebuffer::setTarget	(	const FramebufferAttachment &	attachment,
		Texture *	newTarget,
		TextureFace	face = `TextureFace::FRONT`
	)

Set the target texture for the specified framebuffer attachment point.

If the specified Texture is valid and supports the specified texture face, and if the specified attachment point is supported and valid, the texture is used as the target for the specified attachment point and TRUE is returned indicating success. Otherwise, FALSE is returned indicating failure, leaving the framebuffer unchanged.

Bool om::graphics::textures::Framebuffer::removeTarget ( const FramebufferAttachment & attachment )

Remove any previously attached texture from the specified framebuffer attachment point.

If a texture was successfully removed, TRUE is returned. Otherwise, FALSE is returned, indicating that no texture target was removed.

void om::graphics::textures::Framebuffer::removeTargets ( FramebufferAttachment::Type attachmentType )

Remove all attached target textures with the specified attachment type from this framebuffer.

void om::graphics::textures::Framebuffer::clearTargets ( )

Remove all attached target textures from this framebuffer.

TextureFace om::graphics::textures::Framebuffer::getTargetFace ( const FramebufferAttachment & attachment )

Return an object representing which face of the texture at the specified attachment point is being used.

If there is no texture at that attachment point, and UNDEFINED texture face is returned. Otherwise, the texture face that is being used is returned. This will be FRONT, unless the texture is a cube map.

Bool om::graphics::textures::Framebuffer::setTargetFace	(	const FramebufferAttachment &	attachment,
		TextureFace	newFace
	)

Set the face of the texture at the specified attachment point that is being used.

If there is no texture at that attachment point or if the attached texture doesn't support the specified face type, FALSE is returned and the target face is not changed. Otherwise, the framebuffer uses the specified texture face for the attachment point and returns TRUE.

Size om::graphics::textures::Framebuffer::getWidth ( ) const

inline

Return the minimum size of the framebuffer in pixels along the X direction.

This method finds the smallest size of the attached textures along the X direction.