/* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "AbstractFramebuffer.h" #include "BufferImage.h" #include "Context.h" #include "Extensions.h" #include "Image.h" #include "Implementation/FramebufferState.h" #include "Implementation/State.h" namespace Magnum { AbstractFramebuffer::ReadImplementation AbstractFramebuffer::readImplementation = &AbstractFramebuffer::readImplementationDefault; AbstractFramebuffer::DrawBuffersImplementation AbstractFramebuffer::drawBuffersImplementation = &AbstractFramebuffer::drawBuffersImplementationDefault; AbstractFramebuffer::DrawBufferImplementation AbstractFramebuffer::drawBufferImplementation = &AbstractFramebuffer::drawBufferImplementationDefault; AbstractFramebuffer::ReadBufferImplementation AbstractFramebuffer::readBufferImplementation = &AbstractFramebuffer::readBufferImplementationDefault; AbstractFramebuffer::Target AbstractFramebuffer::readTarget = AbstractFramebuffer::Target::ReadDraw; AbstractFramebuffer::Target AbstractFramebuffer::drawTarget = AbstractFramebuffer::Target::ReadDraw; void AbstractFramebuffer::bind(Target target) { bindInternal(target); setViewportInternal(); } void AbstractFramebuffer::bindInternal(Target target) { Implementation::FramebufferState* state = Context::current()->state()->framebuffer; /* If already bound, done, otherwise update tracked state */ if(target == Target::Read) { if(state->readBinding == _id) return; state->readBinding = _id; } else if(target == Target::Draw) { if(state->drawBinding == _id) return; state->drawBinding = _id; } else if(target == Target::ReadDraw) { if(state->readBinding == _id && state->drawBinding == _id) return; state->readBinding = state->drawBinding = _id; } else CORRADE_ASSERT_UNREACHABLE(); glBindFramebuffer(static_cast(target), _id); } AbstractFramebuffer::Target AbstractFramebuffer::bindInternal() { Implementation::FramebufferState* state = Context::current()->state()->framebuffer; /* Return target to which the framebuffer is already bound */ if(state->readBinding == _id && state->drawBinding == _id) return Target::ReadDraw; if(state->readBinding == _id) return Target::Read; if(state->drawBinding == _id) return Target::Draw; /* Or bind it, if not already */ state->readBinding = _id; if(readTarget == Target::ReadDraw) state->drawBinding = _id; glBindFramebuffer(GLenum(readTarget), _id); return readTarget; } void AbstractFramebuffer::blit(AbstractFramebuffer& source, AbstractFramebuffer& destination, const Rectanglei& sourceRectangle, const Rectanglei& destinationRectangle, AbstractFramebuffer::BlitMask mask, AbstractFramebuffer::BlitFilter filter) { source.bindInternal(AbstractFramebuffer::Target::Read); destination.bindInternal(AbstractFramebuffer::Target::Draw); /** @todo Get some extension wrangler instead to avoid undeclared glBlitFramebuffer() on ES2 */ #ifndef MAGNUM_TARGET_GLES2 glBlitFramebuffer(sourceRectangle.left(), sourceRectangle.bottom(), sourceRectangle.right(), sourceRectangle.top(), destinationRectangle.left(), destinationRectangle.bottom(), destinationRectangle.right(), destinationRectangle.top(), static_cast(mask), static_cast(filter)); #else static_cast(sourceRectangle); static_cast(destinationRectangle); static_cast(mask); static_cast(filter); #endif } AbstractFramebuffer* AbstractFramebuffer::setViewport(const Rectanglei& rectangle) { _viewport = rectangle; /* Update the viewport if the framebuffer is currently bound */ if(Context::current()->state()->framebuffer->drawBinding == _id) setViewportInternal(); return this; } void AbstractFramebuffer::setViewportInternal() { Implementation::FramebufferState* state = Context::current()->state()->framebuffer; CORRADE_INTERNAL_ASSERT(state->drawBinding == _id); /* Already up-to-date, nothing to do */ if(state->viewport == _viewport) return; /* Update the state and viewport */ state->viewport = _viewport; glViewport(_viewport.left(), _viewport.bottom(), _viewport.width(), _viewport.height()); } void AbstractFramebuffer::clear(ClearMask mask) { bindInternal(drawTarget); glClear(static_cast(mask)); } void AbstractFramebuffer::read(const Vector2i& offset, const Vector2i& size, AbstractImage::Format format, AbstractImage::Type type, Image2D* image) { bindInternal(readTarget); const std::size_t dataSize = AbstractImage::pixelSize(format, type)*size.product(); char* const data = new char[dataSize]; readImplementation(offset, size, format, type, dataSize, data); image->setData(size, format, type, data); } #ifndef MAGNUM_TARGET_GLES2 void AbstractFramebuffer::read(const Vector2i& offset, const Vector2i& size, AbstractImage::Format format, AbstractImage::Type type, BufferImage2D* image, Buffer::Usage usage) { bindInternal(readTarget); /* If the buffer doesn't have sufficient size, resize it */ /** @todo Explicitly reset also when buffer usage changes */ if(image->size() != size || image->format() != format || image->type() != type) image->setData(size, format, type, nullptr, usage); image->buffer()->bind(Buffer::Target::PixelPack); /** @todo De-duplicate buffer size computation */ readImplementation(offset, size, format, type, AbstractImage::pixelSize(format, type)*size.product(), nullptr); } #endif void AbstractFramebuffer::invalidateImplementation(GLsizei count, GLenum* attachments) { /** @todo Re-enable when extension wrangler is available for ES2 */ #ifndef MAGNUM_TARGET_GLES2 glInvalidateFramebuffer(GLenum(bindInternal()), count, attachments); #else //glDiscardFramebufferEXT(GLenum(bindInternal()), count, attachments); static_cast(count); static_cast(attachments); #endif } void AbstractFramebuffer::invalidateImplementation(GLsizei count, GLenum* attachments, const Rectanglei& rectangle) { /** @todo Re-enable when extension wrangler is available for ES2 */ #ifndef MAGNUM_TARGET_GLES2 glInvalidateSubFramebuffer(GLenum(bindInternal()), count, attachments, rectangle.left(), rectangle.bottom(), rectangle.width(), rectangle.height()); #else //glDiscardSubFramebufferEXT(GLenum(bindInternal()), count, attachments, rectangle.left(), rectangle.bottom(), rectangle.width(), rectangle.height()); static_cast(count); static_cast(attachments); static_cast(rectangle); #endif } void AbstractFramebuffer::initializeContextBasedFunctionality(Context* context) { #ifndef MAGNUM_TARGET_GLES if(context->isExtensionSupported()) { Debug() << "AbstractFramebuffer: using" << Extensions::GL::EXT::framebuffer_blit::string() << "features"; readTarget = Target::Read; drawTarget = Target::Draw; } if(context->isExtensionSupported()) { Debug() << "AbstractFramebuffer: using" << Extensions::GL::EXT::direct_state_access::string() << "features"; drawBuffersImplementation = &AbstractFramebuffer::drawBuffersImplementationDSA; drawBufferImplementation = &AbstractFramebuffer::drawBufferImplementationDSA; readBufferImplementation = &AbstractFramebuffer::readBufferImplementationDSA; } #endif #ifndef MAGNUM_TARGET_GLES3 #ifndef MAGNUM_TARGET_GLES if(context->isExtensionSupported()) #else if(context->isExtensionSupported()) #endif { #ifndef MAGNUM_TARGET_GLES Debug() << "AbstractFramebuffer: using" << Extensions::GL::ARB::robustness::string() << "features"; #else //Debug() << "AbstractFramebuffer: using" << Extensions::GL::EXT::robustness::string() << "features"; #endif /** @todo Enable when extension wrangler for ES is available */ #ifndef MAGNUM_TARGET_GLES readImplementation = &AbstractFramebuffer::readImplementationRobustness; #endif } #else static_cast(context); #endif } void AbstractFramebuffer::drawBuffersImplementationDefault(GLsizei count, const GLenum* buffers) { /** @todo Re-enable when extension wrangler is available for ES2 */ #ifndef MAGNUM_TARGET_GLES2 bindInternal(drawTarget); glDrawBuffers(count, buffers); #else static_cast(count); static_cast(buffers); #endif } #ifndef MAGNUM_TARGET_GLES void AbstractFramebuffer::drawBuffersImplementationDSA(GLsizei count, const GLenum* buffers) { glFramebufferDrawBuffersEXT(_id, count, buffers); } #endif void AbstractFramebuffer::drawBufferImplementationDefault(GLenum buffer) { /** @todo Re-enable when extension wrangler is available for ES2 */ #ifndef MAGNUM_TARGET_GLES2 bindInternal(drawTarget); #ifndef MAGNUM_TARGET_GLES3 glDrawBuffer(buffer); #else glDrawBuffers(1, &buffer); #endif #else static_cast(buffer); #endif } #ifndef MAGNUM_TARGET_GLES void AbstractFramebuffer::drawBufferImplementationDSA(GLenum buffer) { glFramebufferDrawBufferEXT(_id, buffer); } #endif void AbstractFramebuffer::readBufferImplementationDefault(GLenum buffer) { /** @todo Get some extension wrangler instead to avoid undeclared glReadBuffer() on ES2 */ #ifndef MAGNUM_TARGET_GLES2 bindInternal(readTarget); glReadBuffer(buffer); #else static_cast(buffer); #endif } #ifndef MAGNUM_TARGET_GLES void AbstractFramebuffer::readBufferImplementationDSA(GLenum buffer) { glFramebufferReadBufferEXT(_id, buffer); } #endif void AbstractFramebuffer::readImplementationDefault(const Vector2i& offset, const Vector2i& size, const AbstractImage::Format format, const AbstractImage::Type type, const std::size_t, GLvoid* const data) { glReadPixels(offset.x(), offset.y(), size.x(), size.y(), static_cast(format), static_cast(type), data); } #ifndef MAGNUM_TARGET_GLES3 void AbstractFramebuffer::readImplementationRobustness(const Vector2i& offset, const Vector2i& size, const AbstractImage::Format format, const AbstractImage::Type type, const std::size_t dataSize, GLvoid* const data) { /** @todo Enable when extension wrangler for ES is available */ #ifndef MAGNUM_TARGET_GLES glReadnPixelsARB(offset.x(), offset.y(), size.x(), size.y(), static_cast(format), static_cast(type), dataSize, data); #else CORRADE_INTERNAL_ASSERT(false); //glReadnPixelsEXT(offset.x(), offset.y(), size.x(), size.y(), static_cast(format), static_cast(type), data); static_cast(offset); static_cast(size); static_cast(format); static_cast(type); static_cast(dataSize); static_cast(data); #endif } #endif }