/*

Copyright (c) 2005,

Aaron Lefohn (lefohn@cs.ucdavis.edu)

Robert Strzodka (strzodka@caesar.de)

Adam Moerschell (atmoerschell@ucdavis.edu)

All rights reserved.

This software is licensed under the BSD open-source license. See

http://www.opensource.org/licenses/bsd-license.php for more detail.

*************************************************************

Redistribution and use in source and binary forms, with or

without modification, are permitted provided that the following

conditions are met:

Redistributions of source code must retain the above copyright notice,

this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice,

this list of conditions and the following disclaimer in the documentation

and/or other materials provided with the distribution.

Neither the name of the University of Californa, Davis nor the names of

the contributors may be used to endorse or promote products derived

from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL

THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE

GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF

THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY

OF SUCH DAMAGE.

*/

#include "stdafx.h"

#include "framebufferObject.h"

#include "Gl/glew.h"

using namespace std;

FramebufferObject::FramebufferObject()

: m_fboId(_GenerateFboId()),

m_savedFboId(0)

{

// Bind this FBO so that it actually gets created now

_GuardedBind();

_GuardedUnbind();

}

FramebufferObject::~FramebufferObject()

{

glDeleteFramebuffersEXT(1, &m_fboId);

}

void FramebufferObject::Bind()

{

glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, m_fboId);

}

void FramebufferObject::Disable()

{

glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, 0);

}

void

FramebufferObject::AttachTexture( GLenum attachment, GLenum texType,

GLuint texId, int mipLevel, int zSlice)

{

_GuardedBind();

#ifndef NDEBUG

if( GetAttachedId(attachment) != texId ) {

#endif

_FramebufferTextureND( attachment, texType,

texId, mipLevel, zSlice );

#ifndef NDEBUG

}

/*else {

cerr << "FramebufferObject::AttachTexture PERFORMANCE WARNING:\n"

<< "\tRedundant bind of texture (id = " << texId << ").\n"

<< "\tHINT : Compile with -DNDEBUG to remove this warning.\n";

}*/

#endif

_GuardedUnbind();

}

void

FramebufferObject::AttachRenderBuffer( GLenum attachment, GLuint buffId )

{

_GuardedBind();

#ifndef NDEBUG

if( GetAttachedId(attachment) != buffId ) {

#endif

glFramebufferRenderbufferEXT( GL_FRAMEBUFFER_EXT, attachment,

GL_RENDERBUFFER_EXT, buffId);

#ifndef NDEBUG

}

/*else {

cerr << "FramebufferObject::AttachRenderBuffer PERFORMANCE WARNING:\n"

<< "\tRedundant bind of Renderbuffer (id = " << buffId << ")\n"

<< "\tHINT : Compile with -DNDEBUG to remove this warning.\n";

}*/

#endif

_GuardedUnbind();

}

void

FramebufferObject::Unattach( GLenum attachment )

{

_GuardedBind();

GLenum type = GetAttachedType(attachment);

switch(type) {

case GL_NONE:

break;

case GL_RENDERBUFFER_EXT:

AttachRenderBuffer( attachment, 0 );

break;

case GL_TEXTURE:

AttachTexture( attachment, GL_TEXTURE_2D, 0 );

break;

default:

cerr << "FramebufferObject::unbind_attachment ERROR: Unknown attached resource type\n";

}

_GuardedUnbind();

}

GLint FramebufferObject::GetMaxColorAttachments()

{

GLint maxAttach = 0;

glGetIntegerv( GL_MAX_COLOR_ATTACHMENTS_EXT, &maxAttach );

return maxAttach;

}

GLuint FramebufferObject::_GenerateFboId()

{

GLuint id = 0;

glGenFramebuffersEXT(1, &id);

return id;

}

void FramebufferObject::_GuardedBind()

{

// Only binds if m_fboId is different than the currently bound FBO

glGetIntegerv( GL_FRAMEBUFFER_BINDING_EXT, &m_savedFboId );

if (m_fboId != m_savedFboId) {

glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, m_fboId);

}

}

void FramebufferObject::_GuardedUnbind()

{

// Returns FBO binding to the previously enabled FBO

if (m_savedFboId != m_fboId) {

glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, (GLuint)m_savedFboId);

}

}

void

FramebufferObject::_FramebufferTextureND( GLenum attachment, GLenum texType,

GLuint texId, int mipLevel,

int zSlice )

{

if (texType == GL_TEXTURE_1D) {

glFramebufferTexture1DEXT( GL_FRAMEBUFFER_EXT, attachment,

GL_TEXTURE_1D, texId, mipLevel );

}

else if (texType == GL_TEXTURE_3D) {

glFramebufferTexture3DEXT( GL_FRAMEBUFFER_EXT, attachment,

GL_TEXTURE_3D, texId, mipLevel, zSlice );

}

else {

// Default is GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE_ARB, or cube faces

glFramebufferTexture2DEXT( GL_FRAMEBUFFER_EXT, attachment,

texType, texId, mipLevel );

}

}

#ifndef NDEBUG

bool FramebufferObject::IsValid( ostream& ostr )

{

_GuardedBind();

bool isOK = false;

GLenum status;

status = glCheckFramebufferStatusEXT(GL_FRAMEBUFFER_EXT);

switch(status) {

case GL_FRAMEBUFFER_COMPLETE_EXT: // Everything's OK

isOK = true;

break;

case GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT\n";

isOK = false;

break;

case GL_FRAMEBUFFER_UNSUPPORTED_EXT:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "GL_FRAMEBUFFER_UNSUPPORTED_EXT\n";

isOK = false;

break;

//case GL_FRAMEBUFFER_STATUS_ERROR_EXT:

// ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

// << "GL_FRAMEBUFFER_STATUS_ERROR_EXT\n";

// isOK = false;

// break;

default:

ostr << "glift::CheckFramebufferStatus() ERROR:\n\t"

<< "Unknown ERROR\n";

isOK = false;

}

_GuardedUnbind();

return isOK;

}

#endif // NDEBUG

/// Accessors

GLenum FramebufferObject::GetAttachedType( GLenum attachment )

{

// Returns GL_RENDERBUFFER_EXT or GL_TEXTURE

_GuardedBind();

GLint type = 0;

glGetFramebufferAttachmentParameterivEXT(GL_FRAMEBUFFER_EXT, attachment,

GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE_EXT,

&type);

_GuardedUnbind();

return GLenum(type);

}

GLuint FramebufferObject::GetAttachedId( GLenum attachment )

{

_GuardedBind();

GLint id = 0;

glGetFramebufferAttachmentParameterivEXT(GL_FRAMEBUFFER_EXT, attachment,

GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME_EXT,

&id);

_GuardedUnbind();

return GLuint(id);

}

GLint FramebufferObject::GetAttachedMipLevel( GLenum attachment )

{

_GuardedBind();

GLint level = 0;

glGetFramebufferAttachmentParameterivEXT(GL_FRAMEBUFFER_EXT, attachment,

GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL_EXT,

&level);

_GuardedUnbind();

return level;

}

GLint FramebufferObject::GetAttachedCubeFace( GLenum attachment )

{

_GuardedBind();

GLint level = 0;

glGetFramebufferAttachmentParameterivEXT(GL_FRAMEBUFFER_EXT, attachment,

GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE_EXT,

&level);

_GuardedUnbind();

return level;

}

GLint FramebufferObject::GetAttachedZSlice( GLenum attachment )

{

_GuardedBind();

GLint slice = 0;

glGetFramebufferAttachmentParameterivEXT(GL_FRAMEBUFFER_EXT, attachment,

GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_3D_ZOFFSET_EXT,

&slice);

_GuardedUnbind();

return slice;

}