TextureCreator.h

Go to the documentation of this file.

/*********************************************************\
 *  File: TextureCreator.h                               *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLRENDERER_TEXTURECREATOR_H__
#define __PLRENDERER_TEXTURECREATOR_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLCore/Base/Object.h>
#include "PLRenderer/PLRenderer.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLRenderer {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class Texture;
class TextureManager;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Abstract texture creator base class
*/
class TextureCreator : public PLCore::Object {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class TextureManager;


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLRENDERER_RTTI_EXPORT, TextureCreator, "PLRenderer", PLCore::Object, "Abstract texture creator base class")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Protected functions                                   ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    Default constructor
        */
        PLRENDERER_API TextureCreator();

        /**
        *  @brief
        *    Destructor
        */
        PLRENDERER_API virtual ~TextureCreator();

        /**
        *  @brief
        *    Creates the texture if a null pointer is given
        *
        *  @param[in] cTextureManager
        *    Texture manager to use
        *  @param[in] pTexture
        *    Pointer to the texture, if a null pointer a new texture is created
        *
        *  @return
        *   The created texture, a null pointer on error
        */
        PLRENDERER_API Texture *CreateTexture(TextureManager &cTextureManager, Texture *pTexture) const;


    //[-------------------------------------------------------]
    //[ Protected virtual TextureCreator functions            ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    Creates a texture
        *
        *  @param[in] cTextureManager
        *    Texture manager to use
        *  @param[in] pTexture
        *    Texture to manipulate, if a null pointer a new texture is created
        *
        *  @return
        *   The created/manipulated texture, a null pointer on error
        */
        virtual Texture *Create(TextureManager &cTextureManager, Texture *pTexture = nullptr) const = 0;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLRenderer


#endif // __PLRENDERER_TEXTURECREATOR_H__