OgreD3D9RenderSystem.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 __D3D9RENDERSYSTEM_H__
#define __D3D9RENDERSYSTEM_H__

#include "OgreD3D9Prerequisites.h"
#include "OgreString.h"
#include "OgreStringConverter.h"
#include "OgreRenderSystem.h"
#include "OgreRenderSystemCapabilities.h"
#include "OgreD3D9Mappings.h"

namespace Ogre 
{
#define MAX_LIGHTS 8

    class D3D9DriverList;
    class D3D9Driver;
    class D3D9Device;
    class D3D9DeviceManager;
    class D3D9ResourceManager;

    class _OgreD3D9Export D3D9RenderSystem : public RenderSystem
    {
    public:
        enum MultiheadUseType
        {
            mutAuto,
            mutYes,
            mutNo
        };
        
    private:
        IDirect3D9*  mD3D;      
        // Stored options
        ConfigOptionMap mOptions;
        size_t mFSAASamples;
        String mFSAAHint;

        HINSTANCE mhInstance;

        D3D9DriverList* mDriverList;
        D3D9Driver* mActiveD3DDriver;
        bool mUseNVPerfHUD;
        bool mPerStageConstantSupport;
        static D3D9RenderSystem* msD3D9RenderSystem;
        bool mAllowDirectX9Ex;
        bool mIsDirectX9Ex;

        struct sD3DTextureStageDesc
        {
            D3D9Mappings::eD3DTexType texType;
            size_t coordIndex;
            TexCoordCalcMethod autoTexCoordType;
            const Frustum *frustum;
            IDirect3DBaseTexture9 *pTex;
            IDirect3DBaseTexture9 *pVertexTex;
        } mTexStageDesc[OGRE_MAX_TEXTURE_LAYERS];

        // Array of up to 8 lights, indexed as per API
        // Note that a null value indicates a free slot
        Light* mLights[MAX_LIGHTS];     
        D3D9DriverList* getDirect3DDrivers();
        void refreshD3DSettings();
        void refreshFSAAOptions();
        
        void setD3D9Light( size_t index, Light* light );
        
        // state management methods, very primitive !!!
        HRESULT __SetRenderState(D3DRENDERSTATETYPE state, DWORD value);
        HRESULT __SetSamplerState(DWORD sampler, D3DSAMPLERSTATETYPE type, DWORD value);
        HRESULT __SetTextureStageState(DWORD stage, D3DTEXTURESTAGESTATETYPE type, DWORD value);

        HRESULT __SetFloatRenderState(D3DRENDERSTATETYPE state, Real value)
        {
#if OGRE_DOUBLE_PRECISION == 1
            float temp = static_cast<float>(value);
            return __SetRenderState(state, *((LPDWORD)(&temp)));
#else
            return __SetRenderState(state, *((LPDWORD)(&value)));
#endif
        }

        DWORD _getCurrentAnisotropy(size_t unit);
        bool _checkMultiSampleQuality(D3DMULTISAMPLE_TYPE type, DWORD *outQuality, D3DFORMAT format, UINT adapterNum, D3DDEVTYPE deviceType, BOOL fullScreen);
        
        D3D9HardwareBufferManager* mHardwareBufferManager;
        D3D9GpuProgramManager* mGpuProgramManager;
        D3D9HLSLProgramFactory* mHLSLProgramFactory;
        D3D9ResourceManager* mResourceManager;
        D3D9DeviceManager* mDeviceManager;

        size_t mLastVertexSourceCount;


        virtual RenderSystemCapabilities* createRenderSystemCapabilities() const;
        RenderSystemCapabilities* updateRenderSystemCapabilities(D3D9RenderWindow* renderWindow);

        virtual void initialiseFromRenderSystemCapabilities(RenderSystemCapabilities* caps, RenderTarget* primary);


        void convertVertexShaderCaps(RenderSystemCapabilities* rsc) const;
        void convertPixelShaderCaps(RenderSystemCapabilities* rsc) const;
        bool checkVertexTextureFormats(D3D9RenderWindow* renderWindow) const;
        void detachRenderTargetImpl(const String& name);
        
        HashMap<IDirect3DDevice9*, unsigned short> mCurrentLights;
        Matrix4 mViewMatrix;

        D3DXMATRIX mDxViewMat, mDxProjMat, mDxWorldMat;
    
        typedef vector<D3D9RenderWindow*>::type D3D9RenderWindowList;
        // List of additional windows after the first (swap chains)
        D3D9RenderWindowList mRenderWindows;
        
        typedef HashMap<unsigned int, D3DFORMAT> DepthStencilHash;
        DepthStencilHash mDepthStencilHash;

        MultiheadUseType mMultiheadUse;

    protected:
        void setClipPlanesImpl(const PlaneList& clipPlanes);        
    public:
        // constructor
        D3D9RenderSystem( HINSTANCE hInstance );
        // destructor
        ~D3D9RenderSystem();

        virtual void initConfigOptions();

        // Overridden RenderSystem functions
        ConfigOptionMap& getConfigOptions();
        String validateConfigOptions();
        RenderWindow* _initialise( bool autoCreateWindow, const String& windowTitle = "OGRE Render Window"  );
        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 );

        DepthBuffer* _addManualDepthBuffer( IDirect3DDevice9* depthSurfaceDevice, IDirect3DSurface9 *surf );

        using RenderSystem::_cleanupDepthBuffers;
        void _cleanupDepthBuffers( IDirect3DDevice9 *creator );

        void _cleanupDepthBuffers( IDirect3DSurface9 *manualSurface );

        void _setRenderTarget(RenderTarget *target);
        
        virtual MultiRenderTarget * createMultiRenderTarget(const String & name);

        virtual RenderTarget * detachRenderTarget(const String &name);

        String getErrorDescription( long errorNumber ) const;
        const String& getName() const;
        // Low-level overridden members
        void setConfigOption( const String &name, const String &value );
        void reinitialise();
        void shutdown();
        void setAmbientLight( float r, float g, float b );
        void setShadingType( ShadeOptions so );
        void setLightingEnabled( bool enabled );
        void destroyRenderTarget(const String& name);
        VertexElementType getColourVertexElementType() const;
        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 setNormaliseNormals(bool normalise);

        // Low-level overridden members, mainly for internal use
        void _useLights(const LightList& lights, unsigned short limit);
        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 _setPointSpritesEnabled(bool enabled);
        void _setPointParameters(Real size, bool attenuationEnabled, 
            Real constant, Real linear, Real quadratic, Real minSize, Real maxSize);
        void _setTexture(size_t unit, bool enabled, const TexturePtr &texPtr);
        void _setVertexTexture(size_t unit, const TexturePtr& tex);
        void _disableTextureUnit(size_t texUnit);
        void _setTextureCoordSet( size_t unit, size_t index );
        void _setTextureCoordCalculation(size_t unit, TexCoordCalcMethod m, 
            const Frustum* frustum = 0);
        void _setTextureBlendMode( size_t unit, 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 unit, 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 _setAlphaRejectSettings( CompareFunction func, unsigned char value, bool alphaToCoverage );
        void _setViewport( Viewport *vp );      
        void _beginFrame();
        virtual RenderSystemContext* _pauseFrame(void);
        virtual void _resumeFrame(RenderSystemContext* context);
        void _endFrame();       
        void _setCullingMode( CullingMode mode );
        void _setDepthBufferParams( bool depthTest = true, bool depthWrite = true, CompareFunction depthFunction = CMPF_LESS_EQUAL );
        void _setDepthBufferCheckEnabled( bool enabled = true );
        void _setColourBufferWriteEnabled(bool red, bool green, bool blue, bool alpha);
        void _setDepthBufferWriteEnabled(bool enabled = true);
        void _setDepthBufferFunction( CompareFunction func = CMPF_LESS_EQUAL );
        void _setDepthBias(float constantBias, float slopeScaleBias);
        void _setFog( FogMode mode = FOG_NONE, const ColourValue& colour = ColourValue::White, Real expDensity = 1.0, Real linearStart = 0.0, Real linearEnd = 1.0 );
        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 _setPolygonMode(PolygonMode level);
        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 setVertexDeclaration(VertexDeclaration* decl, bool useGlobalInstancingVertexBufferIsAvailable);
        void setVertexBufferBinding(VertexBufferBinding* binding);
        void setVertexBufferBinding(VertexBufferBinding* binding, size_t numberOfInstances, bool useGlobalInstancingVertexBufferIsAvailable, bool indexesUsed);
        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);
        void setClipPlane (ushort index, Real A, Real B, Real C, Real D);
        void enableClipPlane (ushort index, bool enable);
        HardwareOcclusionQuery* createHardwareOcclusionQuery();
        Real getHorizontalTexelOffset();
        Real getVerticalTexelOffset();
        Real getMinimumDepthInputValue();
        Real getMaximumDepthInputValue();
        void registerThread();
        void unregisterThread();
        void preExtraThreadsStarted();
        void postExtraThreadsStarted();     
                
        /*
        Returns whether under the current render system buffers marked as TU_STATIC can be locked for update
        */
        virtual bool isStaticBufferLockable() const { return !mIsDirectX9Ex; }
        
        static bool isDirectX9Ex()  { return msD3D9RenderSystem->mIsDirectX9Ex; }
        
        static D3D9ResourceManager* getResourceManager();
        static D3D9DeviceManager* getDeviceManager();
        static IDirect3D9* getDirect3D9();
        static UINT getResourceCreationDeviceCount();
        static IDirect3DDevice9* getResourceCreationDevice(UINT index);
        static IDirect3DDevice9* getActiveD3D9Device();

        D3DFORMAT _getDepthStencilFormatFor(D3DFORMAT fmt);

        bool _checkTextureFilteringSupported(TextureType ttype, PixelFormat format, int usage);

        void determineFSAASettings(IDirect3DDevice9* d3d9Device, size_t fsaa, const String& fsaaHint, D3DFORMAT d3dPixelFormat, 
            bool fullScreen, D3DMULTISAMPLE_TYPE *outMultisampleType, DWORD *outMultisampleQuality);

        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 );
            
        void fireDeviceEvent( D3D9Device* device, const String & name );

        MultiheadUseType getMultiheadUse() const { return mMultiheadUse; }
    protected:  
        DWORD getSamplerId(size_t unit);

        void notifyOnDeviceLost(D3D9Device* device);

        void notifyOnDeviceReset(D3D9Device* device);

    private:
        friend class D3D9Device;
        friend class D3D9DeviceManager;     
    };
}
#endif