OgreGLRenderSystem.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
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.
-----------------------------------------------------------------------------
*/
#ifndef __GLRenderSystem_H__
#define __GLRenderSystem_H__

#include "OgreGLPrerequisites.h"
#include "OgrePlatform.h"
#include "OgreRenderSystem.h"
#include "OgreGLHardwareBufferManager.h"
#include "OgreGLGpuProgramManager.h"
#include "OgreVector4.h"


namespace Ogre {


    namespace GLSL {
        class GLSLProgramFactory;
    }

    class GLStateCacheManager;

    class _OgreGLExport GLRenderSystem : public RenderSystem
    {
    private:
        bool mStopRendering;

        #define MAX_LIGHTS 8
        Light* mLights[MAX_LIGHTS];

        Matrix4 mViewMatrix;
        Matrix4 mWorldMatrix;
        Matrix4 mTextureMatrix;

        FilterOptions mMinFilter;
        FilterOptions mMipFilter;

        size_t mTextureCoordIndex[OGRE_MAX_TEXTURE_LAYERS];

        GLenum mTextureTypes[OGRE_MAX_TEXTURE_LAYERS];

        unsigned short mFixedFunctionTextureUnits;

        void initConfigOptions(void);
        void initInputDevices(void);
        void processInputDevices(void);

        void setGLLight(size_t index, Light* lt);
        void makeGLMatrix(GLfloat gl_matrix[16], const Matrix4& m);
 
        GLint getBlendMode(SceneBlendFactor ogreBlend) const;
        GLint getTextureAddressingMode(TextureUnitState::TextureAddressingMode tam) const;
                void initialiseContext(RenderWindow* primary);

        void setLights();

        bool mDepthWrite;
        uint32 mStencilWriteMask;
        bool mColourWrite[4];

        int mScissorBox[4];

        GLint convertCompareFunction(CompareFunction func) const;
        GLint convertStencilOp(StencilOperation op, bool invert = false) const;

        GLfloat _getCurrentAnisotropy(size_t unit);
        
        GLSupport* mGLSupport;
        
        void setGLLightPositionDirection(Light* lt, GLenum lightindex);

        bool mUseAutoTextureMatrix;
        GLfloat mAutoTextureMatrix[16];

        bool mGLInitialised;

        HardwareBufferManager* mHardwareBufferManager;
        GLGpuProgramManager* mGpuProgramManager;
        GLSL::GLSLProgramFactory* mGLSLProgramFactory;

        unsigned short mCurrentLights;

        GLuint getCombinedMinMipFilter(void) const;

        GLGpuProgram* mCurrentVertexProgram;
        GLGpuProgram* mCurrentFragmentProgram;
        GLGpuProgram* mCurrentGeometryProgram;

        /* The main GL context - main thread only */
        GLContext *mMainContext;
        /* The current GL context  - main thread only */
        GLContext *mCurrentContext;
        typedef list<GLContext*>::type GLContextList;
        GLContextList mBackgroundContextList;

        GLStateCacheManager* mStateCacheManager;

        GLRTTManager *mRTTManager;

        ushort mActiveTextureUnit;

        // local data members of _render that were moved here to improve performance
        // (save allocations)
        vector<GLuint>::type mRenderAttribsBound;
        vector<GLuint>::type mRenderInstanceAttribsBound;


    protected:
        void setClipPlanesImpl(const PlaneList& clipPlanes);
        void bindVertexElementToGpu( const VertexElement &elem, HardwareVertexBufferSharedPtr vertexBuffer,
                const size_t vertexStart, 
                vector<GLuint>::type &attribsBound, vector<GLuint>::type &instanceAttribsBound );
    public:
        // Default constructor / destructor
        GLRenderSystem();
        ~GLRenderSystem();

        // ----------------------------------
        // Overridden RenderSystem functions
        // ----------------------------------
        const String& getName(void) const;
        ConfigOptionMap& getConfigOptions(void);
        void setConfigOption(const String &name, const String &value);
        String validateConfigOptions(void);
        RenderWindow* _initialise(bool autoCreateWindow, const String& windowTitle = "OGRE Render Window");
        virtual RenderSystemCapabilities* createRenderSystemCapabilities() const;
        void initialiseFromRenderSystemCapabilities(RenderSystemCapabilities* caps, RenderTarget* primary);
        void reinitialise(void); // Used if settings changed mid-rendering
        void shutdown(void);

        void setAmbientLight(float r, float g, float b);
        void setShadingType(ShadeOptions so);
        void setLightingEnabled(bool enabled);
        
        RenderWindow* _createRenderWindow(const String &name, unsigned int width, unsigned int height, 
                                          bool fullScreen, const NameValuePairList *miscParams = 0);

        bool _createRenderWindows(const RenderWindowDescriptionList& renderWindowDescriptions, 
                                  RenderWindowList& createdWindows);

        DepthBuffer* _createDepthBufferFor( RenderTarget *renderTarget );

        void _getDepthStencilFormatFor( GLenum internalColourFormat, GLenum *depthFormat,
                                        GLenum *stencilFormat );
        
        virtual MultiRenderTarget * createMultiRenderTarget(const String & name); 
        
        void destroyRenderWindow(RenderWindow* pWin);
        String getErrorDescription(long errorNumber) const;

        VertexElementType getColourVertexElementType(void) const;
        void setNormaliseNormals(bool normalise);

        // -----------------------------
        // Low-level overridden members
        // -----------------------------
        void _useLights(const LightList& lights, unsigned short limit);
        bool areFixedFunctionLightsInViewSpace() const { return true; }
        void _setWorldMatrix(const Matrix4 &m);
        void _setViewMatrix(const Matrix4 &m);
        void _setProjectionMatrix(const Matrix4 &m);
        void _setSurfaceParams(const ColourValue &ambient,
            const ColourValue &diffuse, const ColourValue &specular,
            const ColourValue &emissive, Real shininess,
            TrackVertexColourType tracking);
        void _setPointParameters(Real size, bool attenuationEnabled, 
            Real constant, Real linear, Real quadratic, Real minSize, Real maxSize);
        void _setPointSpritesEnabled(bool enabled);
        void _setTexture(size_t unit, bool enabled, const TexturePtr &tex);
        void _setTextureCoordSet(size_t stage, size_t index);
        void _setTextureCoordCalculation(size_t stage, TexCoordCalcMethod m, 
            const Frustum* frustum = 0);
        void _setTextureBlendMode(size_t stage, const LayerBlendModeEx& bm);
        void _setTextureAddressingMode(size_t stage, const TextureUnitState::UVWAddressingMode& uvw);
        void _setTextureBorderColour(size_t stage, const ColourValue& colour);
        void _setTextureMipmapBias(size_t unit, float bias);
        void _setTextureMatrix(size_t stage, const Matrix4& xform);
        void _setSceneBlending(SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op );
        void _setSeparateSceneBlending(SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp );
        void _setSceneBlendingOperation(SceneBlendOperation op);
        void _setSeparateSceneBlendingOperation(SceneBlendOperation op, SceneBlendOperation alphaOp);
        void _setAlphaRejectSettings(CompareFunction func, unsigned char value, bool alphaToCoverage);
        void _setViewport(Viewport *vp);
        void _beginFrame(void);
        void _endFrame(void);
        void _setCullingMode(CullingMode mode);
        void _setDepthBufferParams(bool depthTest = true, bool depthWrite = true, CompareFunction depthFunction = CMPF_LESS_EQUAL);
        void _setDepthBufferCheckEnabled(bool enabled = true);
        void _setDepthBufferWriteEnabled(bool enabled = true);
        void _setDepthBufferFunction(CompareFunction func = CMPF_LESS_EQUAL);
        void _setDepthBias(float constantBias, float slopeScaleBias);
        void _setColourBufferWriteEnabled(bool red, bool green, bool blue, bool alpha);
        void _setFog(FogMode mode, const ColourValue& colour, Real density, Real start, Real end);
        void _convertProjectionMatrix(const Matrix4& matrix,
            Matrix4& dest, bool forGpuProgram = false);
        void _makeProjectionMatrix(const Radian& fovy, Real aspect, Real nearPlane, Real farPlane, 
            Matrix4& dest, bool forGpuProgram = false);
        void _makeProjectionMatrix(Real left, Real right, Real bottom, Real top, 
            Real nearPlane, Real farPlane, Matrix4& dest, bool forGpuProgram = false);
        void _makeOrthoMatrix(const Radian& fovy, Real aspect, Real nearPlane, Real farPlane, 
            Matrix4& dest, bool forGpuProgram = false);
        void _applyObliqueDepthProjection(Matrix4& matrix, const Plane& plane, 
            bool forGpuProgram);
        void setClipPlane (ushort index, Real A, Real B, Real C, Real D);
        void enableClipPlane (ushort index, bool enable);
        void _setPolygonMode(PolygonMode level);
        void setStencilCheckEnabled(bool enabled);
        void setStencilBufferParams(CompareFunction func = CMPF_ALWAYS_PASS, 
            uint32 refValue = 0, uint32 compareMask = 0xFFFFFFFF, uint32 writeMask = 0xFFFFFFFF,
            StencilOperation stencilFailOp = SOP_KEEP, 
            StencilOperation depthFailOp = SOP_KEEP,
            StencilOperation passOp = SOP_KEEP, 
            bool twoSidedOperation = false);
        void _setTextureUnitFiltering(size_t unit, FilterType ftype, FilterOptions filter);
        void _setTextureUnitCompareFunction(size_t unit, CompareFunction function);
        void _setTextureUnitCompareEnabled(size_t unit, bool compare);
        void _setTextureLayerAnisotropy(size_t unit, unsigned int maxAnisotropy);
        void setVertexDeclaration(VertexDeclaration* decl);
        void setVertexBufferBinding(VertexBufferBinding* binding);
        void _render(const RenderOperation& op);

        void bindGpuProgram(GpuProgram* prg);
        void unbindGpuProgram(GpuProgramType gptype);
        void bindGpuProgramParameters(GpuProgramType gptype, 
                                      GpuProgramParametersSharedPtr params, uint16 variabilityMask);
        void bindGpuProgramPassIterationParameters(GpuProgramType gptype);
        void setScissorTest(bool enabled, size_t left = 0, size_t top = 0, size_t right = 800, size_t bottom = 600) ;
        void clearFrameBuffer(unsigned int buffers, 
                              const ColourValue& colour = ColourValue::Black, 
                              Real depth = 1.0f, unsigned short stencil = 0);
        HardwareOcclusionQuery* createHardwareOcclusionQuery(void);
        Real getHorizontalTexelOffset(void);
        Real getVerticalTexelOffset(void);
        Real getMinimumDepthInputValue(void);
        Real getMaximumDepthInputValue(void);
        OGRE_MUTEX(mThreadInitMutex);
        void registerThread();
        void unregisterThread();
        void preExtraThreadsStarted();
        void postExtraThreadsStarted();
        GLSupport* getGLSupportRef() { return mGLSupport; }

        // ----------------------------------
        // GLRenderSystem specific members
        // ----------------------------------
        void _oneTimeContextInitialization();
        void _switchContext(GLContext *context);
        void _setRenderTarget(RenderTarget *target);
        void _unregisterContext(GLContext *context);
        GLContext* _getMainContext() {return mMainContext;} 

        unsigned int getDisplayMonitorCount() const;

        virtual bool hasAnisotropicMipMapFilter() const { return false; }
        
        virtual void beginProfileEvent( const String &eventName );

        virtual void endProfileEvent( void );

        virtual void markProfileEvent( const String &eventName );
    };
}
#endif