OgreD3D11HLSLProgram.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-2013 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 __D3D11HLSLProgram_H__
#define __D3D11HLSLProgram_H__

#include "OgreD3D11Prerequisites.h"
#include "OgreHighLevelGpuProgram.h"
#include "OgreD3D11VertexDeclaration.h"


namespace Ogre {
    typedef vector<byte>::type MicroCode;

    class D3D11HLSLProgram : public HighLevelGpuProgram
    {
    public:
        class CmdEntryPoint : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class CmdTarget : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class CmdPreprocessorDefines : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class CmdColumnMajorMatrices : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class CmdEnableBackwardsCompatibility : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };

    protected:

        static CmdEntryPoint msCmdEntryPoint;
        static CmdTarget msCmdTarget;
        static CmdPreprocessorDefines msCmdPreprocessorDefines;
        static CmdColumnMajorMatrices msCmdColumnMajorMatrices;
        static CmdEnableBackwardsCompatibility msCmdEnableBackwardsCompatibility;
        

        void createLowLevelImpl(void);
        void unloadHighLevelImpl(void);
        //void populateParameterNames(GpuProgramParametersSharedPtr params);

        // Recursive utility method for populateParameterNames
        void processParamElement(String prefix, LPCSTR pName, size_t paramIndex, ID3D11ShaderReflectionType* varRefType) const;

        void populateDef(D3D11_SHADER_TYPE_DESC& d3dDesc, GpuConstantDefinition& def) const;

        String mTarget;
        String mEntryPoint;
        String mPreprocessorDefines;
        bool mColumnMajorMatrices;
        bool mEnableBackwardsCompatibility;

        bool mErrorsInCompile;
        MicroCode mMicroCode;
        ID3D11Buffer* mConstantBuffer;
        
        D3D11Device & mDevice;

        ID3D11ShaderReflectionConstantBuffer* mShaderReflectionConstantBuffer;
        D3D11_SHADER_BUFFER_DESC mConstantBufferDesc ;
        D3D11_SHADER_DESC mShaderDesc;

        D3D11VertexDeclaration mInputVertexDeclaration;

        ID3D11ShaderReflection* mIShaderReflection;

        ID3D11VertexShader* mVertexShader;
        ID3D11PixelShader* mPixelShader;
        ID3D11GeometryShader* mGeometryShader;

        struct ShaderVarWithPosInBuf
        {
            bool wasInit;
            bool isFloat;
            size_t physicalIndex;
            void * src;
            String name;

            D3D11_SHADER_VARIABLE_DESC var;
        };
        typedef vector<ShaderVarWithPosInBuf>::type ShaderVars;
        typedef ShaderVars::iterator ShaderVarsIter; 

        ShaderVars mShaderVars;

        void createConstantBuffer(const UINT ByteWidth);
        void analizeMicrocode();
        void getMicrocodeFromCache(void);
        void compileMicrocode(void);
    public:
        D3D11HLSLProgram(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual, ManualResourceLoader* loader, D3D11Device & device);
        ~D3D11HLSLProgram();

        void setEntryPoint(const String& entryPoint) { mEntryPoint = entryPoint; }
        const String& getEntryPoint(void) const { return mEntryPoint; }
        void setTarget(const String& target);
        const String& getTarget(void) const { return mTarget; }

        void setPreprocessorDefines(const String& defines) { mPreprocessorDefines = defines; }
        const String& getPreprocessorDefines(void) const { return mPreprocessorDefines; }
        void setColumnMajorMatrices(bool columnMajor) { mColumnMajorMatrices = columnMajor; }
        bool getColumnMajorMatrices(void) const { return mColumnMajorMatrices; }
        void setEnableBackwardsCompatibility(bool enableBackwardsCompatibility) { mEnableBackwardsCompatibility = enableBackwardsCompatibility; }
        bool getEnableBackwardsCompatibility(void) const { return mEnableBackwardsCompatibility; }
        bool isSupported(void) const;
        GpuProgramParametersSharedPtr createParameters(void);
        const String& getLanguage(void) const;

        virtual void buildConstantDefinitions() const;
        ID3D11VertexShader* getVertexShader(void) const;
        ID3D11PixelShader* getPixelShader(void) const; 
        ID3D11GeometryShader* getGeometryShader(void) const; 
        const MicroCode &  getMicroCode(void) const;  

        ID3D11Buffer* getConstantBuffer(GpuProgramParametersSharedPtr params, uint16 variabilityMask);

        void CreateVertexShader();
        void CreatePixelShader();
        void CreateGeometryShader();

        void loadFromSource(void);

        D3D11VertexDeclaration & getInputVertexDeclaration() { return mInputVertexDeclaration; }

        void reinterpretGSForStreamOut(void);
        bool mReinterpretingGS;

        unsigned int getNumInputs(void)const {return mShaderDesc.InputParameters;}
        unsigned int getNumOutputs(void)const {return mShaderDesc.OutputParameters;}

        D3D11_SIGNATURE_PARAMETER_DESC getInputParamDesc(unsigned int index) const;
        D3D11_SIGNATURE_PARAMETER_DESC getOutputParamDesc(unsigned int index) const;    
    };
}

#endif