BansheeEngine/Source/BansheeGLRenderAPI/BsGLTexture.cpp

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#include "BsGLTexture.h"
#include "BsGLSupport.h"
#include "BsGLPixelFormat.h"
#include "BsGLPixelBuffer.h"
#include "Error/BsException.h"
#include "Utility/BsBitwise.h"
#include "CoreThread/BsCoreThread.h"
#include "Managers/BsTextureManager.h"
#include "BsGLRenderTexture.h"
#include "BsGLTextureView.h"
#include "Profiling/BsRenderStats.h"
#include "BsGLCommandBuffer.h"

namespace bs { namespace ct
{
	GLTexture::GLTexture(GLSupport& support, const TEXTURE_DESC& desc, const SPtr<PixelData>& initialData, 
		GpuDeviceFlags deviceMask)
		: Texture(desc, initialData, deviceMask),
		mTextureID(0), mGLFormat(0), mInternalFormat(PF_UNKNOWN), mGLSupport(support)
	{
		assert((deviceMask == GDF_DEFAULT || deviceMask == GDF_PRIMARY) && "Multiple GPUs not supported natively on OpenGL.");
	}

	GLTexture::~GLTexture()
	{
		mSurfaceList.clear();
		glDeleteTextures(1, &mTextureID);
		BS_CHECK_GL_ERROR();

		clearBufferViews();

		BS_INC_RENDER_STAT_CAT(ResDestroyed, RenderStatObject_Texture);
	}

	void GLTexture::initialize()
	{
		UINT32 width = mProperties.getWidth();
		UINT32 height = mProperties.getHeight();
		UINT32 depth = mProperties.getDepth();
		TextureType texType = mProperties.getTextureType();
		int usage = mProperties.getUsage();
		UINT32 numMips = mProperties.getNumMipmaps();
		UINT32 numFaces = mProperties.getNumFaces();

		PixelFormat pixFormat = mProperties.getFormat();
		mInternalFormat = GLPixelUtil::getClosestSupportedPF(pixFormat, texType, usage);

		if (pixFormat != mInternalFormat)
		{
			LOGWRN(StringUtil::format("Provided pixel format is not supported by the driver: {0}. Falling back on: {1}.",
									  pixFormat, mInternalFormat));
		}

		// Check requested number of mipmaps
		UINT32 maxMips = PixelUtil::getMaxMipmaps(width, height, depth, mProperties.getFormat());
		if (numMips > maxMips)
		{
			LOGERR("Invalid number of mipmaps. Maximum allowed is: " + toString(maxMips));
			numMips = maxMips;
		}

		if ((usage & TU_DEPTHSTENCIL) != 0)
		{
			if (texType != TEX_TYPE_2D && texType != TEX_TYPE_CUBE_MAP)
			{
				LOGERR("Only 2D and cubemap depth stencil textures are supported. Ignoring depth-stencil flag.");
				usage &= ~TU_DEPTHSTENCIL;
			}
		}

		// Include the base mip level
		numMips += 1;

		// Generate texture handle
		glGenTextures(1, &mTextureID);
		BS_CHECK_GL_ERROR();

		// Set texture type
		glBindTexture(getGLTextureTarget(), mTextureID);
		BS_CHECK_GL_ERROR();

		if(mProperties.getNumSamples() <= 1)
		{
			// This needs to be set otherwise the texture doesn't get rendered
			glTexParameteri(getGLTextureTarget(), GL_TEXTURE_MAX_LEVEL, numMips - 1);
			BS_CHECK_GL_ERROR();
		}

		// Allocate internal buffer so that glTexSubImageXD can be used
		mGLFormat = GLPixelUtil::getGLInternalFormat(mInternalFormat, mProperties.isHardwareGammaEnabled());

		UINT32 sampleCount = mProperties.getNumSamples();
		if((usage & (TU_RENDERTARGET | TU_DEPTHSTENCIL)) != 0 && mProperties.getTextureType() == TEX_TYPE_2D && sampleCount > 1)
		{
			if (numFaces <= 1)
			{
				// Create immutable storage if available, fallback to mutable
#if BS_OPENGL_4_3 || BS_OPENGLES_3_1
				glTexStorage2DMultisample(GL_TEXTURE_2D_MULTISAMPLE, sampleCount, mGLFormat, width, height, GL_TRUE);
				BS_CHECK_GL_ERROR();
#else
				glTexImage2DMultisample(GL_TEXTURE_2D_MULTISAMPLE, sampleCount, mGLFormat, width, height, GL_TRUE);
				BS_CHECK_GL_ERROR();
#endif
			}
			else
			{
				// Create immutable storage if available, fallback to mutable
#if BS_OPENGL_4_3 || BS_OPENGLES_3_2
				glTexStorage3DMultisample(GL_TEXTURE_2D_MULTISAMPLE_ARRAY, sampleCount, mGLFormat, width, height, numFaces, GL_TRUE);
				BS_CHECK_GL_ERROR();
#else
				glTexImage3DMultisample(GL_TEXTURE_2D_MULTISAMPLE_ARRAY, sampleCount, mGLFormat, width, height, numFaces, GL_TRUE);
				BS_CHECK_GL_ERROR();
#endif
			}
		}
		else
		{
			// Create immutable storage if available, fallback to mutable
#if BS_OPENGL_4_2 || BS_OPENGLES_3_1
			switch (texType)
			{
			case TEX_TYPE_1D:
			{
				if (numFaces <= 1)
				{
					glTexStorage1D(GL_TEXTURE_1D, numMips, mGLFormat, width);
					BS_CHECK_GL_ERROR();
				}
				else
				{
					glTexStorage2D(GL_TEXTURE_1D_ARRAY, numMips, mGLFormat, width, numFaces);
					BS_CHECK_GL_ERROR();
				}
			}
				break;
			case TEX_TYPE_2D:
			{
				if (numFaces <= 1)
				{
					glTexStorage2D(GL_TEXTURE_2D, numMips, mGLFormat, width, height);
					BS_CHECK_GL_ERROR();
				}
				else
				{
					glTexStorage3D(GL_TEXTURE_2D_ARRAY, numMips, mGLFormat, width, height, numFaces);
					BS_CHECK_GL_ERROR();
				}
			}
				break;
			case TEX_TYPE_3D:
				glTexStorage3D(GL_TEXTURE_3D, numMips, mGLFormat, width, height, depth);
				BS_CHECK_GL_ERROR();
				break;
			case TEX_TYPE_CUBE_MAP:
			{
				if (numFaces <= 6)
				{
					glTexStorage2D(GL_TEXTURE_CUBE_MAP, numMips, mGLFormat, width, height);
					BS_CHECK_GL_ERROR();
				}
				else
				{
					glTexStorage3D(GL_TEXTURE_CUBE_MAP_ARRAY, numMips, mGLFormat, width, height, numFaces);
					BS_CHECK_GL_ERROR();
				}
			}
				break;
			}
#else
			if((usage & TU_DEPTHSTENCIL) != 0)
			{ 
				GLenum depthStencilType = GLPixelUtil::getDepthStencilTypeFromPF(mInternalFormat);
				GLenum depthStencilFormat = GLPixelUtil::getDepthStencilFormatFromPF(mInternalFormat);

				if(texType == TEX_TYPE_2D)
				{
					if (numFaces <= 1)
					{
						glTexImage2D(GL_TEXTURE_2D, 0, mGLFormat, width, height, 0,
							depthStencilFormat, depthStencilType, nullptr);
					}
					else
					{
						glTexImage3D(GL_TEXTURE_2D_ARRAY, 0, mGLFormat, width, height, numFaces, 0,
							depthStencilFormat, depthStencilType, nullptr);
					}
				}
				else if(texType == TEX_TYPE_CUBE_MAP)
				{
					if (numFaces <= 6)
					{
						for (UINT32 face = 0; face < 6; face++)
						{
							glTexImage2D(GL_TEXTURE_CUBE_MAP_POSITIVE_X + face, 0, mGLFormat,
								width, height, 0, depthStencilFormat, depthStencilType, nullptr);
						}
					}
					else
					{
						glTexImage3D(GL_TEXTURE_CUBE_MAP_ARRAY, 0, mGLFormat,
							width, height, numFaces, 0, depthStencilFormat, depthStencilType, nullptr);
					}
				}
				else
				{
					LOGERR("Unsupported texture type for depth-stencil attachment usage.");
				}
			}
			else
			{
				GLenum baseFormat = GLPixelUtil::getGLOriginFormat(mInternalFormat);
				GLenum baseDataType = GLPixelUtil::getGLOriginDataType(mInternalFormat);

				for (UINT32 mip = 0; mip <= numMips; mip++)
				{
					switch (texType)
					{
					case TEX_TYPE_1D:
					{
						if (numFaces <= 1)
							glTexImage1D(GL_TEXTURE_1D, mip, mGLFormat, width, 0, baseFormat, baseDataType, nullptr);
						else
							glTexImage2D(GL_TEXTURE_1D_ARRAY, mip, mGLFormat, width, numFaces, 0, baseFormat, baseDataType, nullptr);
					}
					break;
					case TEX_TYPE_2D:
					{
						if (numFaces <= 1)
							glTexImage2D(GL_TEXTURE_2D, mip, mGLFormat, width, height, 0, baseFormat, baseDataType, nullptr);
						else
							glTexImage3D(GL_TEXTURE_2D_ARRAY, mip, mGLFormat, width, height, numFaces, 0, baseFormat, baseDataType, nullptr);
					}
					break;
					case TEX_TYPE_3D:
						glTexImage3D(GL_TEXTURE_3D, mip, mGLFormat, width, height,
							depth, 0, baseFormat, baseDataType, nullptr);
						break;
					case TEX_TYPE_CUBE_MAP:
					{
						if (numFaces <= 6)
						{
							for (UINT32 face = 0; face < 6; face++)
							{
								glTexImage2D(GL_TEXTURE_CUBE_MAP_POSITIVE_X + face, mip, mGLFormat,
									width, height, 0, baseFormat, baseDataType, nullptr);
							}
						}
						else
						{
							glTexImage3D(GL_TEXTURE_CUBE_MAP_ARRAY, mip, mGLFormat,
								width, height, numFaces, 0, baseFormat, baseDataType, nullptr);
						}
					}
					break;
					}

					if(width > 1)
						width = width/2;

					if(height > 1)
						height = height/2;

					if(depth > 1)	
						depth = depth/2;
				}
			}
#endif
		}

		createSurfaceList();

		BS_INC_RENDER_STAT_CAT(ResCreated, RenderStatObject_Texture);
		Texture::initialize();
	}

	GLenum GLTexture::getGLTextureTarget() const
	{
		return getGLTextureTarget(mProperties.getTextureType(), mProperties.getNumSamples(), mProperties.getNumFaces());
	}

	GLuint GLTexture::getGLID() const
	{
		THROW_IF_NOT_CORE_THREAD;

		return mTextureID;
	}

	GLenum GLTexture::getGLTextureTarget(TextureType type, UINT32 numSamples, UINT32 numFaces)
	{
		switch (type)
		{
		case TEX_TYPE_1D:
			if (numFaces <= 1)
				return GL_TEXTURE_1D;
			else
				return GL_TEXTURE_1D_ARRAY;
		case TEX_TYPE_2D:
			if (numSamples > 1)
			{
				if (numFaces <= 1)
					return GL_TEXTURE_2D_MULTISAMPLE;
				else
					return GL_TEXTURE_2D_MULTISAMPLE_ARRAY;
			}
			else
			{
				if (numFaces <= 1)
					return GL_TEXTURE_2D;
				else
					return GL_TEXTURE_2D_ARRAY;
			}
		case TEX_TYPE_3D:
			return GL_TEXTURE_3D;
		case TEX_TYPE_CUBE_MAP:
			if (numFaces <= 6)
				return GL_TEXTURE_CUBE_MAP;
			else
				return GL_TEXTURE_CUBE_MAP_ARRAY;
		default:
			return 0;
		};
	}

	PixelData GLTexture::lockImpl(GpuLockOptions options, UINT32 mipLevel, UINT32 face, UINT32 deviceIdx,
									  UINT32 queueIdx)
	{
		if (mProperties.getNumSamples() > 1)
			BS_EXCEPT(InvalidStateException, "Multisampled textures cannot be accessed from the CPU directly.");

		if(mLockedBuffer != nullptr)
			BS_EXCEPT(InternalErrorException, "Trying to lock a buffer that's already locked.");

		UINT32 mipWidth = std::max(1u, mProperties.getWidth() >> mipLevel);
		UINT32 mipHeight = std::max(1u, mProperties.getHeight() >> mipLevel);
		UINT32 mipDepth = std::max(1u, mProperties.getDepth() >> mipLevel);

		PixelData lockedArea(mipWidth, mipHeight, mipDepth, mProperties.getFormat());

		mLockedBuffer = getBuffer(face, mipLevel);
		lockedArea.setExternalBuffer((UINT8*)mLockedBuffer->lock(options));

		return lockedArea;
	}

	void GLTexture::unlockImpl()
	{
		if (mLockedBuffer == nullptr)
		{
			LOGERR("Trying to unlock a buffer that's not locked.");
			return;
		}

		mLockedBuffer->unlock();
		mLockedBuffer = nullptr;
	}

	void GLTexture::readDataImpl(PixelData& dest, UINT32 mipLevel, UINT32 face, UINT32 deviceIdx, UINT32 queueIdx)
	{
		if (mProperties.getNumSamples() > 1)
		{
			LOGERR("Multisampled textures cannot be accessed from the CPU directly.");
			return;
		}

		if(dest.getFormat() != mInternalFormat)
		{
			PixelData temp(dest.getExtents(), mInternalFormat);
			temp.allocateInternalBuffer();

			getBuffer(face, mipLevel)->download(temp);
			PixelUtil::bulkPixelConversion(temp, dest);
		}
		else
			getBuffer(face, mipLevel)->download(dest);
	}

	void GLTexture::writeDataImpl(const PixelData& src, UINT32 mipLevel, UINT32 face, bool discardWholeBuffer,
								  UINT32 queueIdx)
	{
		if (mProperties.getNumSamples() > 1)
		{
			LOGERR("Multisampled textures cannot be accessed from the CPU directly.");
			return;
		}

		if (src.getFormat() != mInternalFormat)
		{
			PixelData temp(src.getExtents(), mInternalFormat);
			temp.allocateInternalBuffer();

			PixelUtil::bulkPixelConversion(src, temp);
			getBuffer(face, mipLevel)->upload(temp, temp.getExtents());
		}
		else
			getBuffer(face, mipLevel)->upload(src, src.getExtents());
	}

	void GLTexture::copyImpl(const SPtr<Texture>& target, const TEXTURE_COPY_DESC& desc, 
		const SPtr<CommandBuffer>& commandBuffer)
	{
		auto executeRef = [this](const SPtr<Texture>& target, const TEXTURE_COPY_DESC& desc)
		{
			GLTexture* destTex = static_cast<GLTexture*>(target.get());
			GLTextureBuffer* dest = static_cast<GLTextureBuffer*>(destTex->getBuffer(desc.dstFace, desc.dstMip).get());
			GLTextureBuffer* src = static_cast<GLTextureBuffer*>(getBuffer(desc.srcFace, desc.srcMip).get());

			bool copyEntireSurface = desc.srcVolume.getWidth() == 0 || 
				desc.srcVolume.getHeight() == 0 || 
				desc.srcVolume.getDepth() == 0;

			if(copyEntireSurface)
				dest->blitFromTexture(src);
			else
			{
				PixelVolume dstVolume;
				dstVolume.left = (UINT32)desc.dstPosition.x;
				dstVolume.top = (UINT32)desc.dstPosition.y;
				dstVolume.front = (UINT32)desc.dstPosition.z;
				dstVolume.right = dstVolume.left + desc.srcVolume.getWidth();
				dstVolume.bottom = dstVolume.top + desc.srcVolume.getHeight();
				dstVolume.back = dstVolume.front + desc.srcVolume.getDepth();

				dest->blitFromTexture(src, desc.srcVolume, dstVolume);
			}
		};

		if (commandBuffer == nullptr)
			executeRef(target, desc);
		else
		{
			auto execute = [=]() { executeRef(target, desc); };

			SPtr<GLCommandBuffer> cb = std::static_pointer_cast<GLCommandBuffer>(commandBuffer);
			cb->queueCommand(execute);
		}
	}

	void GLTexture::createSurfaceList()
	{
		mSurfaceList.clear();
		
		for (UINT32 face = 0; face < mProperties.getNumFaces(); face++)
		{
			for (UINT32 mip = 0; mip <= mProperties.getNumMipmaps(); mip++)
			{
				GLPixelBuffer *buf = bs_new<GLTextureBuffer>(getGLTextureTarget(), mTextureID, face, mip,
					static_cast<GpuBufferUsage>(mProperties.getUsage()), mInternalFormat, mProperties.getNumSamples());

				mSurfaceList.push_back(bs_shared_ptr<GLPixelBuffer>(buf));
				if(buf->getWidth() == 0 || buf->getHeight() == 0 || buf->getDepth() == 0)
				{
					BS_EXCEPT(RenderingAPIException,
						"Zero sized texture surface on texture face "
						+ toString(face) 
						+ " mipmap "+toString(mip)
						+ ". Probably, the GL driver refused to create the texture.");
				}
			}
		}
	}
	
	SPtr<GLPixelBuffer> GLTexture::getBuffer(UINT32 face, UINT32 mipmap)
	{
		THROW_IF_NOT_CORE_THREAD;

		if(face >= mProperties.getNumFaces())
			BS_EXCEPT(InvalidParametersException, "Face index out of range");

		if (mipmap > mProperties.getNumMipmaps())
			BS_EXCEPT(InvalidParametersException, "Mipmap index out of range");

		unsigned int idx = face * (mProperties.getNumMipmaps() + 1) + mipmap;
		assert(idx < mSurfaceList.size());
		return mSurfaceList[idx];
	}

	SPtr<TextureView> GLTexture::createView(const TEXTURE_VIEW_DESC& desc)
	{
		return bs_shared_ptr<GLTextureView>(new (bs_alloc<GLTextureView>()) GLTextureView(this, desc));
	}
}}