text: /*
  -----------------------------------------------------------------------------
  This source file is part of OGRE
      (Object-oriented Graphics Rendering Engine)
  For the latest info, see http://www.ogre3d.org/
  
  Copyright (c) 2000-2014 Torus Knot Software Ltd
  
  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 "OgreStableHeaders.h"
  
  #include "Compositor/Pass/PassUav/OgreCompositorPassUav.h"
  #include "Compositor/Pass/PassUav/OgreCompositorPassUavDef.h"
  #include "Compositor/OgreCompositorNodeDef.h"
  #include "Compositor/OgreCompositorNode.h"
  #include "Compositor/OgreCompositorManager2.h"
  #include "Compositor/OgreCompositorWorkspace.h"
  #include "Compositor/OgreCompositorWorkspaceListener.h"
  #include "Vao/OgreUavBufferPacked.h"
  
  #include "OgreRenderTexture.h"
  #include "OgreRenderSystem.h"
  #include "OgreTextureManager.h"
  #include "OgreHardwarePixelBuffer.h"
  
  namespace Ogre
  {
      void CompositorPassUavDef::setUav( uint32 slot, bool isExternal, const String &textureName,
                                         uint32 mrtIndex, ResourceAccess::ResourceAccess access,
                                         int32 mipmapLevel, PixelFormat pixelFormat )
      {
          IdString internalName;
          String externalName;
          if( isExternal )
              externalName = textureName;
          else
          {
              internalName = textureName;
  
              if( textureName.find( "global_" ) == 0 )
              {
                  mParentNodeDef->addTextureSourceName( textureName, 0,
                                                        TextureDefinitionBase::TEXTURE_GLOBAL );
              }
          }
  
          /// User is actually clearing out a slot.
          if( textureName.empty() )
              internalName = IdString();
  
          mTextureSources.push_back( TextureSource( slot, internalName, externalName, mrtIndex,
                                                    access, mipmapLevel, pixelFormat ) );
      }
      //-----------------------------------------------------------------------------------
      void CompositorPassUavDef::addUavBuffer( uint32 slotIdx, IdString bufferName,
                                               ResourceAccess::ResourceAccess access, size_t offset,
                                               size_t sizeBytes )
      {
          assert( access != ResourceAccess::Undefined );
          mBufferSources.push_back( BufferSource( slotIdx, bufferName, access, offset, sizeBytes ) );
      }
      //-----------------------------------------------------------------------------------
      //-----------------------------------------------------------------------------------
      CompositorPassUav::CompositorPassUav( const CompositorPassUavDef *definition,
                                            CompositorNode *parentNode,
                                            const CompositorChannel &target ) :
                  CompositorPass( definition, target, parentNode ),
                  mDefinition( definition )
      {
      }
      //-----------------------------------------------------------------------------------
      void CompositorPassUav::execute( const Camera *lodCamera )
      {
          //Execute a limited number of times?
          if( mNumPassesLeft != std::numeric_limits<uint32>::max() )
          {
              if( !mNumPassesLeft )
                  return;
              --mNumPassesLeft;
          }
  
          //Call beginUpdate if we're the first to use this RT
          if( mDefinition->mBeginRtUpdate )
              mTarget->_beginUpdate();
  
          //Fire the listener in case it wants to change anything
          CompositorWorkspaceListener *listener = mParentNode->getWorkspace()->getListener();
          if( listener )
              listener->passPreExecute( this );
  
          //Do not execute resource transitions. This pass shouldn't have them.
          //The transitions are made when the bindings are needed
          //(<sarcasm>we'll have fun with the validation layers later</sarcasm>).
          //executeResourceTransitions();
          assert( mResourceTransitions.empty() );
  
          RenderSystem *renderSystem = mParentNode->getRenderSystem();
  
          if( mDefinition->mStartingSlot != std::numeric_limits<uint8>::max() )
              renderSystem->setUavStartingSlot( mDefinition->mStartingSlot );
  
          if( !mDefinition->mKeepPreviousUavs )
              renderSystem->clearUAVs();
  
          {
              const CompositorPassUavDef::TextureSources &textureSources =
                      mDefinition->getTextureSources();
              CompositorPassUavDef::TextureSources::const_iterator itor = textureSources.begin();
              CompositorPassUavDef::TextureSources::const_iterator end  = textureSources.end();
              while( itor != end )
              {
                  TexturePtr texture;
  
                  if( itor->externalTextureName.empty() )
                  {
                      texture = mParentNode->getDefinedTexture( itor->textureName, itor->mrtIndex );
                  }
                  else if( itor->textureName != IdString() )
                  {
                      texture = TextureManager::getSingleton().getByName(
                                  itor->externalTextureName,
                                  ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
  
                      if( texture.isNull() )
                      {
                          OGRE_EXCEPT( Exception::ERR_ITEM_NOT_FOUND,
                                       "Texture with name: " + itor->externalTextureName +
                                       " does not exist. The texture must exist by the time the "
                                       "workspace is executed. Are you trying to use a texture "
                                       "defined by the compositor? If so you need to set it via "
                                       "'uav' instead of 'uav_external'", "CompositorPassUav::execute" );
                      }
                  }
  
                  renderSystem->queueBindUAV( itor->uavSlot, texture, itor->access,
                                              itor->mipmapLevel, 0, itor->pixelFormat );
  
                  ++itor;
              }
          }
  
          {
              const CompositorPassUavDef::BufferSourceVec &bufferSources = mDefinition->getBufferSources();
              CompositorPassUavDef::BufferSourceVec::const_iterator itor = bufferSources.begin();
              CompositorPassUavDef::BufferSourceVec::const_iterator end  = bufferSources.end();
              while( itor != end )
              {
                  UavBufferPacked *uavBuffer = 0;
  
                  if( itor->bufferName != IdString() )
                      uavBuffer = mParentNode->getDefinedBuffer( itor->bufferName );
  
                  renderSystem->queueBindUAV( itor->uavSlot, uavBuffer, itor->access,
                                              itor->offset, itor->sizeBytes );
  
                  ++itor;
              }
          }
  
          if( listener )
              listener->passPosExecute( this );
  
          //Call endUpdate if we're the last pass in a row to use this RT
          if( mDefinition->mEndRtUpdate )
              mTarget->_endUpdate();
      }
      //-----------------------------------------------------------------------------------
      void CompositorPassUav::_placeBarriersAndEmulateUavExecution(
                                              BoundUav boundUavs[64], ResourceAccessMap &uavsAccess,
                                              ResourceLayoutMap &resourcesLayout )
      {
          {
              const CompositorPassUavDef::TextureSources &textureSources =
                      mDefinition->getTextureSources();
              CompositorPassUavDef::TextureSources::const_iterator itor = textureSources.begin();
              CompositorPassUavDef::TextureSources::const_iterator end  = textureSources.end();
              while( itor != end )
              {
                  TexturePtr texture;
  
                  if( itor->externalTextureName.empty() )
                  {
                      texture = mParentNode->getDefinedTexture( itor->textureName, itor->mrtIndex );
                  }
                  else if( itor->textureName != IdString() )
                  {
                      texture = TextureManager::getSingleton().getByName(
                                  itor->externalTextureName,
                                  ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
  
                      if( texture.isNull() )
                      {
                          OGRE_EXCEPT( Exception::ERR_ITEM_NOT_FOUND,
                                       "Texture with name: " + itor->externalTextureName +
                                       " does not exist. The texture must exist by the time the workspace"
                                       " is executed. Are you trying to use a texture defined by the "
                                       "compositor? If so you need to set it via 'uav' instead of "
                                       "'uav_external'",
                                       "CompositorPassUav::_placeBarriersAndEmulateUavExecution" );
                      }
                  }
  
                  if( !(texture->getUsage() & TU_UAV) )
                  {
                      OGRE_EXCEPT( Exception::ERR_INVALIDPARAMS,
                                   "Texture " + texture->getName() +
                                   " must have been created with TU_UAV to be bound as UAV",
                                   "CompositorPassUav::_placeBarriersAndEmulateUavExecution" );
                  }
  
                  //Only "simulate the bind" of UAVs. We will evaluate the actual resource
                  //transition when the UAV is actually used in the subsequent passes.
                  boundUavs[itor->uavSlot].rttOrBuffer = texture->getBuffer()->getRenderTarget();
                  boundUavs[itor->uavSlot].boundAccess = itor->access;
  
                  ++itor;
              }
          }
  
          {
              const CompositorPassUavDef::BufferSourceVec &bufferSources = mDefinition->getBufferSources();
              CompositorPassUavDef::BufferSourceVec::const_iterator itor = bufferSources.begin();
              CompositorPassUavDef::BufferSourceVec::const_iterator end  = bufferSources.end();
              while( itor != end )
              {
                  UavBufferPacked *uavBuffer = 0;
  
                  if( itor->bufferName != IdString() )
                      uavBuffer = mParentNode->getDefinedBuffer( itor->bufferName );
  
                  //Only "simulate the bind" of UAVs. We will evaluate the actual resource
                  //transition when the UAV is actually used in the subsequent passes.
                  boundUavs[itor->uavSlot].rttOrBuffer = uavBuffer;
                  boundUavs[itor->uavSlot].boundAccess = itor->access;
  
                  ++itor;
              }
          }
  
          //Do not use base class functionality at all.
          //CompositorPass::_placeBarriersAndEmulateUavExecution();
      }
  }
  