OgreD3D9Texture.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 __D3D9TEXTURE_H__
#define __D3D9TEXTURE_H__

#include "OgreD3D9Prerequisites.h"
#include "OgreTexture.h"
#include "OgreRenderTexture.h"
#include "OgreImage.h"
#include "OgreException.h"
#include "OgreD3D9HardwarePixelBuffer.h"
#include "OgreD3D9Resource.h"

namespace Ogre {
    class _OgreD3D9Export D3D9Texture : public Texture, public D3D9Resource
    {
    protected:  

        struct TextureResources
        {
            IDirect3DTexture9* pNormTex;    
            IDirect3DCubeTexture9* pCubeTex;    
            IDirect3DVolumeTexture9* pVolumeTex;
            IDirect3DBaseTexture9* pBaseTex;
            IDirect3DSurface9* pFSAASurface;            
        };
        
        typedef map<IDirect3DDevice9*, TextureResources*>::type DeviceToTextureResourcesMap;
        typedef DeviceToTextureResourcesMap::iterator           DeviceToTextureResourcesIterator;

        DeviceToTextureResourcesMap mMapDeviceToTextureResources;


        typedef vector<HardwarePixelBufferSharedPtr>::type SurfaceList;
        SurfaceList mSurfaceList;
        String                          mCubeFaceNames[6];  
        D3DPOOL                         mD3DPool;
        // Dynamic textures?
        bool                            mDynamicTextures;
        
        bool mHwGammaReadSupported;
        bool mHwGammaWriteSupported;
        D3DMULTISAMPLE_TYPE mFSAAType;
        DWORD mFSAAQuality;
        
        // needed to store data between prepareImpl and loadImpl
        typedef SharedPtr<vector<MemoryDataStreamPtr>::type > LoadedStreams;

        void _loadCubeTex(IDirect3DDevice9* d3d9Device, const LoadedStreams &loadedStreams);
        void _loadNormTex(IDirect3DDevice9* d3d9Device, const LoadedStreams &loadedStreams);
        void _loadVolumeTex(IDirect3DDevice9* d3d9Device, const LoadedStreams &loadedStreams);

        LoadedStreams _prepareCubeTex();
        LoadedStreams _prepareNormTex();
        LoadedStreams _prepareVolumeTex();

        void _createNormTex(IDirect3DDevice9* d3d9Device);
        void _createCubeTex(IDirect3DDevice9* d3d9Device);
        void _createVolumeTex(IDirect3DDevice9* d3d9Device);

        D3DFORMAT _chooseD3DFormat(IDirect3DDevice9* d3d9Device);

        size_t calculateSize(void) const;
        void createInternalResources(void);
        void freeInternalResources(void);
        void createInternalResourcesImpl(void);
        void createInternalResourcesImpl(IDirect3DDevice9* d3d9Device);
        void freeInternalResourcesImpl(void);
        void _setSrcAttributes(unsigned long width, unsigned long height, unsigned long depth, PixelFormat format);
        void _setFinalAttributes(IDirect3DDevice9* d3d9Device, TextureResources* textureResources, 
            unsigned long width, unsigned long height, unsigned long depth, PixelFormat format);
        D3DTEXTUREFILTERTYPE _getBestFilterMethod(IDirect3DDevice9* d3d9Device);
        bool _canUseDynamicTextures(IDirect3DDevice9* d3d9Device, DWORD srcUsage, D3DRESOURCETYPE srcType, D3DFORMAT srcFormat);
        bool _canAutoGenMipmaps(IDirect3DDevice9* d3d9Device, DWORD srcUsage, D3DRESOURCETYPE srcType, D3DFORMAT srcFormat);
        bool _canUseHardwareGammaCorrection(IDirect3DDevice9* d3d9Device, DWORD srcUsage, D3DRESOURCETYPE srcType, D3DFORMAT srcFormat, bool forwriting);
        
        String _getCubeFaceName(unsigned char face) const
        { assert(face < 6); return mCubeFaceNames[face]; }
        
        void _createSurfaceList(IDirect3DDevice9* d3d9Device, TextureResources* textureResources);

        void loadImpl();         
        void loadImpl(IDirect3DDevice9* d3d9Device);
        void prepareImpl();
        void unprepareImpl();
        void postLoadImpl();

        TextureResources* getTextureResources(IDirect3DDevice9* d3d9Device);

        TextureResources* allocateTextureResources(IDirect3DDevice9* d3d9Device);

        void createTextureResources(IDirect3DDevice9* d3d9Device);

        void freeTextureResources(IDirect3DDevice9* d3d9Device, TextureResources* textureResources);

        void determinePool();

        LoadedStreams mLoadedStreams;

        friend class D3D9HardwarePixelBuffer;
    public:
        D3D9Texture(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual, ManualResourceLoader* loader);
        ~D3D9Texture();

        void copyToTexture( TexturePtr& target );


        HardwarePixelBufferSharedPtr getBuffer(size_t face, size_t mipmap);
        
        IDirect3DBaseTexture9 *getTexture();        
        IDirect3DTexture9 *getNormTexture();
        IDirect3DCubeTexture9 *getCubeTexture();

        bool isHardwareGammaReadToBeUsed() const { return mHwGamma && mHwGammaReadSupported; }
                    
        bool useDefaultPool();

        // Called immediately after the Direct3D device has been created.
        virtual void notifyOnDeviceCreate(IDirect3DDevice9* d3d9Device);

        // Called before the Direct3D device is going to be destroyed.
        virtual void notifyOnDeviceDestroy(IDirect3DDevice9* d3d9Device);

        // Called immediately after the Direct3D device has entered a lost state.
        virtual void notifyOnDeviceLost(IDirect3DDevice9* d3d9Device);

        // Called immediately after the Direct3D device has been reset
        virtual void notifyOnDeviceReset(IDirect3DDevice9* d3d9Device); 
    };

    class _OgreD3D9Export D3D9RenderTexture : public RenderTexture
    {
    public:
        D3D9RenderTexture(const String &name, D3D9HardwarePixelBuffer *buffer, bool writeGamma, uint fsaa);
        ~D3D9RenderTexture() {}

        virtual void update(bool swap);

        virtual void getCustomAttribute( const String& name, void *pData );

        bool requiresTextureFlipping() const { return false; }

        void swapBuffers();

    };

}

#endif