OgreD3D9HLSLProgram.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 __D3D9HLSLProgram_H__
#define __D3D9HLSLProgram_H__

#include "OgreD3D9Prerequisites.h"
#include "OgreHighLevelGpuProgram.h"

namespace Ogre {
    class _OgreD3D9Export D3D9HLSLProgram : 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 CmdOptimisation : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };

        class CmdMicrocode : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };

        class CmdAssemblerCode : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };

        class CmdBackwardsCompatibility : 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 CmdOptimisation msCmdOptimisation;
        static CmdMicrocode msCmdMicrocode;
        static CmdAssemblerCode msCmdAssemblerCode;
        static CmdBackwardsCompatibility msCmdBackwardsCompatibility;

        void loadFromSource(void);
        void createLowLevelImpl(void);
        void unloadHighLevelImpl(void);
        void buildConstantDefinitions() const;

        // Recursive utility method for buildParamNameMap
        void processParamElement(LPD3DXCONSTANTTABLE pConstTable, D3DXHANDLE parent, String prefix, unsigned int index);
        void populateDef(D3DXCONSTANT_DESC& d3dDesc, GpuConstantDefinition& def) const;

        String mTarget;
        String mEntryPoint;
        String mPreprocessorDefines;
        bool mColumnMajorMatrices;
        bool mBackwardsCompatibility;

        LPD3DXBUFFER mMicroCode;

        GpuConstantDefinitionMap mParametersMap;
        size_t mParametersMapSizeAsBuffer;

    public:
        LPD3DXBUFFER getMicroCode();
    public:
        enum OptimisationLevel
        {
            OPT_DEFAULT,
            OPT_NONE,
            OPT_0, 
            OPT_1,
            OPT_2, 
            OPT_3
        };
    protected:
        OptimisationLevel mOptimisationLevel;

        void getMicrocodeFromCache(void);
        void compileMicrocode(void);
        void addMicrocodeToCache();
    public:
        D3D9HLSLProgram(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual, ManualResourceLoader* loader);
        ~D3D9HLSLProgram();

        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 setBackwardsCompatibility(bool compat) { mBackwardsCompatibility = compat; }
        bool getBackwardsCompatibility(void) const { return mBackwardsCompatibility; }
        void setOptimisationLevel(OptimisationLevel opt) { mOptimisationLevel = opt; }

        OptimisationLevel getOptimisationLevel() const { return mOptimisationLevel; }

        bool isSupported(void) const;
        GpuProgramParametersSharedPtr createParameters(void);
        const String& getLanguage(void) const;
    };
}

#endif