Engine directory for ticket #1

Engine/source/renderInstance/renderTexTargetBinManager.h

@@ -0,0 +1,135 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// 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.
+//-----------------------------------------------------------------------------
+#ifndef _TEXTARGETBIN_MGR_H_
+#define _TEXTARGETBIN_MGR_H_
+
+#ifndef _RENDERBINMANAGER_H_
+#include "renderInstance/renderBinManager.h"
+#endif
+#ifndef _MATTEXTURETARGET_H_
+#include "materials/matTextureTarget.h"
+#endif
+
+class ConditionerFeature;
+
+
+class RenderTexTargetBinManager : public RenderBinManager
+{
+   typedef RenderBinManager Parent;
+
+public:
+   static const GFXFormat DefaultTargetFormat = GFXFormatR8G8B8A8;
+   static const U32 DefaultTargetChainLength = 1;
+   static const U32 DefaultTargetSize = 256;
+
+   enum TargetSizeType
+   {
+      WindowSize = 0,
+      WindowSizeScaled,
+      FixedSize
+   };
+
+public:
+
+   RenderTexTargetBinManager( const RenderInstType &ritype = RenderPassManager::RIT_Mesh,
+                              F32 renderOrder = 1.0f,
+                              F32 processAddOrder = 1.0f,
+                              const GFXFormat targetFormat = DefaultTargetFormat, 
+                              const Point2I &targetSize = Point2I(DefaultTargetSize, DefaultTargetSize),
+                              const U32 targetChainLength = DefaultTargetChainLength);
+
+   virtual ~RenderTexTargetBinManager();
+
+   virtual bool setTargetSize(const Point2I &newTargetSize);
+
+   virtual GFXTextureObject* getTargetTexture( U32 mrtIndex, S32 chainIndex = -1 ) const;
+
+   /// Force a target update
+   virtual bool updateTargets() { return _updateTargets(); }
+
+   void setTargetFormatConsole(const S32 &fmt) { setTargetFormat(GFXFormat(fmt)); }
+   virtual bool setTargetFormat(const GFXFormat &newTargetFormat);
+
+   S32 getTargetFormatConsole() { return getTargetFormat(); }
+   virtual const GFXFormat &getTargetFormat() const { return mTargetFormat; }
+
+   virtual void setTargetChainLength(const U32 chainLength);
+   virtual U32 getTargetChainLength() const { return mTargetChainLength; }
+
+   DECLARE_CONOBJECT(RenderTexTargetBinManager);
+   static void initPersistFields();
+   virtual bool onAdd();
+
+protected:
+
+   NamedTexTarget mNamedTarget;
+
+   GFXFormat mTargetFormat;
+   Point2I mTargetSize;
+   Point2F mTargetScale;
+   
+   //RectI mTargetViewport;
+   TargetSizeType mTargetSizeType;
+
+   U32 mTargetChainLength;
+   U32 mTargetChainIdx;
+   U32 mNumRenderTargets;
+   GFXTextureTargetRef *mTargetChain;
+   GFXTexHandle **mTargetChainTextures;
+
+#ifndef TORQUE_SHIPPING
+   bool m_NeedsOnPostRender;
+#endif
+   bool mPreserve;
+
+   virtual bool _handleGFXEvent(GFXDevice::GFXDeviceEventType event);
+   virtual GFXTextureTargetRef _getTextureTarget(const U32 idx = 0);
+
+   /// Pushes the active render target, and sets itself as a render target. The
+   /// target is then cleared using 'mTargetClearColor', viewport is set properly,
+   /// and true is returned, and '_onPostRender' must be called after rendering
+   /// is complete. If the return value is false, than '_onPostRender'
+   /// should not be called. 
+   ///
+   /// @param preserve  If set to true, the contents of the current render target 
+   //                   will be the same when _onPostRender is called. Otherwise
+   //                   the contents are undefined on console platforms.
+   virtual bool _onPreRender(SceneRenderState * state, bool preserve = false);
+
+   /// Resolves the active render target, pops the render target from _onPreRender, and sets debug info. 
+   virtual void _onPostRender();
+
+   virtual bool _updateTargets();
+
+   virtual bool _setupTargets();
+
+   virtual void _teardownTargets();
+
+   /// The callback used to get texture events.
+   /// @see GFXTextureManager::addEventDelegate
+   void _onTextureEvent( GFXTexCallbackCode code );
+};
+
+typedef RenderTexTargetBinManager::TargetSizeType RenderTexTargetSize;
+DefineEnumType( RenderTexTargetSize );
+
+#endif // _TEXTARGETBIN_MGR_H_