shattered_ogrerb 0.5.0.1

data/vendor/ogrerb/src_headers/OGRE/OgreCompositionPass.h

@@ -0,0 +1,271 @@
+/*
+-----------------------------------------------------------------------------
+This source file is part of OGRE
+    (Object-oriented Graphics Rendering Engine)
+For the latest info, see http://www.ogre3d.org/
+
+Copyright (c) 2000-2006 Torus Knot Software Ltd
+Also see acknowledgements in Readme.html
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA 02111-1307, USA, or go to
+http://www.gnu.org/copyleft/lesser.txt.
+
+You may alternatively use this source under the terms of a specific version of
+the OGRE Unrestricted License provided you have obtained such a license from
+Torus Knot Software Ltd.
+-----------------------------------------------------------------------------
+*/
+#ifndef __CompositionPass_H__
+#define __CompositionPass_H__
+
+#include "OgrePrerequisites.h"
+#include "OgreMaterial.h"
+#include "OgreRenderSystem.h"
+#include "OgreRenderQueue.h"
+
+namespace Ogre {
+	/** Object representing one pass or operation in a composition sequence. This provides a 
+		method to conviently interleave RenderSystem commands between Render Queues.
+	 */
+    class _OgreExport CompositionPass
+    {
+    public:
+        CompositionPass(CompositionTargetPass *parent);
+        ~CompositionPass();
+        
+        /** Enumeration that enumerates the various composition pass types.
+        */
+        enum PassType
+        {
+            PT_CLEAR,           // Clear target to one colour
+			PT_STENCIL,			// Set stencil operation
+            PT_RENDERSCENE,     // Render the scene or part of it
+            PT_RENDERQUAD       // Render a full screen quad
+        };
+        
+        /** Set the type of composition pass */
+        void setType(PassType type);
+        /** Get the type of composition pass */
+        PassType getType() const;
+        
+		/** Set an identifier for this pass. This identifier can be used to
+			"listen in" on this pass with an CompositorInstance::Listener. 
+		*/
+		void setIdentifier(uint32 id);
+		/** Get the identifier for this pass */
+		uint32 getIdentifier() const;
+
+        /** Set the material used by this pass
+			@note applies when PassType is RENDERQUAD 
+		*/
+        void setMaterial(const MaterialPtr& mat);
+        /** Set the material used by this pass 
+			@note applies when PassType is RENDERQUAD 
+		*/
+        void setMaterialName(const String &name);
+        /** Get the material used by this pass 
+			@note applies when PassType is RENDERQUAD 
+		*/
+        const MaterialPtr& getMaterial() const;
+		/** Set the first render queue to be rendered in this pass (inclusive) 
+			@note applies when PassType is RENDERSCENE
+		*/
+        void setFirstRenderQueue(uint8 id);
+		/** Get the first render queue to be rendered in this pass (inclusive) 
+			@note applies when PassType is RENDERSCENE
+		*/
+		uint8 getFirstRenderQueue();
+		/** Set the last render queue to be rendered in this pass (inclusive) 
+			@note applies when PassType is RENDERSCENE
+		*/
+        void setLastRenderQueue(uint8 id);
+		/** Get the last render queue to be rendered in this pass (inclusive) 
+			@note applies when PassType is RENDERSCENE
+		*/
+		uint8 getLastRenderQueue();
+
+		/** Would be nice to have for RENDERSCENE:
+			flags to:
+				exclude transparents
+				override material (at least -- color)
+		*/
+
+        /** Set the viewport clear buffers  (defaults to FBT_COLOUR|FBT_DEPTH)
+            @param val is a combination of FBT_COLOUR, FBT_DEPTH, FBT_STENCIL.
+			@note applies when PassType is CLEAR
+        */
+        void setClearBuffers(uint32 val);
+        /** Get the viewport clear buffers.
+			@note applies when PassType is CLEAR
+        */
+        uint32 getClearBuffers();
+        /** Set the viewport clear colour (defaults to 0,0,0,0) 
+			@note applies when PassType is CLEAR
+		 */
+        void setClearColour(ColourValue val);
+        /** Get the viewport clear colour (defaults to 0,0,0,0)	
+			@note applies when PassType is CLEAR
+		 */
+        const ColourValue &getClearColour();
+        /** Set the viewport clear depth (defaults to 1.0) 
+			@note applies when PassType is CLEAR
+		*/
+        void setClearDepth(Real depth);
+        /** Get the viewport clear depth (defaults to 1.0) 
+			@note applies when PassType is CLEAR
+		*/
+        Real getClearDepth();
+		/** Set the viewport clear stencil value (defaults to 0) 
+			@note applies when PassType is CLEAR
+		*/
+        void setClearStencil(uint32 value);
+        /** Get the viewport clear stencil value (defaults to 0) 
+			@note applies when PassType is CLEAR
+		*/
+        uint32 getClearStencil();
+
+		/** Set stencil check on or off.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilCheck(bool value);
+		/** Get stencil check enable.
+			@note applies when PassType is STENCIL
+		*/
+		bool getStencilCheck();
+		/** Set stencil compare function.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilFunc(CompareFunction value); 
+		/** Get stencil compare function.
+			@note applies when PassType is STENCIL
+		*/
+		CompareFunction getStencilFunc(); 
+		/** Set stencil reference value.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilRefValue(uint32 value);
+		/** Get stencil reference value.
+			@note applies when PassType is STENCIL
+		*/
+		uint32 getStencilRefValue();
+		/** Set stencil mask.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilMask(uint32 value);
+		/** Get stencil mask.
+			@note applies when PassType is STENCIL
+		*/
+		uint32 getStencilMask();
+		/** Set stencil fail operation.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilFailOp(StencilOperation value);
+		/** Get stencil fail operation.
+			@note applies when PassType is STENCIL
+		*/
+		StencilOperation getStencilFailOp();
+		/** Set stencil depth fail operation.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilDepthFailOp(StencilOperation value);
+		/** Get stencil depth fail operation.
+			@note applies when PassType is STENCIL
+		*/
+		StencilOperation getStencilDepthFailOp();
+		/** Set stencil pass operation.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilPassOp(StencilOperation value);
+		/** Get stencil pass operation.
+			@note applies when PassType is STENCIL
+		*/
+		StencilOperation getStencilPassOp();
+		/** Set two sided stencil operation.
+			@note applies when PassType is STENCIL
+		*/
+		void setStencilTwoSidedOperation(bool value);
+		/** Get two sided stencil operation.
+			@note applies when PassType is STENCIL
+		*/
+		bool getStencilTwoSidedOperation();
+
+        /** Set an input local texture. An empty string clears the input.
+            @param id    Input to set. Must be in 0..OGRE_MAX_TEXTURE_LAYERS-1
+            @param input Which texture to bind to this input. An empty string clears the input.
+			@note applies when PassType is RENDERQUAD 
+        */
+        void setInput(size_t id, const String &input="");
+        
+        /** Get the value of an input.
+            @param id    Input to get. Must be in 0..OGRE_MAX_TEXTURE_LAYERS-1.
+			@note applies when PassType is RENDERQUAD 
+        */
+        const String &getInput(size_t id);
+        
+        /** Get the number of inputs used.
+			@note applies when PassType is RENDERQUAD 
+        */
+        size_t getNumInputs();
+        
+        /** Clear all inputs.
+			@note applies when PassType is RENDERQUAD 
+        */
+        void clearAllInputs();
+        
+        /** Get parent object 
+			@note applies when PassType is RENDERQUAD 
+		*/
+        CompositionTargetPass *getParent();
+
+        /** Determine if this target pass is supported on the current rendering device. 
+         */
+        bool _isSupported(void);
+
+    private:
+        /// Parent technique
+        CompositionTargetPass *mParent;
+        /// Type of composition pass
+        PassType mType;
+		/// Identifier for this pass
+		uint32 mIdentifier;
+        /// Material used for rendering
+        MaterialPtr mMaterial;
+        /// [first,last] render queue to render this pass (in case of PT_RENDERSCENE)
+		uint8 mFirstRenderQueue;
+		uint8 mLastRenderQueue;
+        /// Clear buffers (in case of PT_CLEAR)
+        uint32 mClearBuffers;
+        /// Clear colour (in case of PT_CLEAR)
+        ColourValue mClearColour;
+		/// Clear depth (in case of PT_CLEAR)
+		Real mClearDepth;
+		/// Clear stencil value (in case of PT_CLEAR)
+		uint32 mClearStencil;
+        /// Inputs (for material used for rendering the quad)
+        /// An empty string signifies that no input is used
+        String mInputs[OGRE_MAX_TEXTURE_LAYERS];
+		/// Stencil operation parameters
+		bool mStencilCheck;
+		CompareFunction mStencilFunc; 
+		uint32 mStencilRefValue;
+		uint32 mStencilMask;
+		StencilOperation mStencilFailOp;
+		StencilOperation mStencilDepthFailOp;
+		StencilOperation mStencilPassOp;
+		bool mStencilTwoSidedOperation;
+    };
+
+}
+
+#endif

data/vendor/ogrerb/src_headers/OGRE/OgreCompositionTargetPass.h

@@ -0,0 +1,153 @@
+/*
+-----------------------------------------------------------------------------
+This source file is part of OGRE
+    (Object-oriented Graphics Rendering Engine)
+For the latest info, see http://www.ogre3d.org/
+
+Copyright (c) 2000-2006 Torus Knot Software Ltd
+Also see acknowledgements in Readme.html
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA 02111-1307, USA, or go to
+http://www.gnu.org/copyleft/lesser.txt.
+
+You may alternatively use this source under the terms of a specific version of
+the OGRE Unrestricted License provided you have obtained such a license from
+Torus Knot Software Ltd.
+-----------------------------------------------------------------------------
+*/
+#ifndef __CompositionTargetPass_H__
+#define __CompositionTargetPass_H__
+
+#include "OgrePrerequisites.h"
+#include "OgreIteratorWrappers.h"
+
+namespace Ogre {
+	/** Object representing one render to a RenderTarget or Viewport in the Ogre Composition
+		framework.
+	 */
+    class _OgreExport CompositionTargetPass
+    {
+    public:
+        CompositionTargetPass(CompositionTechnique *parent);
+        ~CompositionTargetPass();
+        
+        /** Input mode of a TargetPass
+        */
+        enum InputMode
+        {
+            IM_NONE,        // No input
+            IM_PREVIOUS     // Output of previous Composition in chain
+        };
+        typedef std::vector<CompositionPass *> Passes;
+        typedef VectorIterator<Passes> PassIterator;
+        
+        /** Set input mode of this TargetPass
+        */
+        void setInputMode(InputMode mode);
+        /** Get input mode */
+        InputMode getInputMode() const;
+        
+        /** Set output local texture name */
+        void setOutputName(const String &out);
+        /** Get output local texture name */
+        const String &getOutputName() const;
+        
+        /** Set "only initial" flag. This makes that this target pass is only executed initially 
+            after the effect has been enabled.
+        */
+        void setOnlyInitial(bool value);
+        /** Get "only initial" flag.
+        */
+        bool getOnlyInitial();
+        
+        /** Set the scene visiblity mask used by this pass 
+        */
+        void setVisibilityMask(uint32 mask);
+        /** Get the scene visiblity mask used by this pass 
+        */
+        uint32 getVisibilityMask();
+
+		/** Set the material scheme used by this target pass.
+		@remarks
+			Only applicable to targets that render the scene as
+			one of their passes.
+			@see Technique::setScheme.
+		*/
+		void setMaterialScheme(const String& schemeName);
+		/** Get the material scheme used by this target pass.
+		@remarks
+			Only applicable to targets that render the scene as
+			one of their passes.
+			@see Technique::setScheme.
+		*/
+		const String& getMaterialScheme(void) const;
+        
+        /** Set the scene LOD bias used by this pass. The default is 1.0,
+            everything below that means lower quality, higher means higher quality.
+        */
+        void setLodBias(float bias);
+        /** Get the scene LOD bias used by this pass 
+        */
+        float getLodBias();
+        
+        /** Create a new pass, and return a pointer to it.
+        */
+        CompositionPass *createPass();
+        /** Remove a pass. It will also be destroyed.
+        */
+        void removePass(size_t idx);
+        /** Get a pass.
+        */
+        CompositionPass *getPass(size_t idx);
+        /** Get the number of passes.
+        */
+        size_t getNumPasses();
+        
+        /** Remove all passes
+        */
+        void removeAllPasses();
+    
+        /** Get an iterator over the Passes in this TargetPass. */
+        PassIterator getPassIterator(void);
+        
+        /** Get parent object */
+        CompositionTechnique *getParent();
+
+        /** Determine if this target pass is supported on the current rendering device. 
+         */
+        bool _isSupported(void);
+
+    private:
+        /// Parent technique
+        CompositionTechnique *mParent;
+        /// Input name
+        InputMode mInputMode;
+        /// (local) output texture
+        String mOutputName;
+        /// Passes
+        Passes mPasses;
+        /// This target pass is only executed initially after the effect
+        /// has been enabled.
+        bool mOnlyInitial;
+        /// Visibility mask for this render
+        uint32 mVisibilityMask;
+        /// LOD bias of this render
+        float mLodBias;
+		/// Material scheme name
+		String mMaterialScheme;
+    };
+
+}
+
+#endif

data/vendor/ogrerb/src_headers/OGRE/OgreCompositionTechnique.h

@@ -0,0 +1,146 @@
+/*
+-----------------------------------------------------------------------------
+This source file is part of OGRE
+    (Object-oriented Graphics Rendering Engine)
+For the latest info, see http://www.ogre3d.org/
+
+Copyright (c) 2000-2006 Torus Knot Software Ltd
+Also see acknowledgements in Readme.html
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA 02111-1307, USA, or go to
+http://www.gnu.org/copyleft/lesser.txt.
+
+You may alternatively use this source under the terms of a specific version of
+the OGRE Unrestricted License provided you have obtained such a license from
+Torus Knot Software Ltd.
+-----------------------------------------------------------------------------
+*/
+#ifndef __CompositionTechnique_H__
+#define __CompositionTechnique_H__
+
+#include "OgrePrerequisites.h"
+#include "OgrePixelFormat.h"
+#include "OgreIteratorWrappers.h"
+
+namespace Ogre {
+    /** Base composition technique, can be subclassed in plugins.
+     */
+    class _OgreExport CompositionTechnique
+    {
+    public:
+        CompositionTechnique(Compositor *parent);
+        virtual ~CompositionTechnique();
+    
+        /// Local texture definition
+        class TextureDefinition
+        {
+        public:
+            String name;
+            size_t width;       // 0 means adapt to target width
+            size_t height;      // 0 means adapt to target height
+            PixelFormat format;
+
+			TextureDefinition() :width(0), height(0), format(PF_R8G8B8A8){}
+        };
+        /// Typedefs for several iterators
+        typedef std::vector<CompositionTargetPass *> TargetPasses;
+        typedef VectorIterator<TargetPasses> TargetPassIterator;
+        typedef std::vector<TextureDefinition*> TextureDefinitions;
+        typedef VectorIterator<TextureDefinitions> TextureDefinitionIterator;
+        
+        /** Create a new local texture definition, and return a pointer to it.
+            @param name     Name of the local texture
+        */
+        TextureDefinition *createTextureDefinition(const String &name);
+        
+        /** Remove and destroy a local texture definition.
+        */
+        void removeTextureDefinition(size_t idx);
+        
+        /** Get a local texture definition.
+        */
+        TextureDefinition *getTextureDefinition(size_t idx);
+        
+        /** Get the number of local texture definitions.
+        */
+        size_t getNumTextureDefinitions();
+        
+        /** Remove all Texture Definitions
+        */
+        void removeAllTextureDefinitions();
+        
+        /** Get an iterator over the TextureDefinitions in this Technique. */
+        TextureDefinitionIterator getTextureDefinitionIterator(void);
+        
+        /** Create a new target pass, and return a pointer to it.
+        */
+        CompositionTargetPass *createTargetPass();
+        
+        /** Remove a target pass. It will also be destroyed.
+        */
+        void removeTargetPass(size_t idx);
+        
+        /** Get a target pass.
+        */
+        CompositionTargetPass *getTargetPass(size_t idx);
+        
+        /** Get the number of target passes.
+        */
+        size_t getNumTargetPasses();
+        
+        /** Remove all target passes.
+        */
+        void removeAllTargetPasses();
+        
+        /** Get an iterator over the TargetPasses in this Technique. */
+        TargetPassIterator getTargetPassIterator(void);
+        
+        /** Get output (final) target pass
+         */
+        CompositionTargetPass *getOutputTargetPass();
+        
+        /** Determine if this technique is supported on the current rendering device. 
+		@param allowTextureDegradation True to accept a reduction in texture depth
+         */
+        virtual bool isSupported(bool allowTextureDegradation);
+        
+        /** Create an instance of this technique.
+         */
+        virtual CompositorInstance *createInstance(CompositorChain *chain);
+        
+        /** Destroy an instance of this technique.
+         */
+        virtual void destroyInstance(CompositorInstance *instance);
+        
+        /** Get parent object */
+        Compositor *getParent();
+    private:
+        /// Parent compositor
+        Compositor *mParent;
+        /// Local texture definitions
+        TextureDefinitions mTextureDefinitions;
+        
+        /// Intermediate target passes
+        TargetPasses mTargetPasses;
+        /// Output target pass (can be only one)
+        CompositionTargetPass *mOutputTarget;    
+
+		/// List of instances
+		typedef std::vector<CompositorInstance *> Instances;
+		Instances mInstances;
+    };
+
+}
+
+#endif